Describes the required fields, syntax, and conventions used to name an outbound data file.
The style elements (monospaced text
, italics, brackets [ ]
( )
, etc.) in this document indicate code elements and options. See Style Conventions for Code and Text Elements for more information.
Outbound file names contain the following elements. All of the elements below are optional.
[SYNC_TYPE][_DID][_MASTER_DPID][_PID_ALIAS][_SYNC-MODE][_TIMESTAMP]SPLITNUM.sync[.gz]
The table defines the elements in an outbound data file name.
File Name Element | Description |
---|---|
|
Refers to the data transfer methods. Transfer methods include:
|
|
Destination ID. In Audience Manager , a destination is the instance of the integration where you can map your targetable segments. Customers can have multiple destinations, depending on the business requirement. |
|
Data-provider or data source ID. This ID identifies the type of User ID present in the file content. Most common User ID keys are:
See Global Data Sources for more details. |
|
The customer identifier from the 3rd party platform. |
|
Sync mode is a macro placeholder that adds a label to the file name based on synchronization type. Synchronization types include full and incremental. They'll appear in the file name as
|
|
A 13-digit UNIX timestamp in milliseconds, in the UTC time zone. |
|
An integer. Identifies part of a file that's been split into multiple parts to improve processing times. The number indicates which part of the original file the data belongs to. The integer must be at least 3 digits long, preceded by zeros, if the split size is lower than 100 parts. The original file will not have any split number. The first split file will end with 001. See examples below. |
|
GZIP compression. |
Files sent over to an Amazon S3 location, with PID_ALIAS="XYZCustomer"
and with Google Advertiser IDs in the file content.
E.g. incremental files:
S3_1234_20914_XYZCustomer_iter_1486140844000.sync.gz
S3_1234_20914_XYZCustomer_iter_1486140844000001.sync.gz
S3_1234_20914_XYZCustomer_iter_1486140844000002.sync.gz
E.g. full files:
S3_1234_20914_XYZCustomer_full_1486140844000.sync.gz
S3_1234_20914_XYZCustomer_full_1486140844000001.sync.gz
Files sent over to FTP location, without PID_ALIAS
and with Apple Advertiser IDs in the file content:
E.g. incremental files:
ftp_1234_20915_iter_1486140843000.sync.gz
ftp_1234_20915_iter_1486140843000001.sync.gz
E.g. full files:
ftp_1234_20915_full_1486140843000.sync.gz
ftp_1234_20915_full_1486140843000001.sync.gz
Scenario 3: Files sent over to FTP location, with PID_ALIAS="XYZCustomer"
and with 3rd party User ID in the file content ( Vendor ID=45454
):
E.g. incremental files:
ftp_1234_45454_XYZCustomer_iter_1486140843000.sync.gz
ftp_1234_45454_XYZCustomer_iter_1486140843000001.sync.gz
ftp_1234_45454_XYZCustomer_iter_1486140843000001.sync.gz
E.g. full files:
ftp_1234_45454_XYZCustomer_full_1486140843200.sync.gz
ftp_1234_45454_XYZCustomer_full_1486140843200001.sync.gz
Describes the required fields, syntax, and conventions used to organize information in an outbound data file. Format your data according to these specifications.
The style elements (monospaced text
, italics, brackets [ ]
( )
, etc.) in this document indicate code elements and options. See Style Conventions for Code and Text Elements for more information.
Fields in the data file appear in this order:
UUID<SPACE>SEGMENT_1,SEGMENT_2<SPACE>REMOVED_SEGMENT_,...
The table lists variables that define the contents of a data file.
Parameter | Description |
---|---|
|
A unique user ID assigned by Audience Manager . |
|
Separate the UUID and segment data with a space |
|
The segment ID that a visitor belongs to. Separate multiple segments with a comma. |
|
The segment ID from which the user was disqualified. Separate multiple segments with a comma. With a full synchronization, you can ignore the removed segments because the data file will contain the complete list of current segments for the user. Usually, you want to know about segments a user belongs to rather than those they've been removed from. See also Outbound Data File Name: Syntax and Examples . |
A properly formatted data file could look similar to the following sample. This file entry indicates a user qualifies for segments 24, 26, and 27. As required, a space separates the UUID
and segment IDs. Another space separates the sets of segment IDs. In this example, a user belongs to segments 24, 26, and 27. They’ve been removed from segments 25 and 28.
59767559181262060060278870901087098252 24,26,27 25,28