Method: customers.adGroupAssetSets.mutate

Creates, or removes ad group asset sets. Operation statuses are returned.

HTTP request

POST https://googleads.googleapis.com/v17/customers/{customerId}/adGroupAssetSets:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose ad group asset sets are being modified.

Request body

The request body contains data with the following structure:

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

object (AdGroupAssetSetOperation)

Required. The list of operations to perform on individual ad group asset sets.

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.

responseContentType

enum (ResponseContentType)

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

Response body

Response message for an ad group asset set mutate.

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

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

object (MutateAdGroupAssetSetResult)

All results for the mutate.

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.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

AdGroupAssetSetOperation

A single operation (create, remove) on an ad group asset set.

JSON representation
{

  // Union field operation can be only one of the following:
  "create": {
    object (AdGroupAssetSet)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

object (AdGroupAssetSet)

Create operation: No resource name is expected for the new ad group asset set.

remove

string

Remove operation: A resource name for the removed ad group asset set is expected, in this format: customers/{customerId}/adGroupAssetSets/{adGroupId}~{asset_set_id}

MutateAdGroupAssetSetResult

The result for the ad group asset set mutate.

JSON representation
{
  "resourceName": string,
  "adGroupAssetSet": {
    object (AdGroupAssetSet)
  }
}
Fields
resourceName

string

Returned for successful operations.

adGroupAssetSet

object (AdGroupAssetSet)

The mutated ad group asset set with only mutable fields after mutate. The field will only be returned when responseContentType is set to "MUTABLE_RESOURCE".