Video Object

Note

Fields marked with asterisk (*) are optional.

Parameter

Type

Description

mimes

array of strings

Content MIME types supported. Note: For Google bids all the specified MIME type media files are required in the VAST response, for example, [“video/mpeg”, “video/mp4”].

minduration

integer

Minimum video ad duration in seconds, for example, 2.

maxduration

integer

Maximum video ad duration in seconds, for example, 15.

linearity*

integer

Indicates if the impression must be linear or nonlinear, for example, 1. If none is specified, it is assumed all are allowed. 1: Linear 2: Non-Linear/Overlay.

placement*

integer

Placement type for the impression.

playbackend*

integer

The event that causes playback to end, for example 2.

protocols

array of integers

Accepted video bid response protocols as defined in OpenRTB, for example [2,5].

pos*

integer

Ad Position as defined in OpenRTB, for example 1.

w*

integer

Width of the player in pixels, for example, 600.

h*

integer

Height of the player in pixels, for example 400.

startdelay*

integer

Indicates the start delay in seconds. If the start delay value is greater than 0, then the position is mid-roll and the value indicates the start delay.

battr*

array of integers

Blocked creative attributes as defined in OpenRTB, for example, [6].

minbitrate*

integer

Minimum bit rate in Kbps, for example 680.

maxbitrate*

integer

Maximum bit rate in Kbps, for example 990.

api*

array of integers

List of supported API frameworks for this impression as defined in OpenRTB, for example, [1,2]. If an API is not explicitly listed, it is assumed not to be supported.

maxextended*

integer

Maximum extended video ad duration if extension is allowed.

boxingallowed*

integer

Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed: 0 = no 1 = yes.

playbackmethod*

array of integers

Allowed playback methods as defined in the OpenRTB, for example [1, 2]. If none are specified, it is assumed all are allowed.

delivery*

array of integers

Supported delivery methods (e.g., streaming, progressive) as defined in OpenRTB. If none specified, assume all are supported, for example, [1, 2].

sequence*

integer

If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives, for example, 2.

companionad*

array of objects

Array of Banner objects if companion ads are available. See the Banner Object section for more information.

companiontype*

array of integers

List of allowed companion ad types, for example [1, 2].

skip*

integer

Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes.

skipmin*

integer

Videos of a total duration greater than this value (seconds) can be skippable; only applicable if the ad is skippable.

skipafter*

integer

Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.

ext*

object

See the Video Ext Object section

Video Ext Object

Parameter

Type

Description

rewarded*

integer

Indicates whether the ad is being rendered as part of a rewarded / incentivised user experience, where: 0 = non-rewarded 1 = rewarded If omitted, non-rewarded can be assumed

Video Object Example

{
   "id":"1",
   "bidfloor":0.03,
   "video":{
      "w":640,
      "h":480,
      "pos":1,
      "startdelay":0,
      "minduration":5,
      "maxduration":30,
      "maxextended":30,
      "minbitrate":300,
      "maxbitrate":1500,
      "skip":1,
      "api":[
         1,
         2
      ],
      "protocols":[
         2,
         3
      ],
      "mimes":[
         "video/x-flv",
         "video/mp4",
         "application/x-shockwave-flash",
         "application/javascript"
      ],
      "linearity":1,
      "boxingallowed":1,
      "playbackmethod":[
         1,
         3
      ],
      "delivery":[
         2
      ],
      "btype": [
         4,
         21
      ],
      "battr":[
         13,
         14
      ],
      "companionad":[
         {
            "id":"1234567893-1",
            "w":300,
            "h":250,
            "pos":1,
            "battr":[
               13,
               14
            ],
            "expdir":[
               2,
               4
            ]
         },
         {
            "id":"1234567893-2",
            "w":728,
            "h":90,
            "pos":1,
            "battr":[
               13,
               14
            ]
         }
      ],
      "companiontype":[
         1,
         2
      ]
   }
}