Macros for Dynamic Ad Insertion

See more information about macros, including how they work with Ad Manager, and a complete list of rendering, tracking, and other video macros.

Jump to a specific macro in the list

Ad request macros                 APP bundle Asset key Break max duration Cachebusting Client ID CMS ID GDPR	GDPR consent IFA IFA type Limit tracking Non-personalized ads SCTE-35 Stream ID	TFCD US privacy User agent User IP address Video duration
VAST tracking macros                Cachebusting Error code

Expand all  Collapse all

Ad request macros

The ad request macros shown here can only be used in an ad tag for Dynamic Ad Insertion (DAI) for a video on demand content source or live stream. They do not work in the context of VAST creatives.

Square bracket macros are generally required to pass Ad Manager macro validation for redirects.

APP bundle

 

Macro
[APPBUNDLE]

 

The an param.

Asset key

 

Macro
%%ASSET_KEY%%

 

Expands to the live stream event code.

Break max duration

 

Macro
%%BREAK_DURATION%%
[BREAKMAXDURATION]

 

Current Ad Break duration, in seconds.

[BREAKMAXDURATION] should only be used for Ad Manager redirects where %%BREAK_DURATION%% is not allowed.

Cachebusting

 

Macro
[CACHEBUSTING]

 

A random number.

Client ID

 

Macro
[CLIENTUA]

 

The ID of the player and VAST client used.

CMS ID

 

Macro
%%CMS_ID%%

 

Expands to the Ad Manager content source ID ("CMS ID") currently playing. This value does not appear in your MRSS feed, but is visible in the Ad Manager interface.

GDPR

 

Macro
%%GDPR%%

 

The gdpr param.

GDPR consent

 

Macro
[GDPRCONSENT]

 

The gdpr_consent param.

IFA

 

Macro
[IFA]

 

A resettable advertising ID that is taken from the rdid param. The advertising ID is only passed to primary ad requests if allowed by privacy flags (such as tfcd and is_lat).

IFA type

 

Macro
[IFATYPE]

 

DAI idtype param. The IFA type is only passed to primary ad requests if allowed by privacy flags (such as tfcd and is_lat).

Limited tracking

 

Macro
[LIMITEDTRACKING]

 

The ltd param.

Non-personalized ads

 

Macro
%%NPA%%

 

Expands to the value of 1 to tag the request as non-personalized.

This macro is used with ad requests subject to GDPR, and only in an ad tag for Dynamic Ad Insertion. See other macros for GDPR.

SCTE-35

 

Macro
%%SPLICE_INSERT_EVENT_ID%%
%%SPLICE_INSERT_UPID%%
%%TIME_SIGNAL_EVENT_ID%%
%%TIME_SIGNAL_UPID%%
%%TIME_SIGNAL_UPID_RAW%%
%%AFMM_CBC%%

 

Expands to SCTE-35 signals.

Stream ID

 

Macro
%%STREAM_ID%%

 

Expands to the session stream ID for the content source currently playing.

TFCD

 

Macro
%%TFCD%%

 

Expands to the value of the tfcd parameter.

US privacy

 

Macro
%%US_PRIVACY%%

 

Expands to the value of the us_privacy parameter.

User agent

 

Macro
%%USER_AGENT%%
[DEVICEUA]

 

User agent of the device that is rendering the ad to the end user.

In the case of VAST redirects, only the [DEVICEUA] macro will provide the expected functionality.

User IP address

 

Macro
%%USER_IP%%
[DEVICEIP]
[IP_ADDRESS]

 

Expands to the user IP address.

[IP_ADDRESS] should only be used for Ad Manager redirects where %%USER_IP%% is not allowed.

Video duration, in seconds

 

Macro
%%VIDEO_DURATION_SEC%%

 

Expands to the duration of the video in seconds.

VAST tracking macros

Both the [CACHEBUSTING] and [ERRORCODE] macros adhere to the VAST 4.0 spec (see section "2.3.7 Macros").

Cachebusting

 

Macro
[CACHEBUSTING]

 

Expands to an 8-digit random number.

Errorcode

 

Macro
[ERRORCODE]

 

Expands to the VAST error code.

For any issues related to DAI troubleshooting or outages, contact publisher support.