PRODUCT
Follow

The following table describes the custom variables that can be set for In-Stream ads.

List of Variables

Default Value

Description

Base_ShellFileName

VASTLoader.swf

Vast shell name, to be altered only for use of custom VAST shell (handles static SWF’s)

Base_VPAIDShellFileName

VPAIDBase.swf

VPAID shell name, to be altered only for use of any custom VPAID shell

Base_MMAdVisibilityExtension

FALSE

Appends AdVisibility extension element to the output VAST, used only with UIF at SmartClip

Base_IncludeImpressionPCP

TRUE

Appends PCP (Publisher custom Parameter) token as a part of the main impression, useful for custom publisher report as well as path through of publisher video content (show/series, episode)

Base_IncludeSessionId

TRUE

Appends sessioid=[%SessionId%] to impression tracker and all other interactions, for analytics to link interaction tracking to impression (important for verification)

Base_CacheBustingToken

[%random%]

Cache busting token that will be appended on all relevant trackers and asset calls

Base_EscapeSpecialChars

FALSE

Escape special characters (~ as well as ^) from all trackers in the VAST call, useful for some mobile and other connected devices

Base_ClickPrepend

Empty by default, if entered, prepends the click through URL with the entered token, %c is in practical use with SmartClip tags

Base_videoSync

FALSE

Some publishers do not allow for ad to be paused at end of duration, even when user interacts with it. In other words, once countdown is finished – no matter user interaction ad must unload. So this flag instructs shell not to display close button and just proceed to ad stop after countdown gets to zero.

The available values are:

  • False: Stop and display close button at end of ad countdown

  • True: Unload ad and proceed to publisher content at end of ad countdown

standardAdRemaining

FALSE

This flag instructs the shell whether it must notify player about remaining time change every tick we update countdown. Originally majority of publishers expected remaining time change event to be dispatched on every tick.

More modern publishers follow VPAID more strictly – they implement their internal mechanism of reading countdown updates. These later publishers players do not work correctly if we continue dispatching remaining time change on every tick.

The available values are:

  • False: Dispatch remaining time change event every tick

  • True: Do not dispatch this event every tick

Base_IncludeCreativeElementTrack

TRUE

When set to false avoids adding Creative element tracking for Creative View and Click.

  • Default is set to True.

Base_IncludeScalable

TRUE

If set to FALSE Scalable as well as MaintainAspectRatio attributes are not included in the media file element

3rdPartyStartURL

3rd Party Trackers for Video Start, and the next ones for video progress

3rdPartyFirstQURL

3rdPartyMidpointURL

3rdPartyThirdQURL

surveyURL

For VAST as well as VPAID, If used as standalone, and with any URL but very specific Nielsen Vizu URL, simply adds a Survey element with the URL to the VAST response.

ONLY for VPAID, When a specific Vizu URL is entered, should be used in conjunction with surveyImpression, it adds shell instructions so that Vizu Survey is called by the shell, and as a result user might get to see a Vizu Survey before/after ad shows.

  • Empty by default

surveyImpression

ONLY for VPAID, To be used only with Vizu surveyURL, adds a 3rd party call for Vizu to the VAST response, only with both surveyURL and surveyImpression, Vizu survey will function.

  • Empty by default

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments