This section provides information about the video-specific parameters included in the RTB request and response.
Video Parameters Request Format
Type of video. Possible options are:
Position of the video in the content. Possible options are:
Note: Its default value is 0.
Minimum duration (in seconds) of the video clip.
Maximum duration (in seconds) of the video clip.
Minimum bitrate (in kbps) allowed for the video stream.
Maximum bitrate (in kbps) allowed for the video stream.
Acceptable video streaming formats as an array of integers.
Note: If unspecified, any of the above-mentioned formats are allowed.
Indicates whether a companion ad is requested or not. Possible options are:
Note: Its default value is 0.
Width (in pixels) of the companion ad.
Height (in pixels) of the companion ad.
Video ad format (VAST version) supported as per the IAB standards in response. Possible options are:
Note: Currently, PubMatic supports all VAST versions.
Video ad API (VPAID) version supported as per the IAB standards in response. Possible options are:
List of allowed playback methods. If blank, assume that all are allowed. Possible values are as follows:
|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.|
|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.|
Indicates the depth of the player in a set of windows/iframes from different domains, after traversing up any friendly iframes. Possible options are:
|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).|
Mode which the player will use to resize the images and video to fit the display. Possible options are:
Note: Obtaining this value from the player depends upon the player's API.
If not specified, its default value is 0.
Language used for player control or user interaction. Values will be passed using the alpha-2/ISO 639-1 standard.
Indicates whether the video ad can be skipped or not. Possible options are:
Default value: 0
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.
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 duration
Video Parameters Response Format
URL of the VAST file.
Tag containing the VAST file from the DSP.