AI-generated Key Takeaways
-
Audiences have several fields defining their properties, including ID, Name, and associated Floodlight activity.
-
Some fields are required for creating or editing an audience, while others are read-only or optional.
-
Audiences can have different types of rules and membership lifespans, with a default lifespan of 30 days.
-
The status of an audience can be Active or Archived, which affects whether new users are collected.
-
Audiences can be shared with other advertisers, and the number of shared advertisers may be truncated in the display.
Entity: Audiences
| Field | Required | Type | Description |
|---|---|---|---|
|
ID
|
Required only when editing an existing entity. | String | Numeric ID value of the audience. If left blank, a new audience will be created and a unique ID will be assigned. |
|
Name
|
Yes | String | The name of the audience. |
|
Advertiser ID
(Read-only)
|
No | Long | Numeric ID value of the Advertiser who owns the audience. |
|
Ownership
(Read-only)
|
No | Enum | The type of ownership of the audience with respect to the current advertiser. Possible values: 'Owned' | 'Shared'. |
|
Floodlight activity ID
|
Yes | String | Numeric ID value of the parent Floodlight activity. You can specify any alphanumeric identifier for an activity that you are creating at the same time as the audience. |
|
Floodlight activity name
(Read-only)
|
No | String | The name of the Floodlight activity associated with the audience. |
|
Audience type
|
No | Enum | The type of the rule of the audience. Possible values: 'All visitors' | 'Custom rule' | 'Other'. |
|
Membership lifespan
|
No | Long | The number of days a user remains a member of an audience before being removed due to inactivity. The default value is 30 days. |
|
Description
|
No | String | The description of the audience. |
|
Status
|
No | Enum | The status of the audience. Archiving (deactivating) a list prevents it from collecting additional users, but it won’t deactivate the ad associated with the list. Existing users will remain on the list until their memberships expire. Possible values: 'Active' | 'Archived'. |
|
Source
(Read-only)
|
No | Enum | The source of the audience. |
|
Number of members
(Read-only)
|
No | Long | The number of members on the audience. |
|
Shared advertiser IDs
|
No | List | The numaric ID values of the advertisers to whom the audience is shared. When updating the existing audience, use the advertiser IDs to add and the negative advertiser IDs to remove. The field will only display up to 1000 IDs in the downloaded sheet. A '"TRUNCATED"' prefix will be added to the field if the audience is shared to more than 1000 advertisers. |
