BillingSetup

お支払い情報の設定。お支払いアカウントと広告主を関連付けるものです。お支払い情報の設定は、1 社の広告主様に固有のものです。

JSON 表現 
{
  "resourceName": string,
  "status": enum (BillingSetupStatus),
  "paymentsAccountInfo": {
    object (PaymentsAccountInfo)
  },
  "id": string,
  "paymentsAccount": string,

  // Union field start_time can be only one of the following:
  "startDateTime": string,
  "startTimeType": enum (TimeType)
  // End of list of possible types for union field start_time.

  // Union field end_time can be only one of the following:
  "endDateTime": string,
  "endTimeType": enum (TimeType)
  // End of list of possible types for union field end_time.
}
フィールド
resourceName

string

変更不可。お支払い情報の設定のリソース名。BillingSetup リソース名の形式は次のとおりです。

customers/{customerId}/billingSetups/{billing_setup_id}
status

enum (BillingSetupStatus)

出力のみ。お支払い情報の設定のステータス。
paymentsAccountInfo

object (PaymentsAccountInfo)

変更不可。このお支払い情報の設定に関連付けられているお支払いアカウントの情報。お支払い情報の設定時に、新しいお支払いアカウントの登録に使用されます（その後、paymentsAccount は設定しないでください）。お支払い情報の設定時に、このフィールドと paymentsAccount が入力されます。
id

string (int64 format)

出力のみ。お支払い情報の設定の ID。
paymentsAccount

string

変更不可。このお支払い情報の設定に関連付けられているお支払いアカウントのリソース名。Payments リソース名の形式は次のとおりです。

customers/{customerId}/paymentsAccounts/{paymentsAccountId}お支払い情報の設定時に、既存のお支払いアカウントでの登録に使用されます（この場合、paymentsAccountInfo は設定しないでください）。お支払い情報の設定を取得する際に、これと paymentsAccountInfo が入力されます。

共用体フィールド start_time。新しいお支払い情報の設定を作成すると、その設定が有効になります。[NOW] が唯一の開始時刻です。承認されているセットアップがない場合です。

既存のお支払い情報を取得するときにリクエストされた開始時間。リクエストされた開始時間より後に設定が承認された場合（ステータスを参照）は、承認時間です。start_time は次のいずれかになります。
startDateTime

string

変更不可。開始日の日時は、yyyy-MM-dd または yyyy-MM-dd HH:mm:ss 形式で指定します。指定できるのは将来の時刻のみです。
startTimeType

enum (TimeType)

変更不可。開始時刻を型で指定します。使えるのは NOW のみです。
共用体フィールド end_time。お支払い情報の設定が終了または終了した場合。これは、永久、または次回のお支払い情報の設定が予定されている開始時刻のいずれかです。end_time は次のいずれかになります。
endDateTime

string

出力のみ。終了日の時刻を yyyy-MM-dd または yyyy-MM-dd HH:mm:ss 形式で指定します。
endTimeType

enum (TimeType)

出力のみ。終了時刻を型で指定します。指定可能な値は FOREVER のみです。

BillingSetupStatus

BillingSetup のステータス。

列挙型
UNSPECIFIED 指定されていません。
UNKNOWN 戻り値にのみ使用されます。このバージョンで不明な値を表します。
PENDING お支払い情報の設定は承認待ちの状態です。
APPROVED_HELD お支払い情報の設定は承認されていますが、対応する最初の予算が承認されていません。これは、毎月の請求書発行に設定されているお支払い情報の設定に対してのみ発生する可能性があります。
APPROVED お支払い情報の設定は承認されています。
CANCELLED お支払い情報の設定は、承認前にユーザーによってキャンセルされました。

PaymentsAccountInfo

この請求のお支払いアカウント情報のコンテナ。

JSON 表現 
{
  "paymentsAccountId": string,
  "paymentsAccountName": string,
  "paymentsProfileId": string,
  "paymentsProfileName": string,
  "secondaryPaymentsProfileId": string
}
フィールド
paymentsAccountId

string

出力のみ。お支払い情報の設定に関連付けられたお支払いアカウントの識別に使用される 16 桁の ID。

ダッシュを含む文字列として渡す必要があります（例: 「1234-5678-9012-3456」）。
paymentsAccountName

string

変更不可。お支払い情報の設定に関連付けられているお支払いアカウントの名前。

これにより、毎月の請求書を調整するのに役立つお支払いアカウントにわかりやすい名前を指定できるようになります。

この名前は毎月の請求書に印刷されます。
paymentsProfileId

string

変更不可。お支払い情報の設定に関連付けられたお支払いプロファイルを識別するために使用される 12 桁の ID。

ダッシュを含む文字列として渡す必要があります（例: 1234-5678-9012）。
paymentsProfileName

string

出力のみ。お支払い情報の設定に関連付けられているお支払いプロファイルの名前。
secondaryPaymentsProfileId

string

出力のみ。予備のお支払いプロファイル ID は、シーケンシャル ライアビリティ契約を締結した場合など、一般的でない状況で表示されます。