Ad Tag Targeting Macros

To access these features, Upgrade Now

Many VAST servers use "tag variables" to optimize fill and provide more information on how ads are being viewed. JW Player supports a number of variables that can be added to your VAST tag URL. Once an ad call is made by JW Player, the variables will be replaced accordingly.
 

Supported Ad Tag Variables in VAST

__companion-div__
The ID of the companion div, for example to allow VPAID ads to talk to companions.
__domain__
The domain name the player is embedded on.
__player-height__
The height of the video player on the page in pixels.
__player-width__
The width of the video player on the page in pixels.
__random-number__
Typically used as a cache-buster, to ensure there is no local caching of the VAST response.
__page-url__
The URL of the current page (the one the video is embedded in).
__timestamp__
The current time of the user's computer, as a UNIX timestamp.
__referrer__
The URL of the page that brought the viewer to the current player.
 

Playlist Item Properties

Playlist item properties allow publishers to send any metadata from the JW Player Playlist to an ad server. Assuming that you had something entered in your playlist XML like:

<jwplayer:artist>Leonardo</jwplayer:artist>

You would then be able to use the __item-artist__ variable in your ad tag. When making a call to an ad server, we will automatically fill this in as Leonardo. This is helpful to target ads to metadata keywords or to target different ads to each item in a playlist. Here are a few more example properties:

  • __item-title__: the title of the currently playing video.1
  • __item-description__: the short description of the currently playing video.1
  • __item-mediaid__: the custom media id of the currently playing video.1
  • __item-file__: the file URL of the currently playing video.
  • __item-duration__: the duration in seconds of the currently playing video. (Only works with midroll and postroll ads)

1Must be specified inside of the playlist.

Example

Here is an example VAST tag with the __random-number__ variable being used. Please note that this is how a tag should appear when setting it within the player embed:

//adserver.com/vastResponse.xml?cb=__random-number__

Once the ad tag is called from the JW Player, we will see which variables are being used, and populate these variables appropriately. In this instance, the above tag will make a call to the ad server as:

//adserver.com/vastResponse.xml?cb=98475983745983752

Note: Ad tag variables are replaced with an empty string if they cannot be filled.

See Basic Preroll Ads to learn how to setup ad tags in JW Player.

Google IMA

For IMA, all tag variables produced by the DFP server are supported. See the IMA SDK Documentation for more info.

Did you find this article helpful?

Please log in to rate this article.