VAST Ads Embedded Parameters in Player V3 (Deprecated)

Pass VAST ad server or network tags to the Ooyala player.

Important: Ooyala Player V3 is deprecated and is scheduled to be disabled on 2018-01-31. After that date, Player V3 will no longer play your video or audio content. Customers still using Player V3 need to migrate to Player V4 (see Migrating from Player V3 and Player Migration FAQ).
VAST is an ad format which uses xml to describe Linear ads (video ads), non-linear ads (overlay ads) and companion ads. You can pass VAST ad-service-related tags to the Player with the embedded parameters.
  • To use Ooyala’s VAST ad set, log into the Support Center and submit a ticket requesting that this ad source be added to your account. Once it’s enabled, you’ll be able create ad sets for your player.
  • In order to use the VAST ad tag embedded parameter, an ad set must also be applied in Backlot and the ad set must contain a valid VAST ad tag.
At this time support for pre-, mid-, and post-roll ads varies by platform. To see what ad position are supported for each platform, see Client Side Ad Integration.

VAST Parameter

Use the vast parameter to pass VAST ad server or network tags to the Ooyala player. The parameter takes a key value pair representing the ad server or network URL. You can also use vast to change the ad URL. If the ad URL is updated with the vast parameter, the ad will play when it was set up to play in Backlot (pre-roll, mid-roll, or post-roll), but the ad content played will be overridden with the new ad URL. This parameter is for Flash and HTML5. The following example illustrates the use of the vast parameter.
var videoPlayer = OO.Player.create('playerwrapper', 'embed_code', {
  height: '100%',
  width: '100%',
  'vast': {
    tagUrl: 'some url',

vastAds Parameter

Note: This parameter is for HTML5 only.

Use the vastAds parameter to programmatically override any VAST ads or ad sets applied in Backlot. This feature allows you to add VAST ads to an asset or update the VAST ad content and position (pre-roll, post-roll, and mid-roll) from the player embedded parameters. If ads are set with vastAds, ads and ad sets associated with the player in Backlot will be completely ignored.

vastAds is a container, where you need to specify all the parameters that an ad uses:
  • type: The ad type. Set to "vast".
  • url: The link to the VAST ad content.
  • frequency: How often to call the VAST ad. Set to any positive integer.
  • first_shown: How many videos need to play before the VAST ad is shown. Set to any positive integer.
  • time: The time (in milliseconds) into the video when the VAST ad will play. Set to any positive integer.
    • To create a pre-roll ad, set time to 0.
    • To create a mid-roll ad, set time to any other number within the time of the asset.
    • To create a post-roll ad, set time to exactly 1000000000.
The following example demonstrates setting up a pre-roll ad and a mid-roll ad using vastAds.
var player = OO.Player.create('playerwrapper', embedCode, {
  'vastAds': [{
    type: "vast",
    url: ",728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]",
    frequency: 1,
    first_shown: 0,
    time: 0
    type: "vast",
    url: ",728x90&impl=s&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]",
    frequency: 1,
    first_shown: 0,
    time: 10000