Method: customers.billingSetups.mutate

お支払い情報の設定を作成するか、既存のお支払い情報の設定をキャンセルします。

スローされるエラーのリスト: AuthenticationError AuthorizationError BillingSetupError DateError FieldError HeaderError InternalError MutateError QuotaError RequestError

HTTP リクエスト

POST https://googleads.googleapis.com/v17/customers/{customerId}/billingSetups:mutate

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

必須。お支払い情報の設定変更オペレーションを適用する顧客の ID。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "operation": {
    object (BillingSetupOperation)
  }
}
フィールド
operation

object (BillingSetupOperation)

必須。実行するオペレーション。

レスポンスの本文

お支払い情報の設定オペレーションに対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "result": {
    object (MutateBillingSetupResult)
  }
}
フィールド
result

object (MutateBillingSetupResult)

変更リクエストの影響を受けるリソースを特定する結果。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/adwords

詳しくは、OAuth 2.0 の概要をご覧ください。

BillingSetupOperation

お支払い情報の設定に対する 1 回のオペレーションで、既存のお支払い情報設定のキャンセルについて記述します。

JSON 表現
{

  // Union field operation can be only one of the following:
  "create": {
    object (BillingSetup)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
フィールド
共用体フィールド operation。これらのオペレーションは、いずれか 1 つのみ設定できます。「更新」サポートされていません。operation は次のいずれかになります。
create

object (BillingSetup)

お支払い情報の設定を作成します。新しいお支払い情報の設定にはリソース名は必要ありません。

remove

string

削除するお支払い情報設定のリソース名。設定を削除できるのは、保留状態であるか、スケジュール設定された開始時間が将来の時間である場合です。リソース名は customers/{customerId}/billingSetups/{billing_id} のようになります。

MutateBillingSetupResult

1 つのお支払い情報の設定が変更された場合の結果です。

JSON 表現
{
  "resourceName": string
}
フィールド
resourceName

string

オペレーションが成功すると返されます。