MutateAdGroupAds

  • The MutateAdGroupAds RPC method allows you to create, update, or remove ads, returning their operation statuses.

  • This method can throw a variety of errors related to ads, ad groups, assets, authentication, authorization, and more.

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

Creates, updates, or removes ads. Operation statuses are returned.

List of thrown errors: AdCustomizerError AdError AdGroupAdError AdSharingError AdxError AssetError AssetLinkError AuthenticationError AuthorizationError CollectionSizeError ContextError DatabaseError DateError DistinctError FeedAttributeReferenceError FieldError FieldMaskError FunctionError FunctionParsingError HeaderError IdError ImageError InternalError ListOperationError MediaBundleError MediaFileError MutateError NewResourceCreationError NotEmptyError NullError OperationAccessDeniedError OperatorError PolicyFindingError PolicyValidationParameterError PolicyViolationError QuotaError RangeError RequestError ResourceCountLimitExceededError SizeLimitError StringFormatError StringLengthError UrlFieldError

HTTP request

POST https://googleads.googleapis.com/v22/customers/{customerId}/adGroupAds:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose ads are being modified.

Request body

The request body contains data with the following structure:

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

object (AdGroupAdOperation)

Required. The list of operations to perform on individual ads.
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 an ad group ad mutate.

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

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

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.