MutateCampaignBudgets

  • The MutateCampaignBudgets RPC method is used to create, update, or remove campaign budgets.

  • This method returns operation statuses after execution.

  • The operation may throw a variety of errors, including authentication, authorization, and internal errors.

  • This method requires the https://www.googleapis.com/auth/adwords OAuth scope for authorization.

Creates, updates, or removes campaign budgets. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError CampaignBudgetError DatabaseError DistinctError FieldError FieldMaskError HeaderError InternalError MutateError NewResourceCreationError OperationAccessDeniedError QuotaError RangeError RequestError ResourceCountLimitExceededError StringLengthError

HTTP request

POST https://googleads.googleapis.com/v21/customers/{customerId}/campaignBudgets:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose campaign budgets are being modified.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "operations": [
    {
      object (CampaignBudgetOperation)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "responseContentType": enum (ResponseContentType)
}
Fields
operations[]

object (CampaignBudgetOperation)

Required. The list of operations to perform on individual campaign budgets.
partialFailure

boolean

If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
responseContentType

enum (ResponseContentType)

The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
validateOnly

boolean

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

Response body

Response message for campaign budget mutate.

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

JSON representation 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (MutateCampaignBudgetResult)
    }
  ]
}
Fields
partialFailureError

object (Status)

Errors that pertain to operation failures in the partial failure mode. Returned only when partialFailure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), we return an RPC level error.
results[]

object (MutateCampaignBudgetResult)

All results for the mutate.
Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.