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

Creates or updates custom interests. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError CriterionError CustomInterestError HeaderError InternalError MutateError PolicyViolationError QuotaError RequestError StringLengthError

HTTP request

POST https://googleads.googleapis.com/v7/customers/{customerId}/customInterests:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose custom interests are being modified.

Request body

The request body contains data with the following structure:

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

object (CustomInterestOperation)

Required. The list of operations to perform on individual custom interests.

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 custom interest mutate.

JSON representation
{
  "results": [
    {
      object (MutateCustomInterestResult)
    }
  ]
}
Fields
results[]

object (MutateCustomInterestResult)

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.

CustomInterestOperation

A single operation (create, update) on a custom interest.

JSON representation
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "create": {
    object (CustomInterest)
  },
  "update": {
    object (CustomInterest)
  }
  // End of list of possible types for union field operation.
}
Fields
updateMask

string (FieldMask format)

FieldMask that determines which resource fields are modified in an update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Union field operation. The mutate operation. operation can be only one of the following:
create

object (CustomInterest)

Create operation: No resource name is expected for the new custom interest.

update

object (CustomInterest)

Update operation: The custom interest is expected to have a valid resource name.

MutateCustomInterestResult

The result for the custom interest mutate.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.