VAST and VPAID Ad Parameters

Use the following parameters to configure VAST, VPAID, and LiveRail VAST ads in Player V4 using the VAST and VPAID Ad Plugin. See Integrating VAST and VPAID Ads for details.
Note: These parameters are specific to VAST and VPAID ads. You can also set global parameters for VAST and VPAID ads. See Configuring Ad Parameters for details.
Name Description Type Required?
vast Parent parameter for the VAST module. Example:
"vast": {
   "all_ads":[
     {
       "position":0, 
       "position_type":"t", 
       "tag_url":"myUrl"
      }
    ]
  }
  Yes
vast.all_ads.position
  • If position_type is set to 't', position is the time at which the ad should play, in milliseconds. A value of 0 should be set for pre-roll ads. Any value less than the total time of the video is recognized as a mid-roll ad. Any value greater than the total time of the video is recognized as a post-roll ad.
  • If position_type is set to 'p', the value of position is the percentage of the total time of the video.
integer Yes for ad overrides without ad rules
vast.all_ads.position_type Specifies how to interpret the position value. Valid Values:
  • t - indicates that position is the time at which the ad should play, in milliseconds.
  • b - indicates that position is the percentage of the total time of the video.
string Yes
vast.all_ads.tag_url VAST ad tag. If you want to override the tag attached to the video through Backlot, supply any string value here.
Note: If specified, vast.tagUrl (deprecated) overrides this setting.
string Yes
vast.tagUrl (deprecated) A key/value pair representing the ad server or network URL. This correlates with the Ad Tag field in the VAST or VPAID ad set.
Note: Use vast.all_ads.tag_url instead of this deprecated setting. This deprecated setting overrides vast.all_ads.tag_url but does not allow you to control ad placement.
string Yes if you are specifying the parameter all_ads
vast.vpaidTimeout VPAID timeout setting. Used to configure how long to wait for a VPAID ad to play through. Allows you to exit the ad and resume the original content if ad playback is delayed past the timeout for any reason. Includes the following parameters:
  • iframe - time (in seconds) to wait for the VPAID iFrame to be loaded (default is 5 seconds)
  • loaded - time (in seconds) to wait for notification that the ad has been loaded (default is 5 seconds)
  • started - time (in seconds) to wait for notification that the ad has started (default is 5 seconds)
  • stopped - time (in seconds) to wait for notification that the ad has stopped after receiving an ad end event(default is 5 seconds)
Upon timeout, the player stops playing the ad and returns to playing the original content.

Example (page-level override to six seconds):

"vast":{"vpaidTimeout" : {"iframe":6, "started":6, "loaded":6, "stopped":6}  }
string yes

Was this article helpful?