Video§3.2.7 · Bid Request
This object represents an in-stream video impression. Many of the fields are non-essential for minimally viable transactions, but are included to offer fine control when needed. Video in OpenRTB generally assumes compliance with the VAST standard. As such, the notion of companion ads is supported by optionally including an array of Banner objects (refer to the Banner object in Section 3.2.6) that define these companion ads. The presence of a Video as a subordinate of the Imp object indicates that this impression is offered as a video type impression. At the publisher's discretion, that same impression may also be offered as banner, audio, and/or native by also including as Imp subordinates objects of those types. However, any given bid for the impression must conform to one of the offered types.
| Attribute | Type | Description |
|---|---|---|
| mimes required | string[] | Content MIME types supported (e.g., "video/x-ms-wmv", "video/mp4"). |
| minduration | integer | Minimum video ad duration in seconds. |
| maxduration | integer | Maximum video ad duration in seconds. |
| protocols | integer[] | Array of supported video protocols. Refer to List 5.8. At least one supported protocol must be specified in either the protocol or protocols attribute.Enum Creative Subtypes - Audio/Video · 16 values1VAST 1.0 2VAST 2.0 3VAST 3.0 4VAST 1.0 Wrapper 5VAST 2.0 Wrapper 6VAST 3.0 Wrapper 7VAST 4.0 8VAST 4.0 Wrapper 9DAAST 1.0 10DAAST 1.0 Wrapper 11VAST 4.1 12VAST 4.1 Wrapper 4 more values in the enumerations overview → |
| protocol deprecated | integer | NOTE: Deprecated in favor of protocols. Supported video protocol. Refer to List 5.8. At least one supported protocol must be specified in either the protocol or protocols attribute. |
| w | integer | Width of the video player in device independent pixels (DIPS). |
| h | integer | Height of the video player in device independent pixels (DIPS). |
| startdelay | integer | Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. Refer to List 5.12 for additional generic values.Enum Start Delay Modes · 4 values>0Mid-Roll (value indicates start delay in second) 0Pre-Roll -1Generic Mid-Roll -2Generic Post-Roll |
| placement | integer | Placement type for the impression. Refer to List 5.9. |
| linearity | integer | Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed. Refer to List 5.7.Enum Linearity Modes · 2 values1Linear 2Non-Linear (i.e., Overlay) |
| skip | integer | Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. If a bidder sends markup/creative that is itself skippable, the Bid object should include the attr array with an element of 16 indicating skippable video. Refer to List 5.3.Enum Creative Attributes · 24 values1Audio Ad (Autoplay) 2Audio Ad (User Initiated) 3Expandable (Automatic) 4Expandable (User Initiated - Click) 5Expandable (User Initiated - Rollover) 6In-Banner Video Ad (Autoplay) 7In-Banner Video Ad (User Initiated) 8Pop (e.g., Over, Under, or Upon Exit) 9Provocative or Suggestive Imagery 10Shaky, Flashing, Flickering, Extreme Animation, Smileys 11Surveys 12Text Only 12 more values in the enumerations overview → |
| skipmin default 0 | integer | Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable. |
| skipafter default 0 | integer | Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable. |
| 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. |
| battr | integer[] | Blocked creative attributes. Refer to List 5.3.Enum Creative Attributes · 24 values1Audio Ad (Autoplay) 2Audio Ad (User Initiated) 3Expandable (Automatic) 4Expandable (User Initiated - Click) 5Expandable (User Initiated - Rollover) 6In-Banner Video Ad (Autoplay) 7In-Banner Video Ad (User Initiated) 8Pop (e.g., Over, Under, or Upon Exit) 9Provocative or Suggestive Imagery 10Shaky, Flashing, Flickering, Extreme Animation, Smileys 11Surveys 12Text Only 12 more values in the enumerations overview → |
| maxextended | integer | Maximum extended ad duration if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value. |
| minbitrate | integer | Minimum bit rate in Kbps. |
| maxbitrate | integer | Maximum bit rate in Kbps. |
| boxingallowed default 1 | integer | Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes. |
| playbackmethod | integer[] | Playback methods that may be in use. If none are specified, any method may be used. Refer to List 5.10. Only one method is typically used in practice. As a result, this array may be converted to an integer in a future version of the specification. It is strongly advised to use only the first element of this array in preparation for this change.Enum Playback Methods · 11 values1Initiates without any specific user interaction with Sound On 2Initiates without any specific user interaction Sound Off by Default 3Initiates on Click with Sound On 4Initiates on Mouse-Over or cursor over with Sound On 5Initiates on Entering Viewport or scrolling into view with Sound On 6Initiates on Entering Viewport or scrolling into view with Sound Off by Default 7Continuous Playback - Media playback is set to play additional media automatically without user interaction. The media player will keep playing additional media (playlist or generated) for the user until the user actively stops this from happening. 8Initiated by user pausing content, Sound on 9Initiated by user pausing content, Sound off 10Initiated by idling (e.g. screensaver), Sound on 11Initiated by idling (e.g. screensaver), Sound off |
| playbackend | integer | The event that causes playback to end. Refer to List 5.11. |
| delivery | integer[] | Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported. Refer to List 5.15.Enum Delivery Methods · 3 values1Streaming 2Progressive 3Download |
| pos | integer | Ad position on screen. Refer to List 5.4.Enum Placement Positions · 18 values0Unknown 1Above The Fold 2Locked (i.e., fixed position) 3Below The Fold 4Header 5Footer 6Sidebar 7Fullscreen 8Partial Screen 9Top Left 10Top Right 11Frame the content 6 more values in the enumerations overview → |
| companionad | object[] | Array of Banner objects (Section 3.2.6) if companion ads are available. |
| api | integer[] | List of supported API frameworks for this impression. Refer to List 5.6. If an API is not explicitly listed, it is assumed not to be supported.Enum API Frameworks · 10 values1VPAID 1.0 2VPAID 2.0 3MRAID 1.0 4ORMMA 5MRAID 2.0 6MRAID 3.0 7OMID 1.0 8SIMID 1.0 9SIMID 1.1 500+Vendor-specific codes. |
| companiontype | integer[] | Supported VAST companion ad types. Refer to List 5.14. Recommended if companion Banner objects are included via the companionad array. If one of these banners will be rendered as an end-card, this can be specified using the vcm attribute with the particular banner (Section 3.2.6).Enum Companion Types · 3 values1Static Resource 2HTML Resource 3iframe Resource |
| ext | object | Placeholder for exchange-specific extensions to OpenRTB. |
Field descriptions reconciled against the official 2.6 draft; 2.5-specific fields come from a third-party Go implementation source (Apache 2.0), proofread against the official PDF · first-draft proofreading