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.

REST Resource: customers.customInterests

Resource: CustomInterest

A custom interest. This is a list of users by interest.

JSON representation
{
  "resourceName": string,
  "status": enum (CustomInterestStatus),
  "type": enum (CustomInterestType),
  "members": [
    {
      object (CustomInterestMember)
    }
  ],
  "id": string,
  "name": string,
  "description": string
}
Fields
resourceName

string

Immutable. The resource name of the custom interest. Custom interest resource names have the form:

customers/{customerId}/customInterests/{custom_interest_id}

status

enum (CustomInterestStatus)

Status of this custom interest. Indicates whether the custom interest is enabled or removed.

type

enum (CustomInterestType)

Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT. By default the type is set to CUSTOM_AFFINITY.

members[]

object (CustomInterestMember)

List of custom interest members that this custom interest is composed of. Members can be added during CustomInterest creation. If members are presented in UPDATE operation, existing members will be overridden.

id

string (int64 format)

Output only. Id of the custom interest.

name

string

Name of the custom interest. It should be unique across the same custom affinity audience. This field is required for create operations.

description

string

Description of this custom interest audience.

CustomInterestStatus

Enum containing possible custom interest types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Enabled status - custom interest is enabled and can be targeted to.
REMOVED Removed status - custom interest is removed and cannot be used for targeting.

CustomInterestType

Enum containing possible custom interest types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CUSTOM_AFFINITY Allows brand advertisers to define custom affinity audience lists.
CUSTOM_INTENT Allows advertisers to define custom intent audience lists.

CustomInterestMember

A member of custom interest audience. A member can be a keyword or url. It is immutable, that is, it can only be created or removed but not changed.

JSON representation
{
  "memberType": enum (CustomInterestMemberType),
  "parameter": string
}
Fields
memberType

enum (CustomInterestMemberType)

The type of custom interest member, KEYWORD or URL.

parameter

string

Keyword text when memberType is KEYWORD or URL string when memberType is URL.

CustomInterestMemberType

Enum containing possible custom interest member types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
KEYWORD Custom interest member type KEYWORD.
URL Custom interest member type URL.

Methods

get

Returns the requested custom interest in full detail.

mutate

Creates or updates custom interests.