Link Search Menu Expand Document

PDF

Banner Object

Demand Partners

BidRequest Object


BidRequest.imp.banner

Each Imp object can contain one Banner object, which is required for banner impressions.

Field nameData typeDescriptionSent?
wintegerThe width of the ad space, in pixels, where the ad of the winning bidder is displayed. For example, 300Sometimes
hintegerThe height of the ad space in pixels. For example, 250Sometimes
formatarray of format objectsArray of format objects representing the banner sizes permitted.Always
btypearray (integer)Blocked banner ad types.Sometimes
battrarray (integer)An array of blocked creative attributes. If no value is specified, all types are allowed. For a list of creative attribute values, see .Sometimes
apiarray (integer)One of the supported API standards or frameworks:
   • 2 = VPAID 2.0
   • 3 = MRAID 1.0
   • 4 = ORMMA
   • 5 = MRAID 2.0
For example, 2
Sometimes
extextensions objectAn object containing properties that describe custom fields related to this banner ad.Sometimes

For additional details, see the IAB’s OpenRTB 2.5 specification.

For additional publisher enrichment fields, see Supplemental Data.


Extensions object

BidRequest.imp.banner.ext

The optional Extensions object can provide the following details about the banner.

Field nameData typeDescriptionSent?
matching_ad_idarray (MatchingAdId object)A list of objects containing properties that describe matching ads for which OpenX Ad Exchange is soliciting bids from the bidder.Always

MatchingAdId object

BidRequest.imp.banner.ext.matching_ad_id

Each MatchingAdId object provides details about a matching ad for which OpenX Ad Exchange is soliciting bids.

Field nameData typeDescriptionSent?
ad_heightintegerThe height of the ad unit in which the ad is displayed. For example, 250Always
ad_widthintegerThe width of the ad unit in which the ad is displayed. For example, 300Always
campaign_idintegerThe ID for the business unit to which the matching ad belongs.Always
creative_idintegerThe ID for the matching ad.Always
placement_idintegerThe ID for the traffic set to which the matching ad belongs.Always