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.adGroupAdLabels.mutate

Creates and removes ad group ad labels. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError DatabaseError HeaderError InternalError LabelError MutateError NewResourceCreationError QuotaError RequestError

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. ID of the customer whose ad group ad labels are being modified.

Request body

The request body contains data with the following structure:

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

object (AdGroupAdLabelOperation)

Required. The list of operations to perform on ad group ad labels.

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

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

Response message for an ad group ad labels mutate.

JSON representation
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (MutateAdGroupAdLabelResult)
    }
  ]
}
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 (e.g. auth errors), we return an RPC level error.

results[]

object (MutateAdGroupAdLabelResult)

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.