We're moving to the new documentation portal: developers.bidmachine.io
Documentation
Log In
Documentation

Banner Object

Banner Object Properties

AttributeTypeDescriptionExample
winteger

Width of the impression in pixels. If neither wmin nor wmax are specified, this value is an exact width requirement.

Otherwise it is a preferred width.

320
hinteger

Height of the impression in pixels. If neither hmin nor hmax are specified, this value is an exact height requirement.

Otherwise it is a preferred height.

50
wmaxinteger

Maximum width of the impression in pixels.

If included along with a w value then w should be interpreted as a recommended or preferred width.

320
hmaxinteger

Maximum height of the impression in pixels.

If included along with an h value then h should be interpreted as a recommended or preferred height.

50
wmininteger

Minimum width of the impression in pixels.

If included along with a w value then w should be interpreted as a recommended or preferred width.

320
hmininteger

Minimum height of the impression in pixels.

If included along with an h value then h should be interpreted as a recommended or preferred height.

50
idstring

Unique identifier for this banner object.

Recommended when Banner objects are used with a Video object to represent an array of companion ads.

Values usually start at 1 and increase with each object; should be unique within an impression.

ap1gm-0jioruind-1ffopjgo1p
btypeinteger arrayBlocked banner ad types.[2]
battrinteger array

Blocked creative attributes. BidMachine currently blocks followind ad types: "Expandable (User Initiated - Rollover)";

"Pop (e.g., Over, Under, or Upon Exit)"; "Provocative or Suggestive Imagery"; "Shaky, Flashing, Flickering, Extreme Animation, Smileys";

"Windows Dialog or Alert Style"

[5,8,9,10,14]
posintegerAd position on screen.5
mimesstring array

Content MIME types supported.

BidMachine supports: “image/png”, “text/javascript”, “text/html”, “image/jpg”, and “image/gif”.

["image/jpg","image/gif","image/png"]
topframeintegerIndicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes.1
apiinteger array

List of supported API frameworks for this impression.

If an API is not explicitly listed, it is assumed not to be supported.

[5,3]
extobjectPlaceholder for exchange-specific extensions to OpenRTB.{"bannertype":"rewarded"}

Banner Ext Object Properties

For normal (skippable) interstitials Exchange Server does not send any EXT

For nonskippable/rewarded interstitials Exchange Server will send this extension.

AttributeTypeDescriptionExample
extobjectPlaceholder for exchange-specific extensions to OpenRTB.{"bannertype":"rewarded"}