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

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

customers/{customerId}/paymentsAccounts/{paymentsAccountId}お支払い情報を設定する際に、既存のお支払いアカウントへの登録に使用します(paymentsAccountInfo は設定しないでください)。お支払い情報の設定を取得すると、このフィールドと paymentsAccountInfo に値が入力されます。

共用体フィールド start_time。新しいお支払い情報の設定を作成する場合は、この日付に設定が有効になります。お客様が承認済みの設定を何も行っていない場合、開始時間として指定できるのは [今すぐ] のみです。

既存のお支払い情報の設定を取得する場合、これはリクエストされた開始時間です。ただし、リクエストされた開始時間後に設定が承認された場合(ステータスを確認)、承認時間は後者になります。start_time は次のいずれかになります。

startDateTime

string

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

startTimeType

enum (TimeType)

変更不可。タイプとしての開始時間。使用できるのは NOW のみです。

共用体フィールド end_time。お支払い情報の設定が終了 / 終了したとき。値は「FOREVER」または次回のお支払い情報の設定の開始時間です。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。