Legacy: Integration Partners are encouraged to send segment files to Index via cloud storage, which provides a more robust and manageable integration than SFTP. If you use Amazon S3, see Sending segment files to Index using Amazon S3 buckets to get started. For other storage providers or infrastructure setups, contact your Index Representative to discuss the right approach for your environment.
If you are an existing SFTP partner, please reach out to your representative for migration guidance.
File formats
Index supports a dual file format for segment uploads. In this format, each segment is represented by a pair of files: a data file and a meta file. Index expects one segment per file pair. Both the data and meta files are required when a segment is first submitted. After that, any updates (such as appends or deletes) can be made using just the data file. For more information about how to update segment files, see .
The following table lists the supported file formats.
| File type | File name | File format | Contents |
|---|---|---|---|
Data |
| gzip | List of values separated by newline characters. The contents of the data file can be only one of the supported match keys listed below. |
Meta v1.2 |
| json | Meta file version, version, audience name, audience ID, source audience ID, advertiser account ID, Index account ID, export timestamp, action. |
Meta v1.1 |
| json | Deprecated |
Meta v1.0 |
| json | Deprecated |
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
The following table lists the meta file fields that must be included in the meta file.
| Field | Type | Supported meta file version | Description |
|---|---|---|---|
| String | 1.2 | Version of the meta file, where
|
| String | 1.2 | Name of the segment. This name is what appears in the Index UI |
| String | 1.2 | Provider-specific identifier for a given segment. Uploads with the same Uploads with unique |
| String | 1.2 | Addressability identifier for the advertiser or buyer name of the audience assigned by the segment provider. If neither apply, populated with the name of the data partner supplying the segment file. For example, LiveRamp or Lotame etc. Note: This field cannot be null or an empty string. |
| Timestamp in YYYY-MM-DD HH:MM:SS | 1.2 | Time, in UTC (Coordinated Universal Time), of when the segment was exported. |
| Integer | 1.2 | account ID |
Meta file version 1.2 example
{
"meta_version": "1.2",
"audienceName": "New Customers Signups",
"audienceID": "1a123a12-1a1b-12ab-12ad-ade76e154a6b",
"advertiserAccount_id": "Agency1",
"ownerAccount_id": 1234567,
"exportTimestamp": "2023-06-01 13:20:35"
}
What ad request signals can be included in the data file?
For a list of supported ad request signals, see List of supported ad request signals that can be included in the data file