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 _{API frameworks APP bundle Asset key Break max duration Break position Cachebusting Client ID CMS ID DAI_PRE Domain FW Ciad GDPR GDPR consent}	_{Google in-stream video nonce IFA IFA type Limit tracking Media mIme Non-personalized ads Omid partner Page URL Placement Type Regulations SCTE-35 Serverside Stream ID}	_{TFCD TFUA Timestamp Transaction ID US privacy User agent User IP address Video duration Video duration in seconds Video ID Video Title}
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.

API frameworks

Macro
`[APIFRAMEWORKS]`

APP bundle

Macro
`[APPBUNDLE]`

Asset key

Macro
`%%ASSET_KEY%%`

Break position

Macro
`[BREAKPOSITION]`

Break max duration

Macro
`%%BREAK_DURATION%%`
`[BREAKMAXDURATION]`

Cachebusting

Macro
`[CACHEBUSTING]`

Client ID

Macro
`[CLIENTUA]`

CMS ID

Macro
`%%CMS_ID%%`

DAI_PRE

Macro
`%%DAI_PRE%%`

Domain

Macro
`[DOMAIN]`

Macro
`%%FW_CAID%%`

GDPR

Macro
`%%GDPR%%`

GDPR consent

Macro
`[GDPRCONSENT]`

Google in-stream video nonce

Macro
`[GOOGLE_INSTREAM_VIDEO_NONCE]`

IFA

Macro
`[IFA]`

IFA type

Macro
`[IFATYPE]`

Limited tracking

Macro
`[LIMITEDTRACKING]`

Mediamime

Macro
`[MEDIAMIME]`

Non-personalized ads

Macro
`%%NPA%%`

OMID Partner

Macro
`[OMIDPARTNER]`

Page URL

Macro
`[PAGEURL]`

Placement Type

Macro
`[PLACEMENTTYPE]`

Regulations

Macro
`[REGULATIONS]`

Server side

Macro
`[SERVERSIDE]`

SCTE-35

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

Stream ID

Macro
`%%STREAM_ID%%`

TFCD

Macro
`%%TFCD%%`

TFUA

Macro
`%%TFUA%%`

Timestamp

Macro
`[TIMESTAMP]`

Transaction ID

Macro
`[TRANSACTIONID]`

US privacy

Macro
`%%US_PRIVACY%%`

User agent

Macro
`%%USER_AGENT%%`
`[DEVICEUA]`

User IP address

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

Video duration

Macro
`%%VIDEO_DURATION%%`

Video duration, in seconds

Macro
`%%VIDEO_DURATION_SEC%%`

Video ID

Macro
`%%VIDEO_ID%%`

Video title

Macro
`%%VIDEO_TITLE%%`

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]`

Errorcode

Macro
`[ERRORCODE]`

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

Macros in URL encoded strings

If you need to use a macro in a section of the ad tag that should be URL encoded, the macro itself should not be URL encoded to ensure that macro replacement works properly.

Example

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

Correct
http://some-adtag.com?encoded_param=[GOOGLE_INSTREAM_VIDEO_NONCE]%3D5

Incorrect
http://some-adtag.com?encoded_param=%5BGOOGLE_INSTREAM_VIDEO_NONCE%5D%3D5

Choose a section to give feedback on

Was this helpful?

How can we improve it?

Macros for Dynamic Ad Insertion

Jump to a specific macro in the list

Ad request macros

VAST tracking macros

Macros in URL encoded strings

Was this helpful?

Need more help?

Try these next steps:

What is the issue with this selection?

Share additional info or suggestions