Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.accountBudgetProposals.mutate

Creates, updates, or removes account budget proposals. Operation statuses are returned.

List of thrown errors: AccountBudgetProposalError AuthenticationError AuthorizationError DatabaseError DateError FieldError FieldMaskError HeaderError InternalError MutateError QuotaError RequestError StringLengthError

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operation": {
    object (AccountBudgetProposalOperation)
  },
  "validateOnly": boolean
}
Fields
operation

object (AccountBudgetProposalOperation)

Required. The operation to perform on an individual account-level budget proposal.

validateOnly

boolean

If true, the request is validated but not executed. Only errors are returned, not results.

Response body

If successful, the response body contains data with the following structure:

Response message for account-level budget mutate operations.

JSON representation
{
  "result": {
    object (MutateAccountBudgetProposalResult)
  }
}
Fields
result

object (MutateAccountBudgetProposalResult)

The result of the mutate.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

AccountBudgetProposalOperation

A single operation to propose the creation of a new account-level budget or edit/end/remove an existing one.

JSON representation
{
  "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.
}
Fields
updateMask

string (FieldMask format)

FieldMask that determines which budget fields are modified. While budgets may be modified, proposals that propose such modifications are final. Therefore, update operations are not supported for proposals.

Proposals that modify budgets have the 'update' proposal type. Specifying a mask for any other proposal type is considered an error.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Union field operation. The mutate operation. operation can be only one of the following:
create

object (AccountBudgetProposal)

Create operation: A new proposal to create a new budget, edit an existing budget, end an actively running budget, or remove an approved budget scheduled to start in the future. No resource name is expected for the new proposal.

remove

string

Remove operation: A resource name for the removed proposal is expected, in this format:

customers/{customerId}/accountBudgetProposals/{account_budget_proposal_id} A request may be cancelled iff it is pending.

MutateAccountBudgetProposalResult

The result for the account budget proposal mutate.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.