CustomAudience

  • A custom audience is a list of users categorized by interest.

  • The unique key for a custom audience is its name, and duplicate names will result in a CustomAudienceError.NAME_ALREADY_USED.

  • Key fields of a custom audience include resource_name, id, status, name, type, description, and members.

  • The name field is required for creating a custom audience and must be unique per customer.

  • Custom audience members can be added during creation or overridden during an update operation.

A custom audience. This is a list of users by interest. The unique key of a custom audience consists of the following fields: name. Violating the unique key constraint produces error: CustomAudienceError.NAME_ALREADY_USED

Fields

resource_name

string

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

customers/{customer_id}/customAudiences/{custom_audience_id}

id

int64

Output only. ID of the custom audience.

status

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

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[]

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.