Banner§3.2.6 · Bid Request
This object represents the most general type of impression. Although the term "banner" may have very specific meaning in other contexts, here it can be many things including a simple static image, an expandable ad unit, or even in-banner video (refer to the Video object in Section 3.2.7 for the more generalized and full featured video ad units). An array of Banner objects can also appear within the Video to describe optional companion ads defined in the VAST specification. The presence of a Banner as a subordinate of the Imp object indicates that this impression is offered as a banner type impression. At the publisher's discretion, that same impression may also be offered as video, 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 |
|---|---|---|
| format | object[] | Array of format objects (Section 3.2.10) representing the banner sizes permitted. If none are specified, then use of the h and w attributes is highly recommended. |
| w | integer | Exact width in device independent pixels (DIPS); recommended if no format objects are specified. |
| h | integer | Exact height in device independent pixels (DIPS); recommended if no format objects are specified. |
| wmax deprecated | integer | NOTE: Deprecated in favor of the format array. Maximum width in device independent pixels (DIPS). |
| hmax deprecated | integer | NOTE: Deprecated in favor of the format array. Maximum height in device independent pixels (DIPS). |
| wmin deprecated | integer | NOTE: Deprecated in favor of the format array. Minimum width in device independent pixels (DIPS). |
| hmin deprecated | integer | NOTE: Deprecated in favor of the format array. Minimum height in device independent pixels (DIPS). |
| btype | integer[] | Blocked banner ad types. Refer to List 5.2. |
| 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 → |
| 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 → |
| mimes | string[] | Content MIME types supported. Popular MIME types may include "application/x-shockwave-flash", "image/jpg", and "image/gif". |
| topframe | integer | Indicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes. |
| expdir | integer[] | Directions in which the banner may expand. Refer to List 5.5.Enum Expandable Directions · 6 values1Left 2Right 3Up 4Down 5Full Screen 6Resize/Minimize (make smaller) |
| 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. |
| id | string | Unique identifier for this banner object. Recommended when Banner objects are used with a Video object (Section 3.2.7) to represent an array of companion ads. Values usually start at 1 and increase with each object; should be unique within an impression. |
| vcm | integer | Relevant only for Banner objects used with a Video object (Section 3.2.7) in an array of companion ads. Indicates the companion banner rendering mode relative to the associated video, where 0 = concurrent, 1 = end-card. |
| 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