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

Resource: CustomAudience

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

JSON representation
{
  "resourceName": string,
  "id": string,
  "status": enum (CustomAudienceStatus),
  "name": string,
  "type": enum (CustomAudienceType),
  "description": string,
  "members": [
    {
      object (CustomAudienceMember)
    }
  ]
}
Fields
resourceName

string

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

customers/{customerId}/customAudiences/{custom_audience_id}

id

string (int64 format)

Output only. ID of the custom audience.

status

enum (CustomAudienceStatus)

Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed.

name

string

Name of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations.

type

enum (CustomAudienceType)

Type of the custom audience. ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom audience but kept for existing audiences)

description

string

Description of this custom audience.

members[]

object (CustomAudienceMember)

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

CustomAudienceStatus

Enum containing possible custom audience statuses.

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

CustomAudienceType

Enum containing possible custom audience types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AUTO Google Ads will auto-select the best interpretation at serving time.
INTEREST Matches users by their interests.
PURCHASE_INTENT Matches users by topics they are researching or products they are considering for purchase.
SEARCH Matches users by what they searched on Google googleAds.search.

CustomAudienceMember

A member of custom audience. A member can be a KEYWORD, URL, PLACE_CATEGORY or APP. It can only be created or removed but not changed.

JSON representation
{
  "memberType": enum (CustomAudienceMemberType),

  // Union field value can be only one of the following:
  "keyword": string,
  "url": string,
  "placeCategory": string,
  "app": string
  // End of list of possible types for union field value.
}
Fields
memberType

enum (CustomAudienceMemberType)

The type of custom audience member, KEYWORD, URL, PLACE_CATEGORY or APP.

Union field value. The CustomAudienceMember value. One field is populated depending on the member type. value can be only one of the following:
keyword

string

A keyword or keyword phrase — at most 10 words and 80 characters. Languages with double-width characters such as Chinese, Japanese, or Korean, are allowed 40 characters, which describes the user's interests or actions.

url

string

An HTTP URL, protocol-included — at most 2048 characters, which includes contents users have interests in.

placeCategory

string (int64 format)

A place type described by a place category users visit.

app

string

A package name of Android apps which users installed such as com.google.example.

CustomAudienceMemberType

Enum containing possible custom audience member types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
KEYWORD Users whose interests or actions are described by a keyword.
URL Users who have interests related to the website's content.
PLACE_CATEGORY Users who visit place types described by a place category.
APP Users who have installed a mobile app.

Methods

get

Returns the requested custom audience in full detail.

mutate

Creates or updates custom audiences.