Player VAST Macros

VAST is a Video Ad Serving Template for structuring ad tags. It is a specification released by the Interactive Advertising Bureau (IAB) that sets a standard for communication requirements between ad servers and video players. Using an XML schema, VAST transfers important metadata about an ad from the ad server to a video player. VAST Ad Tag is a set of standardized code (based on VAST guidelines) that is declared and set on the Primis platform in order to communicate with your ad partner`s server. It tells the server what type of ad to display based on targeting criteria.

An Ad tag can contain macros, which are special parameters that can be added to an ad tag URL that will send dynamic data back to your ad partner`s server. A macro should be added after each key in the tag string, (i.e. ...&key01=${PRIMIS_MACRO_01}..) The key parameter is defined by each ad provider individually, below you can find an example with different keys from the different ad partners.

In this document, you can find the Primis VAST macros list with a description.

Each Primis Tag Consists of:
Protocol: must be set to HTTPS
Ad partner domain name, e.g. ://
Ad partner specific path
Key parameters and macros.
Save changes.
E.g. ...?key01=${PRIMIS_MACRO_01}¶meter02=${PRIMIS_MACRO_02} etc.

Tag Example: vast/2.00/194480?VPAID=js&content_page_url=${VIDEO_PLAYER_REFERER_URL_ENC}&


Please note that all values are encoded.




Page URL address


Cache buster


Player width


Player height


Content URL address


Video content Id


Video Content description


Content title


Video content duration


The user's origin user agent


User's IP address


User's device manufacturer


User's device model


Code name of user's device model


User's device operating system


Version of user's device operating system


Tag is attributed to a mobile application


Mobile application ID


Android AID / iOS IDFA


Mobile application name


Mobile application bundle Id


Mobile application store URL


Does the mobile application have a privacy policy? Possible values: 0, 1


Is the mobile application paid? Possible values: 0, 1


Mobile application developer's / publisher's name


Mobile application version


Geographic latitude


Geographic longitude


Returns player viewability state. Possible values: 0 (non-viewable), 1 (viewable), -1 (unknown)


GDPR consent string


CCPA consent string


Protocol. Can be HTTP or HTTPS. Tag example: ${PROTOCOL}://

Did this page help you?