Documentation Audience Manager Audience Manager User Guide

Outbound Template Macros

Last update: June 23, 2022

Topics:
Outbound Data Transfers

Lists the macros you can use to create outbound templates. These include file name macros, header macros, and content macros.

File Name and File Header Macros

The table lists and describes the macros you can use in the file name and to define header fields. For code samples, see Outbound Macro Examples.

Macro	Description
`ASCII_SOH`	A non-printing ASCII character. It indicates the start of a row or a section of content. It can also be used to separate data columns in a file.
`DPID`	Data provider ID.
`MASTER_DPID`	User ID Key Data Provider ID.
`NEW_LINE`	Allows the creation of multi-line headers for outbound orders.
`ORDER_ID`	Order / destination ID.
`PID_ALIAS`	An alias for an order / destination ID. The alias is set in the admin UI.
`SPLITNUM`	Indicates the splitting of outbound files into multiple parts. Replace the SPLITNUM section in the file name with the part number preceded by zeros, ensuring a minimum of three characters for the SPLITNUM section. The SPLITNUM macro does not need to be surrounded by <> characters. Example: `<SYNC_TYPE>_<ORDER_ID>_<DPID>_<SYNC_MODE>_<TIMESTAMP>SPLITNUM.csv` s3_123456_9999_full_1566906141001.csv s3_123456_9999_full_1566906141002.csv s3_123456_9999_full_1566906141003.csv The last three digits (001,002,003) in the examples above are the SPLITNUM identifiers.
`SYNC_MODE`	Indicates synchronization type and includes: `full` : Full synchronization. `iter` : Incremental synchronization.
`SYNC_TYPE`	Indicates data transfer method and includes: `ftp` `http` `s3`
`TAB`	Used as a separator, this macro inserts a tab between fields.
`TIMESTAMP`	A 10-digit, UTC, Unix timestamp. It can also be formatted as `<TIMESTAMP; format="YYYYMMDDhhmmss">` following Java date/timestamp formatting rules.

Content Macros

Macros used to format the contents of a data file. For code samples, see Outbound Macro Examples.

Macro	Description
`CLOSE_CURLY_BRACKET`	Inserts a close curly bracket `}` character.
`DP_UUID`	Data Provider Unique User Identifier . This is the ID for the data partner you send data to in an outbound file.
`DP_UUID_LIST`	Returns a list that contains multiple IDs for a data partner. This is useful if you have a large organization with multiple subdivisions or other organizational groups you're allowed to share data with. This macro returns a list of the IDs for those subordinate groups.
`DPID`	Data provider ID.
`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.
`if(SEGMENT_LIST && REMOVED_SEGMENT_LIST)endif`	This combination of macros creates a conditional statement that lists the segments users belong to and have been removed from. It returns an empty string if both conditions are not met or there's no data.
`MCID`	Adobe Experience Cloud ID.
`OPEN_CURLY_BRACKET`	Inserts an open curly bracket `{` character.
`OPT_OUT`	Deprecated. Do not use.
`ORDER_ID`	Order or destination ID.
`OUTPUT_ATTRIBUTE_TYPE`	Deprecated. Do not use.
`OUTPUT_ATTRIBUTE_VALUE`	Returns `1` as a static, hardcoded value.
`PID`	Partner ID.
`PIDALIAS`	An alias for an order / destination ID. The alias is set in the admin UI.
`REMOVED_SEGMENT_LIST`	Returns a list of segments, if any, that have been removed.
`SEGMENT_LIST`	Returns a list of segments in a list. Accepts the following optional arguments: `segmentId` : Segment ID. Deprecated. Use `sid` . `csegid` : Customer segment ID. Deprecated. Use `sid` . `sid` : Segment ID `type` : Returns `5` , a static, hardcoded value that identifies data as segment data. `alias` : Deprecated. Do not use. `lastUpdateTime` : A Unix time stamp that indicates the last time segment membership status was updated. `lastRealizationTime` : 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`	Returns `1` , as a static, hardcoded value.
`SYNC_MODE`	Indicates synchronization type and includes: `full` : Full synchronization. `iter` : Incremental synchronization.
`SYNC_TYPE`	Indicates data transfer method and includes: `ftp` `http` `s3`
`TAB`	Used as a separator, this macro inserts a tab between fields.
`TRAIT_LIST`	Returns a list of traits. Accepts the following optional arguments: `type` : Identifies trait types by numeric ID. 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` : The last time the trait was realized. Unix time stamp. Put these variables in curly brackets after the macro. For example, this code separates the results with a pipe "\|" character: `<TRAIT_LIST:{trait\|<trait.Id>,<trait.lastRealized>};separator=","`
`UUID`	Audience Manager user ID.

recommendation-more-help