Video ad API (VPAID) version supported as per the IAB standards in response. Possible options are:

1 - VPAID 1.0

2 - VPAID 2.0

playbackmethod

Yes

Yes

List of allowed playback methods. If blank, assume that all are allowed. Possible values are as follows:

1 - Auto-play sound on

2 - Auto-play sound off

3 - Click-to-play

4 - Mouse-over

Example:“playbackmethod”: [1,3]

wndh

No

No

Minimum height of any window that was traversed in attempting to reach the top window.

wndw

No

No

Minimum width of any window that was traversed in attempting to reach the top window.

adh

No

No

Height of the area that the ad will have to actually render.

adw

No

No

Width of the area that the ad will have to actually render.

h

Yes

No

Height of the video player measured from JavaScript.

w

Yes

No

Width of the video player measured from JavaScript.

wndurl

No

No

URL (document.location.href) of the highest window that can be accessed.

wndref

No

No

Referrer URL (document.referrer) of the highest window that can be accessed.

depth

No

No

Indicates the depth of the player in a set of windows/iframes from different domains, after traversing up any friendly iframes. Possible options are:

0 - Player is not in an iframe (window == top), or you are able to traverse up friendly/same-domain iframes to the top window.

1 - Player is in a single iframe, that is, the parent is the top window (window.parent == top).

2 - Player is in at least two iframes of different domains, that is, (window != top and window.parent != top). It is understood that it is not possible to know exactly the number of nested cross-domain iframes in which the current window is present. So this really indicates a depth of 2 or greater.

ar

No

No

Ratio of width to height of the display frame for the video, that is, the aspect ratio. Typically, this ratio is either 16:9 (widescreen) or 4:3 (full screen).

sm

No

No

Mode which the player will use to resize the images and video to fit the display. Possible options are:

3 - Fill (Stretches and zooms the video to fill the dimensions, while maintaining the aspect ratio)

4 - None (Displays the actual size of the video file (black borders))

Note: Obtaining this value from the player depends upon the player's API.If not specified, its default value is 0.

vcln

No

No

Language used for player control or user interaction. Values will be passed using the alpha-2/ISO 639-1 standard.Note: Obtaining this value from the player depends upon the player's API.

skip

Yes

No

Indicates whether the video ad can be skipped or not. Possible options are:

0 - Ads cannot be skipped

1 - Ads can be skipped

Default value: 0

skipdelay

No

No

Duration (in seconds) after which the user can skip the video ad, in case the ad can be skipped. After the skip-delay (also known as skip-offset) duration, a skip button will appear allowing the user to skip the ad. Possible value is any positive integer.

Default value: 0 (indicates that the ad can be immediately skipped)

noskipadlen

No

No

Length of the video ad for which the skip functionality will not be applicable. If the video ads can be skipped, ads shorter than this length are rendered without a skip button, that is, the skip option is available only on ads longer than this durationDefault value: 0Note: This parameter can be used by the publisher to give some flexibility to the advertisers to play a non-skippable video ad in skippable ad inventory; (trade-off between video ad and publisher content)

Video Parameters Response Format

Property

Mandatory

Multi Valued

Description

creativeURL

Yes*

No

URL of the VAST file.For example, http://site/path/file.xmlNote: Either the creativeURL or the creativeTAG parameter must be present.

creativeTAG

Yes*

No

Tag containing the VAST file from the DSP.For example, <VAST 2.0>....</VAST>Note: Either the creativeURL or the creativeTAG parameter must be present.