Video-specific Parameters

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

Note: The following video-specific parameters are supported only in GET requests.

 

                                                                                                                                                    

ParameterRequiredDescription
adtypeMandatory
Type of ad. Possible values are:
  • 13 - For video ad request
  • 14 - For Audio Ad request though VAST
  • Other than 13 - For display ad request. 
Note: This parameter is mandatory for video and audio ad serving through VAST.
vwMandatory
Width (in pixels) of the video player. For example, 480
vhMandatory
Height (in pixels) of the video player. For example, 640 
vminlMandatoryMinimum duration (in seconds) of the video clip.
For example, 10
vmaxlMandatoryMaximum duration (in seconds) of the video clip.
For example, 20
vfmt
Mandatory
Acceptable video streaming formats. It is a combination of the following values separated by +:
  • 0 - All
  • 1 - video/mp4
  • 2 - application/x-shockwave-flash (VPAID - FLASH)
  • 3 - video/wmv
  • 4 - video/h264
  • 5 - video/webm
  • 6 - application/javascript (VPAID - JS)
  • 7 - video/ogg
  • 8 - video/flv
For example, 1+4
Note: Its default value is 0 (All).
vadFmtMandatoryVideo ad format (VAST version) supported as per the IAB standards in response. Possible options are:
  • 1 - VAST 1.0 (unsupported)
  • 2 - VAST 2.0
  • 3 - VAST 3.0
vapiMandatoryVideo ad API (VPAID) version supported as per the IAB standards in response. Possible options are:
  • 1 - VPAID 1.0
  • 2 - VPAID 2.0
vplayHighly recommendedList 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
For example, 1+3
vskipHighly recommended

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
vposHighly recommendedPosition 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.
vcomHighly recommendedIndicates whether a companion ad is requested or not. Possible options are:
  • 0 - False
  • 1 - True
Note: Its default value is 0.
vcomwHighly recommendedWidth (in pixels) of the companion ad.
Note: Its default value is 300.
vcomhHighly recommendedHeight (in pixels) of the companion ad.
Note: Its default value is 250.
vcontHighly recommendedContextual information about the Web page serving the ad. This partner-dependent data can be encoded and has to be passed to the demand side for Brand Safety or used internally for blocking lists.
vtypeHighly recommendedType of video. Possible values are:
  • 0 - Any type
  • 1 - Linear
  • 2 - Overlay
Note: Its default value is 0.
vskipdelay
Non-mandatory

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)
vnoskipadlen
Non-mandatory

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)
var
Non-mandatory
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).
vsm
Non-mandatory
Mode which the player will use to resize images and video to fit the display. Possible options are:
  • uniform - Fits the player's dimensions while maintaining the original aspect ratio (black bars)
  • exactfit - Fits the dimensions without maintaining the aspect ratio
  • fill - Stretches and zooms the video to fill the dimensions, while maintaining the aspect ratio
  • none - Displays the actual size of the video file (black borders)
Note: Obtaining this value from the player depends upon the player's API.
vcln
Non-mandatory
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.
kadwidth
Non-mandatory
Width (in pixels) of the video ad.
For example, 640
Note: If this parameter's value is not specified, then this value from adtype is passed.
kadheight
Non-mandatory
Height (in pixels) of the video ad.
For example, 480
Note: If this parameter's value is not specified, then this value from adtype is passed.
vminbtr
Non-mandatory
Minimum bitrate (in kbps) allowed for the video stream.
For example, 300
vmaxbtr
Non-mandatory
Maximum bitrate (in kbps) allowed for the video stream.
For example, 600
jsNon-mandatory

Indicates whether the video player only supports JavaScript. PubMatic's VPAID component returns both javascript and .swf VPAID creatives and lets the player select which to use. If the player cannot receive the .swf version, the js parameter can be used to only return the javascript component.  Possible values are:

  • 0 - Video player can recieve both javascript and flash VPAID. 

  • 1 - Video player must only receive javascript VPAID. 

Note: It's default value is 0.

devicetypeMandatory for CTV publishers

The devicetype parameter designated connected TV as the platform for impressions coming from connected TVs. Possible values are

  • 3 - Connected TV
vfullscreenexpandableNon-mandatory

Possible values:

0 = Not Expandable

1 = Is Expandable

2 = Unknown

Attachments

    Outcomes