CustomAudience
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[null,null,["Last updated 2025-08-07 UTC."],[],[],null,["# CustomAudience\n\nA 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\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `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}` |\n| ### `id` | `int64` Output only. ID of the custom audience. |\n| ### `status` | [CustomAudienceStatus](/google-ads/api/reference/rpc/v20/CustomAudienceStatusEnum.CustomAudienceStatus) Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed. |\n| ### `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. |\n| ### `type` | [CustomAudienceType](/google-ads/api/reference/rpc/v20/CustomAudienceTypeEnum.CustomAudienceType) Type of the custom audience. (\"INTEREST\" OR \"PURCHASE_INTENT\" is not allowed for newly created custom audience but kept for existing audiences) |\n| ### `description` | `string` Description of this custom audience. |\n| ### `members[]` | [CustomAudienceMember](/google-ads/api/reference/rpc/v20/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. |"]]