Video object

Last updated on September 27, 2018

BidRequest.imp.video

The Video object provides details about a video ad requestCommunication from a web browser or app to an ad server to display an ad..

Each Imp object can contain one Video object, which is required for video impressions. Alternatively, an Imp object can contain a Banner or a Native object.

See also: Video examples

Guidance on video creatives

Note:
Flash support deprecation: July 3, 2017.
Deprecation includes the VPAID 1.0 API Framework and the following MIME typesVideo creative formats supported by your video player. For example, video/mp4.: application/x-shockwave-flash and video/x-flv.

Video object

Field name

Data type

Description

Sent?

mimes

array (string)

An array of supported MIME types for content video. Below are just a few examples for app, though MIME types are also sent for web ads.

Android:

  • video/3gpp
  • video/mp4

iOS:

  • video/3gpp
  • video/mov
  • video/mp4
  • video/mpv

Always

minduration

integer

Minimum video ad duration (in seconds)

Sometimes

maxduration

integer

Maximum video ad duration (in seconds)

Sometimes

protocols

array (integer)

A list of supported video bid responseAfter evaluating a bid request, a real-time bidder’s communication to OpenX Ad Exchange, indicating if they’re interested in the impression, and if so, how much they’re willing to pay for it. protocols.

OpenX supports the following values:

  • 2 = VAST 2.0
  • 3 = VAST 3.0
  • 5 = VAST 2.0 Wrapper
  • 6 = VAST 3.0 Wrapper

For details, see the video bid response protocols in the IAB's OpenRTB 2.5 specification.

Always

w

integer

Width of the player (in pixels)

Always

h

integer

Height of the player (in pixels)

Always

startdelay

integer

The start delay (in seconds) for mid-rollIn-stream video ads that play in the middle of video content. ad placements, or an indication of the ad's position within linear videoA video ad or ad unit that typically appears in a video player before (pre-roll), after (post-roll), or during a break (mid-roll) in the streamed content. In addition to the in-stream format, linear video ad units may include interstitial, out-stream, and opt-in formats. They may also be accompanied by companion ads and include interactive components. content.

If the startdelay value is greater than 0, the position is mid-roll, and the value indicates the start delay. Possible values include:

For more details, see the IAB's OpenRTB 2.5 specification.

Always

placement

integer

Placement type for the impressionA single display of an ad on a web page, mobile app, or other delivery medium. For deals, impression is a metric to relay the total number of ads that have served. See also billable impression, forecasted impressions.. Possible values include:

Note: You can distinguish a full-screen interstitial (for example, in mobile) from a floating/slider unit via the imp.instl field.

Sometimes

linearity

integer

Indicates whether the ad impression is linear or non-linear. OpenX currently supports a value of 1 (linear).

For more details, see the IAB's OpenRTB 2.5 specification.

Always

skip

integer

Always sent for opt-in video (rewarded video).

Indicates if the player will allow the video to be skipped, where:

  • 0 = No
  • 1 = Yes

For opt-in video, OpenX will always pass 0.

Sometimes

battr

array (integer)

An array of blocked creativeThe media asset associated with an ad, such as an image or video file. attributes

If no value is specified, all types are allowed. For a list of creative attribute values, see the IAB's OpenRTB 2.5 specification.

Sometimes

maxextended

integer

Indicates whether extended video ad duration is allowed beyond the value of maxduration:

  • -1 = Extension is allowed and there is no limit
  • 0 = Extension is not allowed
  • >0 = Extension is allowed and the value indicates the number of seconds of extended play

Sometimes

minbitrate

integer

The minimum bitrate (in Kbps)

Sometimes

maxbitrate

integer

The maximum bitrate (in Kbps)

Sometimes

boxingallowed

integer

Indicates whether letterboxing of 4:3 video content in a 16:9 window is allowed (1) or not (0).

The default value is 1.

Sometimes

playbackmethod

array (integer)

Playback methods that may be in use.

Only one method is typically used in practice.

If none are specified, any method may be used.

Refer to the Video object and List 5.10 in the IAB's OpenRTB 2.5 specification for more details.

Sometimes

delivery

array (integer)

A list of supported delivery methods

For example: 1 for streaming or 2 for progressive

If no values are specified, assume all delivery methods are supported.

For details, see the IAB's OpenRTB 2.5 specification.

Always

api

array (integer)

One of the supported API standards or frameworks:

2 = VPAID 2.0

3 = MRAIDMobile Rich Ad Interface Definitions, a type of API framework for interfacing between an ad creative and native mobile capabilities. 1.0

4 = ORMMAOpen Rich Mobile Media Advertising, a type of API framework for video ad serving.

5 = MRAID 2.0

For example: 2

For details, see the IAB's OpenRTB 2.5 specification.

Sometimes

ext

object

An object containing properties that describe custom fields for the Video object.

Always

Additional publisher enrichment fields

Extensions object

BidRequest.imp.video.ext

Provides additional details about the video ad. The Video object may include an Extensions object.

Field name Data type Description Sent?
matching_ad_id

array

(MatchingAdId object)

A list of objects containing properties that describe ads for which Ad Exchange is soliciting bids from the bidder.

Always

skip integer

Present only when inventoryAd space available on a website or app. The basic unit of inventory for OpenX is an ad unit. is opt-in video (rewarded video).

Always set to 0 to identify non-skippable opt-in video.

Sometimes

videotype string

Present only when inventory is opt-in video.

Always set to rewarded to identify non-skippable opt-in video.

Sometimes

BidRequest.imp.video.ext.matching_ad_id

Each MatchingAdId object provides details about a matching ad for which Ad Exchange is soliciting bids.

Field name

Data type

Description

Sent?

ad_height

integer

The height of the ad unitThe smallest inventory component that represents the space on a site where ads display. in which the ad will be displayed.

For example: 250

This field duplicates the h field described in the Video object.

Always

ad_width

integer

The width of the ad unit in which the ad will be displayed.

For example: 300

This field duplicates the w field described in the Video object.

Always

campaign_id

integer

The ID for the business unitA logical grouping of traffic sets in a Demand Partner's account. to which the matching ad belongs

Always

creative_id

integer

The ID for the matching ad

Always

placement_id

integer

The ID for the traffic setA grouping of properties that controls the kind of traffic a Demand Partner wants to bid on and how they want to receive that traffic. Properties include buying models, spend cap, targeting criteria, maximum QPS, and routing endpoints. to which the matching ad belongs

Always

Fill out my online form.