Audience file format reference for Universal ID providers
If you are a supported Universal ID provider that facilitates audience transactions, you can send your audience files to Index Exchange (Index) using SFTP to be processed within 15-20 minutes by the Audience Manager system.
Note: This audience format is only available for select Universal ID providers. If you have any questions, contact your Index Representative.
File formats
Index supports a dual file format for an audience file. With a dual file format, Index expects to receive a single audience for each pair of files (multi-audience upload is not yet supported). Each audience is represented by two files: the data file and meta file. Both the data and meta files are required for every audience upload, including any changes to existing audiences. For more information on these file formats, refer to the table below.
File type | File name | File format | Contents |
---|---|---|---|
Data |
|
gzip | List of Universal IDs separated by newline characters. |
Meta v1.1 |
|
json |
Meta file version, audience scope, audience name, audience ID, source audience ID, advertiser account ID, file name, export timestamp. With the addition of audience scope in meta file v1.1, advertisers can run their audience across all eligible Index publishers with a single file upload. A meta file with |
Meta v1.0 | <audienceID>.json
|
json | Audience name, audience ID, source audience ID, advertiser account ID, Index publisher ID, file name, export timestamp. |
The data and meta files are linked by the audience ID and the file name, as shown in the following example:
Data file name: 1a956a17-7f7d-48fd-92ad-ade76e154a6b.gz
Meta file name: 1a956a17-7f7d-48fd-92ad-ade76e154a6b.json
List of meta file fields
Field | Supported meta file version | Description |
---|---|---|
meta_version
|
1.1 |
Version of the meta file, where
|
audience_scope
|
1.1 |
The scope of audience matching.
|
audienceName
|
All | Name of the audience or segment. This name is what appears in the Index UI. |
audienceID
|
All |
Provider-specific identifier for a given audience. Uploads with the same Uploads with unique |
advertiserAccount_id
|
All | Unique addressability identifier for the advertiser or buyer of the audience assigned by the Universal ID provider. |
publisher_id
|
All |
Index publisher identifier. A |
exportTimestamp
|
All | Time, in UTC (Coordinated Universal Time), of when the audience was exported. |
Meta file version 1.1 examples
The following meta file has a direct audience scope:
{
"meta_version": "1.1",
"audience_scope": "DIRECT",
"audienceName": "New Customers Signups",
"audienceID": "1a956a17-7f7d-48fd-92ad-ade76e154a6b",
"advertiserAccount_id": "Netflix",
"publisher_id": 183728,
"exportTimestamp": "2018-06-11 13:20:35"
}
The following meta file has a platform audience scope:
{
"meta_version": "1.1",
"audience_scope": "PLATFORM",
"audienceName": "New Customers Signups",
"audienceID": "1a956a17-7f7d-48fd-92ad-ade76e154a6b",
"advertiserAccount_id": "Netflix",
"exportTimestamp": "2018-06-11 13:20:35"
}
Meta file version 1.0 example
{
"audienceName": "New Customers Signups",
"audienceID": "1a956a17-7f7d-48fd-92ad-ade76e154a6b",
"advertiserAccount_id": "Netflix",
"publisher_id": 183728,
"exportTimestamp": "2018-06-11 13:20:35",
}