Banner object

A Banner describes a display slot: the sizes it accepts, where it sits on screen, and which ad types and creative attributes the seller blocks. It appears at imp.banner for display offers, and the same object describes companion slots inside Video.companionad and Audio.companionad.

17 fieldsOpenRTB 2.0 to 2.6-202606At imp.banner, imp.audio.companionad, imp.video.companionad

How it is used

Since OpenRTB 2.4 the accepted sizes belong in Banner.format, an array of Format objects, and the single Banner.w and Banner.h pair is the fallback when no list is sent. The min and max size fields from 2.2 were deprecated in 2.4 and removed in 2.6. As a companion, a Banner describes a slot shown with the video or audio ad. The buyer fills it with companion creative inside the VAST markup, not with a separate bid, and Video.companiontype says which VAST companion resource types the slot can take.

Fields

FieldTypeRequirementSinceStatus
apiinteger arrayOptional2.0Current
battrinteger arrayOptional2.0Current
btypeinteger arrayOptional2.0Current
expdirinteger arrayOptional2.0Current
extobjectOptional2.1Current
formatobject arrayRecommended2.4Current
hintegerOptional2.0Current
hmaxintegerOptional2.2Removed after 2.5
hminintegerOptional2.2Removed after 2.5
idstringOptional2.0Current
mimesstring arrayOptional2.0Current
posintegerOptional2.0Current
topframeintegerOptional2.0Current
vcmintegerOptional2.5Current
wintegerOptional2.0Current
wmaxintegerOptional2.2Removed after 2.5
wminintegerOptional2.2Removed after 2.5

Where it sits

Contained in: Audio, Imp, Video.

Contains: Format.

All objects

The field reference index lists every OpenRTB 2.x object.