Method: customers.keywordPlans.mutate

Creates, updates, or removes keyword plans. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError KeywordPlanError MutateError NewResourceCreationError QuotaError RequestError ResourceCountLimitExceededError StringLengthError

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose keyword plans are being modified.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "operations": [
    {
      object (KeywordPlanOperation)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean
}
Fields
operations[]

object (KeywordPlanOperation)

Required. The list of operations to perform on individual keyword plans.
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.
validateOnly

boolean

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

Response body

Response message for a keyword plan mutate.

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

JSON representation 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (MutateKeywordPlansResult)
    }
  ]
}
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 (MutateKeywordPlansResult)

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.