Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Minor copy edits and formatting.

...

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
Info

This parameter is mandatory for video and audio

ad

ads serving through VAST.


placementHighly Recommended

Placement type for the impression. Should be used Use to distinguish between in-stream and out-stream inventory.

Possible integer values:

  • 1 - In-Stream   (Played before, during or after the streaming video content that the consumer has requested: Pre-roll, Mid-roll, Post-roll).
  • 2 - In-Banner   (Exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on  the page for its delivery.)
  • 3 - In-Article    (Loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message.)
  • 4 - In-Feed       (Found in content, social, or product feeds.)
  • 5 - Interstitial/Slider/Floating     (Covers the entire or a portion of screen area, but is always on screen while displayed - i.e. cannot be scrolled out of view).
rewardOptionalOnly

The only supported integer value is: reward=1. This optional value causes the request to be treated as a rewarded video request.

Info
titleNotes:
  • Decoding = atoi()
  • Parameter will be consumed for all platforms.
  • Parameter will be ignored for non-video adtype requests.
  • Supported in both URL QueryString param and PostData param.
  • Translator will not discard/ignore video.skip and related signals for rewarded video requests. It will be ignored at AdServer.


vwMandatoryWidth (in pixels) of the video player. For ; for example, 480.
vhMandatoryHeight (in pixels) of the video player. For ; for example, 640  640
vminlMandatoryMinimum duration (in seconds) of the video clip.
For ; for example, 10.
vmaxlMandatoryMaximum duration (in seconds) of the video clip.
For ; for example, 20.
vfmtMandatory

Acceptable video formats (i.e., mime types). It is a combination of the following values separated by +:

  • 0 - All
  • 1 - video/mp4
  • 3 - video/wmv
  • 4 - video/h264
  • 5 - video/webm
  • 6 - application/javascript (VPAID - JS)
  • 7 - video/ogg
  • 9 - video/3gpp 
  • 10- video/quicktime 
  • 11- video/mpeg 
  • 12- application/x-mpegURL

For example

,

: 1+5+6+7

Info
Note:

 Its default value is 0 (All).  If

vfmt

you include values 2 or 6

are included,

in vfmt, you must include the corresponding vapi parameter (VPAID version)

must be included

as well.


vapiMandatory
Video ad API (VPAID) version supported as per the IAB standards in response. Possible options are:
  • 2 - VPAID 2.0
  • 7 - OMID-1  (Open Measurement)
Info
Note:  

If you include a VPAID version

is included, a

, you must also include a corresponding VPAID mime type

must be included

in the vfmt parameter; for example,

such as

application/javascript.


Anchor
vadFmt
vadFmt
vadFmt

Mandatory
Video ad format (VAST version) supported in response. Possible options are:
  • 2 - VAST 2.0 (Wrapper + InLine)
  • 3 - VAST 3.0 (Wrapper + InLine)
  • 4 - VAST 2.0 InLine only
  • 5 - VAST 3.0 InLine only
Note: this
Info

This parameter maps to the oRTB parameter, video.protocols.


vplayHighly recommended
List of allowed playback methods. If blank, assume that all are allowed. Possible values are as follows:
  • 1 - Autoplay on Page Load, sound On
  • 2 - Autoplay on Page Load, sound Off
  • 3 - Click-to-play
  • 4 - Mouse-over
  • 5 - Autoplay on Entering Viewport, Sound On
  • 6 - Autoplay on Entering Viewport, Sound Off

For example, 11+3

Note

You can use the vplay parameter to set the start volume for PubMatic's VPAID player if no other methods are available. See, Understanding VPAID Sound Behavior.


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 recommended

Position of the video in the content. Possible options are:

  • 0 - Any position
  • 1 - Pre-roll
  • 2 - Mid-roll
  • 3 - Post-roll
Info
Note: Its

The default value for vpos is 0. This parameter maps to the oRTB parametervideo.startdelay.


vcomHighly recommended

Indicates whether a companion ad is requested or not. Possible options are:

  • 0 - False
  • 1 - True
Note: Its default value is

Default value: 0.

vcomwHighly recommendedWidth (in pixels) of the companion ad.
Note: Its default value is Default value: 300.
vcomhHighly recommendedHeight (in pixels) of the companion ad.
Note: Its default value is Default value: 250.
vcontHighly recommendedContextual information about the Web web page serving the ad. This partnerPartner-dependent data can data that may be encoded and has passes to be passed to the demand side for Brand Safety and/or used internally for blocking lists.
vtypeHighly recommended

Linearity type. Possible values are:

  • 0 - Any type
  • 1 - Linear
  • 2 - Overlay (Non-linear)
Note: Its default value is

Default value: 0.
vskipdelayNon-mandatory

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

Default value: 0 (indicates that users can skip the ad can be immediately skipped).
vnoskipadlenNon-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
Info

Publishers can use this parameter to provide the flexibility for advertisers to play a non-skippable video ad in skippable ad inventory

;

(a trade-off between video ad and publisher content).


varNon-mandatoryRatio 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).
vsmNon-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
Info

Use the player's API

.

(if available) to get this value.


vclnNon-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
Info

Use the player

depends upon the player

's API (if available) to get this value.


kadwidthNon-mandatory

Width (in pixels) of the video ad

.
For

; for example, 640


Note: If this parameter's value is not specified, then this value from adtype is passed

.

Info

If kadwidth = null, then the PubMatic passes the value of adtype instead.


kadheightNon-mandatory

Height (in pixels) of the video ad

.
For

; for example, 480


Note: If this parameter's value is not specified, then this value from adtype is passed

.

Info

If kadheight = null, then the PubMatic passes the value of adtype instead.


vminbtrNon-mandatoryMinimum bitrate (in kbps) allowed for the video stream.
For ; for example, 300.
vmaxbtrNon-mandatoryMaximum bitrate (in kbps) allowed for the video stream.
For ; for example, 600.
jsNon-mandatory

Indicates Determines whether the video player should only receive one PubMatic VPAID component - i.e., receives the PubMatic JavaScript VPAID component. PubMatic VPAID components are used to manage ads, report on granular error codes, and for manage third-party measurementperformance

Possible value includesvalues include: 

  • 1 - Video player must receives only receive the PubMatic JavaScript VPAID component

Note: By default, if this parameter is not present or is empty,
  • null - PubMatic VPAID component
will be
  • is returned in the response
.
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

Flags the target platform to receive impressions for Connected TV. Currently, the only value for this parameter is 3.

vfullscreenexpandableNon-mandatory

Identifies whether or not the ad is expandable to fullscreen, or unknow. Possible values:

  • 0 = Not Expandable
  • 1 = Is Expandable
  • 2 = Unknown

GDPR Mandatory Parameters

...