File Format Macros file-format-macros
Lists the macros you can use to create FTP-based data files. Some macros can be used for all data file fields and rows. Other macros are specific to header and data rows only.
Common Macros common-macros
These macros can be used in any format field. For examples, see File Format Macro Examples.
ASCII_SOH
DPID
MASTER_DPID
ORDER_ID
PIDALIAS
An alias for an order / destination ID.
The value for this alias is set in the Foreign Account ID field for a destination (in the Basic Settings section).
SYNC_MODE
Indicates synchronization type. Accepts the following optional variables:
full
: Full synchronization.iter
: Incremental synchronization.
SYNC_TYPE
Indicates data transfer method. Accepts the following optional variables:
ftp
http
s3
TIMESTAMP
A 10-digit, UTC, Unix timestamp.
It can also be formatted as YYYYMMDDhhmmss
following Java date/timestamp formatting rules.
Header Field Macros header-field-macros
Macros used in header fields only. For examples, see File Format Macro Examples.
TAB
Data Row Macros data-row-macros
Macros used in data rows only. For examples, see File Format Macro Examples.
CLOSE_CURLY_BRACKET
}
character.COMMA
DP_UUID
Data Partner Unique User Identifier . Returns the ID you've assigned to a user/site visitor if that ID has already been synchronized with an Audience Manager device ID.
If the DPID is 0, this macro will return the Audience Manager ID instead of your ID for the user.
DP_UUID_LIST
DPUUIDS
The output of this macro maps the data provider ID (DPID) to related unique user IDs (DPUUID). This macro must have a formatting string to control its output. Sample output would look similar to the following:
"dpids=dpid1,dpid2,...dpid n|maxMappings= n|format=json"
The maxMappings
setting determines how many mappings you want the macro to return. When maxMappings=0
, this macro returns all the mappings for each specified DPID. Data is sorted by timestamp (most recent first) and returns results with the largest timestamp first.
endif
if
and the SEGMENT_LIST
and REMOVED_SEGMENT_LIST
macros.if(SEGMENT_LIST && REMOVED_SEGMENT_LIST)endif
MCID
OPEN_CURLY_BRACKET
{
character.OPT_OUT
OUTPUT_ATTRIBUTE_TYPE
OUTPUT_ATTRIBUTE_VALUE
1
as a static, hardcoded value.PID
REMOVED_SEGMENT_LIST
SEGMENT_LIST
Returns a list of segments in a list. Accepts the following optional variables:
segmentId
: Legacy ID. Deprecated. Usesid
(lower case only).csegid
: Legacy ID. Deprecated. Usesid
(lower case only).sid
: Segment ID.type
: Returns5
, a static, hardcoded value that identifies data as segment data.alias
: Mapping of the segment. Deprecated. Usesid
(lower case only).lastUpdateTime
: A Unix time stamp that indicates the last time a segment was realized.
Put these variables in curly brackets after the macro. For example, this code separates results with a pipe "|" character: <SEGMENT_LIST:{seg|<seg.type>,<seg.sid>}; separator="|">
SET_ATTRIBUTES
1
as a static, hardcoded value.TAB
TRAIT_LIST
Returns a list of traits. Accepts the following optional arguments:
-
type
: Trait types identified by a numeric ID. This variable returns:10
which identifies a DPM trait (offline, onboarded by an inbound job).3
which identifies a rules-based trait (realtime,; onboarded through the DCS ).
-
traitId
: Trait ID. -
lastRealized
: Last time the trait was realized. Unix timestamp.
Put these variables in curly brackets after the macro. For example, this code separates the results with a pipe "|" character: TRAIT_LIST{type|traitId};separator="|"
UUID