Sending segment files to Index using SFTP

If you're a supported data partner enriching transactions on our exchange, you can send your segment files to Index Exchange (Index) using SFTP for ingestion into our platform.

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 Manage values in a segment file.

The following table lists the supported file formats.

File type File name File format Contents

Data

<audienceID>.gz

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

<audienceID>.json

json

Meta file version, version, audience name, audience ID, source audience ID, advertiser account ID, Index account ID, export timestamp, action.

Meta v1.1

<audienceID>.json

json

Deprecated

Meta v1.0

<audienceID>.json

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

meta_version

String

1.2

Version of the meta file, where 1.2 is version 1.2.

audienceName

String

1.2

Name of the segment. This name is what appears in the Index UI The Index UI at app.indexexchange.com that allows you to manage integration settings, such as inventory, campaign, and deal settings..

audienceID

String

1.2

Provider-specific identifier for a given segment.

Uploads with the same audienceID are treated as updates to the segment.

Uploads with unique audienceIDs are treated as separate, new segments.

advertiserAccount_id

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.

exportTimestamp

Timestamp in YYYY-MM-DD HH:MM:SS

1.2

Time, in UTC (Coordinated Universal Time), of when the segment was exported.

ownerAccount_id

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",	
}

List of supported ad request signals that can be included in the data file

The following table lists the ad request signals that can be included in the data file to be used to activate segments.

Notes:

  • Segments are activated only when there’s an exact match with the contents of the data file.

  • Each match key you support will have a designated upload folder for your files. Your Index Representative will share the specific details with you.

Match key Considerations

A Matched Audiences Matched Audiences are IDs where data partners or publishers upload a list of IDs for a particular Universal ID provider and match a deal ID against that audience segment. compatible supported Universal ID Universal IDs are IDs that Index can receive from data partners and pass to DSPs in the bid request.

Only Universal IDs that are compatible with Matched Audiences can be used. Contact your Index Representative if you have any questions.

Example value:

  • 1A2B3C4D5E!6F$7G

App bundle ID

An open text value to support app ID formats for all app stores.

Example values:

  • com.myappname

  • 12345ABCDE

Content ID

This is an ID that uniquely identifies the content that an ad will serve with.

Example value:

  • 1A2B3C4D5E!6F$7G

IP address

IPv4 and IPv6 address can be combined in the same data file.

Example values:

  • 192.168.2.1

  • 2603:8000:6f00:562b:ac08:44bc:2cb7:5419

Postal/ZIP code

A combination of a postal/ZIP code and 3-letter country identifier, separated by a pipe character |, without spaces.

Example values:

  • A0B1C2|CAN

  • 12345|USA

URL

Make sure to exclude http://, www., and any query string parameters.

Example values:

  • news-site.com/sports/lacrosse/finals

  • recipes123ABC.org/pies

Data file example

192.168.2.1
192.168.2.5
1234:abcd:5678:efab:9012:cdef:3456:abcd
192.168.2.9
1a2b:3c4d:5e6f:7a8b:9c0d:1e2f:3a4b:5c6d