AdConfig

Interface with ad launch parameters.

Properties

Properties

Name Type Mandatory Description
YAN integration parameters
partnerId number Partner ID that can be found in the Partner Interface.
category number Partner site section category.
impId number Ad unit ID (AdBreak). If omitted, a preroll unit is used.
partnerStatId string Sample ID. A number between 1 and 1000000000.
Adfox integration parameters
adFoxParameters AdFoxParameters Adfox integration parameters.
General parameters
videoContentUrl string URL of the video content where In-Stream ads are played (if the video player is embedded via an iframe). In other cases, the value may match targetRef.
videoContentDuration number or Infinity Video content duration in seconds. Infinity is required for live streams and broadcasts.
targetRef string URL of the page where In-Stream ads are played.
adBreakType AdBreakType Ad unit type. Specified if no additional loading of ad parameters from the YAN is required.
desiredBitrate number Recommended bitrate in kbps.
preferableAdSize PixelSize Preferred ad size.
trackingEvents TrackingEvents Object with VAST event names.
vast string XML-VAST document (string).
vastUrl string Link to be used to load VAST for serving ads.
vmapLoadTimeout milliseconds Maximum allowed VMAP loading time.