Method: customers.accountBudgetProposals.mutate

アカウントの予算の提案を作成、更新、または削除します。オペレーションのステータスが返されます。

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

HTTP リクエスト

POST https://googleads.googleapis.com/v16/customers/{customerId}/accountBudgetProposals:mutate

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

パスパラメータ

パラメータ
customerId

string

必須。顧客の ID。

リクエスト本文

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

JSON 表現 
{
  "operation": {
    object (AccountBudgetProposalOperation)
  },
  "validateOnly": boolean
}
フィールド
operation

object (AccountBudgetProposalOperation)

必須。個々のアカウント単位の予算提案に対して実行するオペレーション。
validateOnly

boolean

true の場合、リクエストは検証されますが、実行されません。エラーのみが返され、結果は返されません。

レスポンスの本文

アカウント単位の予算の変更オペレーションに対するレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

object (MutateAccountBudgetProposalResult)

変換の結果。

承認スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。

AccountBudgetProposalOperation

1 回の操作で、新しいアカウント単位の予算の作成、または既存の予算の編集、終了、削除を提案できます。

JSON 表現 
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "create": {
    object (AccountBudgetProposal)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
フィールド
updateMask

string (FieldMask format)

変更する予算フィールドを決定する FieldMask。予算は修正される場合がありますが、そのような修正を提案する提案は最終的なものです。そのため、プロポーザルでは更新オペレーションはサポートされていません。

予算を変更する提案のプロポーザル タイプは「更新」です。他のプロポーザル タイプでマスクを指定すると、エラーとみなされます。

これは、フィールドの完全修飾名のカンマ区切りリストです。（例: "user.displayName,photo"）。
共用体フィールド operation。変換オペレーション。operation は次のいずれかになります。
create

object (AccountBudgetProposal)

作成オペレーション: 新しい予算の作成、既存の予算の編集、運用中の予算の終了、または今後開始するようにスケジュールされた承認済みの予算の削除を行うための新しい提案です。新しい提案にリソース名は必要ありません。
remove

string

削除操作: 削除された提案のリソース名は次の形式で指定します。

customers/{customerId}/accountBudgetProposals/{account_budget_proposal_id}リクエストは、保留中の場合のみキャンセルされます。

MutateAccountBudgetProposalResult

アカウントの予算の提案の結果が変わります。

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

string

オペレーションが正常に完了した場合に返されます。