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.

bookmarkJump to a specific macro in the list

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.

Macro
[APIFRAMEWORKS]

The sdk_apis param.

Macro
[APPBUNDLE]

The an param.

Macro
%%ASSET_KEY%%

Expands to the live stream event code.

Macro
[BREAKPOSITION]

VAST 4.1 macro. Returns values:

1: for pre-roll
2: for mid-roll
3: for post-roll
4: for standalone
0: for none of the above/other

Macro
%%BREAK_DURATION%%
[BREAKMAXDURATION]

Current Ad Break duration, in seconds.

Macro
[CACHEBUSTING]

A random number.

Macro
[CLIENTUA]

The ID of the player and VAST client used.

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.

Macro
%%DAI_PRE%%

The default value is 0. Set to 1 when the ad request is made in the context of non-blocking or request smearing such as an "early break" or "prefetch"). This indicates to ad servers that more time may be available for processing the ad request.

Applicable to live/linear traffic only.

Macro
[DOMAIN]

VAST 4.1 macro. Domain of the stream creation referer URL.

Macro
%%FW_CAID%%

For VOD only - FreeWheel Custom Assed ID from the MRSS feed

Macro
%%GDPR%%

The gdpr param.

Macro
[GDPRCONSENT]

The gdpr_consent param.

Macro
[GOOGLE_INSTREAM_VIDEO_NONCE]

The givn param.

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).

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).

Macro
[LIMITADTRACKING]

The ltd param.

Macro
[MEDIAMIME]

VAST 4.1 macro: comma-delimited list of supported media MIME types.

Macro
%%NPA%%

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

Macro
[OMIDPARTNER]

VAST 4.1 macro: the omid_p param.

Macro
[PAGEURL]

VAST 4.1 macro: the stream creation referer URL.

Macro
[PLACEMENTTYPE]

VAST 4.1 macro: for DAI it's value will always be 1 (In-Stream).

See AdCOM Placement Subtypes Video.

Macro
[REGULATIONS]

VAST 4.1 macro: comma-delimited list of applicable regulations, based on params. The presence of tfcd=1 will add "coppa", gdpr=1 will add "gdpr".

Macro
[SERVERSIDE]

VAST 4.1 macro - always 1.

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.

Macro
%%STREAM_ID%%

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

Macro
%%TFCD%%

Expands to the value of the tfcd parameter.

Macro
%%TFUA%%

The tfua param.

Macro
[TIMESTAMP]

VAST 4.0 macro - current timestamp formatted according to ISO 8601.

Macro
[TRANSACTIONID]

VAST 4.1 macro - an identifier used to correlate a chain of ad requests from the origination end.

Macro
%%US_PRIVACY%%

Expands to the value of the us_privacy parameter.

Macro
%%USER_AGENT%%
[DEVICEUA]

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

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.

Macro
%%VIDEO_DURATION%%

VOD only - duration of the video in milliseconds, from MRSS feed.

Macro
%%VIDEO_DURATION_SEC%%

Expands to the duration of the video in seconds.

Macro
%%VIDEO_ID%%

VOD only - CMS Content ID from MRSS feed.

Macro
%%VIDEO_TITLE%%

VOD only - video title from MRSS feed.

Macro
[CACHEBUSTING]

Expands to an 8-digit random number.

Macro
[ERRORCODE]

Expands to the VAST error code.

Using the Google in-stream video nonce macro in a query parameter that needs to be URL encoded: