Method: customers.userListCustomerTypes.mutate

Attach or remove user list customer types. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError UserListCustomerTypeError HeaderError InternalError QuotaError RequestError

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose user list customer types are being modified.

Request body

The request body contains data with the following structure:

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

object (UserListCustomerTypeOperation)

Required. The list of operations to perform on the user list customer types.
partialFailure

boolean

Optional. 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

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

Response body

Response message for a user list customer type mutate.

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

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

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.

UserListCustomerTypeOperation

A single mutate operation on the user list customer type.

JSON representation 
{

  // Union field operation can be only one of the following:
  "create": {
    object (UserListCustomerType)
  },
  "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 (UserListCustomerType)

Attach a user list customer type to a user list. No resource name is expected for the new user list customer type.
remove

string

Remove an existing user list customer type. A resource name for the removed user list customer type is expected, in this format:

customers/{customerId}/userListCustomerTypes/{userListId}~{customerTypeCategory}

MutateUserListCustomerTypeResult

The result for the user list customer type mutate.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.