Banner Object
BidRequest.imp.banner
Each Imp object can contain one Banner object, which is required for banner impressions.
| Field name | Data type | Description | Sent? |
|---|---|---|---|
w | integer | The width of the ad space, in pixels, where the ad of the winning bidder is displayed. For example, 300 | Sometimes |
h | integer | The height of the ad space in pixels. For example, 250 | Sometimes |
format | array of format objects | Array of format objects representing the banner sizes permitted. | Always |
btype | array (integer) | Blocked banner ad types. | Sometimes |
battr | array (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 |
api | array (integer) | One of the supported API standards or frameworks: • 2 = VPAID 2.0• 3 = MRAID 1.0• 4 = ORMMA• 5 = MRAID 2.0For example, 2 | Sometimes |
ext | extensions object | An 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 name | Data type | Description | Sent? |
|---|---|---|---|
matching_ad_id | array (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 name | Data type | Description | Sent? |
|---|---|---|---|
ad_height | integer | The height of the ad unit in which the ad is displayed. For example, 250 | Always |
ad_width | integer | The width of the ad unit in which the ad is displayed. For example, 300 | Always |
campaign_id | integer | The ID for the business unit to which the matching ad belongs. | Always |
creative_id | integer | The ID for the matching ad. | Always |
placement_id | integer | The ID for the traffic set to which the matching ad belongs. | Always |