Imp.banner
A Banner object, present when the impression is offered as display. Its presence is the offer: the buyer may return display creative in one of the sizes given by Banner.format or by Banner.w and Banner.h.
Field facts
- Path
imp.banner- Object
- Imp
- Type
- object
- Requirement
- Optional
- Added
- OpenRTB 2.0
- Spec section
- 3.2.4
How it is used
Banner can sit beside video, audio, or native on the same Imp when the slot accepts more than one kind of creative, and the bid says which one it answers through Bid.mtype. The same Banner object also describes companion slots inside Video.companionad and Audio.companionad, but those companions are part of the video or audio offer, not a separate display offer.
Example
Where the field sits in a payload, with everything else left out:
{
"id": "req-1",
"imp": [
{
"banner": {
"format": [
{
"w": 300,
"h": 250
},
{
"w": 300,
"h": 600
}
],
"pos": 1
}
}
]
}Common mistakes
- Sending an empty banner object with no format and no w or h leaves buyers guessing the size, and most skip the impression.
- An Imp with none of banner, video, audio, or native offers nothing to buy. The validator reports openrtb.imp.media_type.required.
Version history
Added in OpenRTB 2.0, and present in the latest snapshot. The table shows how each version's spec text types the field.
| Versions | Type in the spec | Required | Deprecated |
|---|---|---|---|
| 2.0 to 2.1 | object | No | No |
| 2.2 | object | No | No |
| 2.3 to 2.4 | object | No | No |
| 2.5 to 2.6-202606 | object | No | No |
Related fields
Other Imp fields
audiobidfloorbidfloorcurclickbrowserdisplaymanagerdisplaymanagerverdtexpextidiframebusterinstlmetricnativepmpqtyrefreshrwddsecuressaitagidvideo
For a walkthrough of the whole object, read Bid request anatomy.