custom_audience

  • A custom audience is a list of users defined by interest, with "name" serving as the unique key, and duplicate names resulting in an error.

  • Fields from the customer resource can be selected along with custom audience fields but will not segment metrics.

  • Custom audience fields include description, ID, members, name, resource_name, status, and type, with various data types and filter/select/sort capabilities.

  • The custom_audience.members field is a repeated message field containing the list of members, which can be overridden during an update operation.

  • Custom audiences have a status indicating if they are enabled or removed, and a type, though "INTEREST" or "PURCHASE_INTENT" are not allowed for new audiences.

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

Attributed resources
customer

Fields from the above resources may be selected along with this resource in your SELECT and WHERE clauses. These fields will not segment metrics in your SELECT clause.

custom_audience.description

Field descriptionDescription of this custom audience.
CategoryATTRIBUTE
Data TypeSTRING
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

custom_audience.id

Field descriptionOutput only. ID of the custom audience.
CategoryATTRIBUTE
Data TypeINT64
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

custom_audience.members

Field descriptionList 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.
CategoryATTRIBUTE
Data TypeMESSAGE
Type URLgoogle.ads.googleads.v22.resources.CustomAudienceMember
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

custom_audience.name

Field descriptionName of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations.
CategoryATTRIBUTE
Data TypeSTRING
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

custom_audience.resource_name

Field descriptionImmutable. The resource name of the custom audience. Custom audience resource names have the form: customers/{customer_id}/customAudiences/{custom_audience_id}
CategoryATTRIBUTE
Data TypeRESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

custom_audience.status

Field descriptionOutput only. Status of this custom audience. Indicates whether the custom audience is enabled or removed.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v22.enums.CustomAudienceStatusEnum.CustomAudienceStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

custom_audience.type

Field descriptionType of the custom audience. ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom audience but kept for existing audiences)
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v22.enums.CustomAudienceTypeEnum.CustomAudienceType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse