Video Parameters

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Jun 8, 2017
Version 2Show Document
  • View in full screen mode

This section provides information about the video-specific parameters included in the RTB request and response.

Example:


{
  ...
  "video”: {
    "type": 1,
    "pos": 2,
    "minLen": 20,
    "maxLen": 50,
    "minBitRate": 20,
    "maxBitRate": 50,
    "adFmt": 2,
    "streamFmt": [1,2,3],
    "api": 1,
    "playbackmethod": [1,3],
    "wndh": 600,
    "wndw": 840,
    "adh": 300,
    "adw": 420,
    "h": 300,
    "w": 420,
    "wndurl": "http://youtube.com",
    "wndref": "http://google.com",
    "depth": 1,
    "ar": "4:3",
    "sm": 1,
    "vcln": "en"
    "skip": 1,
    "skipdelay": 5,
    "noskipadlen": 15

  }
}

Video Parameters Request Format

                                                                                                                                                                                 

Property
Mandatory
Multi Valued
Description
type
Yes
No
Type of video. Possible options are:
  • 0 - Any type
  • 1 - Linear
  • 2 – Overlay
pos
Yes
No
Position of the video in the content. Possible options are:
  • 0 - Any position
  • 1 - Pre-roll
  • 2 - In-roll
  • 3 - Post-roll
Note: Its default value is 0.
minLen
Yes
No
Minimum duration (in seconds) of the video clip.
For example, 10
maxLen
Yes
No
Maximum duration (in seconds) of the video clip.
For example, 20
minBitRate
No
No
Minimum bitrate (in kbps) allowed for the video stream.
For example, 300
maxBitRate
No
No
Maximum bitrate (in kbps) allowed for the video stream.
For example, 600
streamFmt
YesYes
Acceptable video streaming formats as an array of integers.
For example:
“streamFmt”:  [ 1, 3, 4]
 
Possible stream format values are:
  • 1 - video/mp4
  • 2 - application/swf
  • 3 - video/wmv
  • 4 - video/h264
  • 5 - video/webm
  • 6 - application/javascript
  • 7 - video/ogg
Note: If unspecified, any of the above-mentioned formats are allowed.
comp
No
No
Indicates whether a companion ad is requested or not. Possible options are:
  • 0 - False
  • 1 - True
Note: Its default value is 0.
compW
No
No
Width (in pixels) of the companion ad.
Note: Its default value is 300.
compH
No
No
Height (in pixels) of the companion ad.
Note: Its default value is 250.
adFmt
Yes
No
Video ad format (VAST version) supported as per the IAB standards in response. Possible options are:
  • 1 - VAST 1.0 
  • 2 - VAST 2.0
  • 3 - VAST 3.0 
  • 4 - VAST 2.0 Inline only
  • 5 - VAST 3.0 Inline only
Note: Currently, PubMatic supports all VAST versions.
api
Yes
No
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]
wndhNoNoMinimum height of any window that was traversed in attempting to reach the top window.
wndwNoNoMinimum width of any window that was traversed in attempting to reach the top window.
adhNoNoHeight of the area that the ad will have to actually render.
adwNoNoWidth of the area that the ad will have to actually render.
hYesNoHeight of the video player measured from JavaScript.
wYesNoWidth of the video player measured from JavaScript.
wndurlNoNoURL (document.location.href) of the highest window that can be accessed.
wndrefNoNoReferrer 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:
  • 0 - Cannot be determined
  • 1 - Uniform (Fits the player's dimensions while maintaining the original aspect ratio (black bars))
  • 2 - Exact fit (Fits the dimensions without maintaining the aspect ratio)
  • 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 duration
Default value: 0
Note: 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.
Note: 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.

Attachments

    Outcomes