The request object can contain the following fields:
| Field | Modifier | Type | Description |
|---|---|---|---|
audience_name | Required | String | A unique name for the audience. -- If you submit a CREATE request with an existing audience_name, the server will return the existing audience (and a new audience will not be created).See: Create a First Party Audience |
ttl_in_hours | Optional Default = 8760 (1 year) | Integer | Period of time (in hours) for which a give user will belong to this audience. |
exclude_from_campaigns | Optional Default = false | Boolean | If set to true, this audience will be suppressed for ALL campaigns (new and existing). |
integration_source | Optional | String | This field is for 3rd-party platforms only. Advertisers managing their own audiences can ignore this field. -- Used for integration tracking and diagnostics. Pass the name of the integration partner - e.g. "Tealium".Use a naming convention of your preference. Pass the same value consistently throughout the lifecycle of the audience. |
If you leave out the
ttlparam, the default value is 8760 (1 year).
All field values are final - they cannot be changed once the audience has been created.
For use by 3rd-party platforms only. Specifies the name of the integration partner (e.g., a CDP, DMP) creating the audience. This value is used for integration tracking and diagnostics.
Direct advertisers managing their own audiences should not use this field6.
Example values: Tealium, Segment, LiveRamp
When used, please pass the same value consistently throughout the lifecycle of the audience7.