OpenRTB Bid Responses
Last updated on November 16, 2017
The following sections provide OpenRTB bid response field reference and other related information for OpenRTB S2S supply integrations:
on this page
- OpenRTB Bid Response Fields
- Price Notification Macros
- Unsupported OpenRTB Bid Response Fields
- Sample OpenX OpenRTB Bid Responses
OpenRTB Bid Response Fields
The table below describes the fields that OpenX may send in OpenRTB S2S integration bid responses.
Object | Field location | Field name | Supported? |
---|---|---|---|
BidResponse | BidResponse.id | id | Supported |
BidResponse.seatbid | seatbid | Supported. See Seatbid object below. | |
BidResponse.cur | cur | Supported | |
Seatbid | BidResponse.seatbid.bid | bid | Supported. See Bid object below. Included for each Imp object. Requests with multiple Imp objects are not recommended. |
BidResponse.seatbid.seat | seat | Supported. This string returns OpenX by default. | |
Bid | BidResponse.seatbid.bid.id | id | Supported |
BidResponse.seatbid.bid.impid | impid | Supported | |
BidResponse.seatbid.bid.price | price | Supported. Currency defaults to your set currency. | |
BidResponse.seatbid.bid.nurl | nurl | Supported for video VAST URI responses only. | |
BidResponse.seatbid.bid.burl | burl | Supported, mobile app only. See Price notification macros for more details. | |
BidResponse.seatbid.bid.adm | adm | Supported. See Price notification macros for more details. | |
BidResponse.seatbid.bid.adomain | adomain | Supported | |
BidResponse.seatbid.bid.crid | crid | Preferred. OpenX returns a single creative ID per response. | |
BidResponse.seatbid.bid.dealid | dealid | Supported | |
BidResponse.seatbid.bid.w | w | Supported | |
BidResponse.seatbid.bid.h | h | Supported | |
BidResponse.seatbid.bid.ext | ext | Supported. See Extension object below. | |
Ext | BidResponse.seatbid.bid.ext.imptrackers | imptrackers | Supported, non-video mobile app only. This field (or equivalent field, if named differently) is required if the creative is pre-cached. See Price notification macros for more details. |
NOTE
To learn more about these fields, refer to the IAB’s OpenRTB 2.5 specification.
Price Notification Macros
By default, OpenX supports the OpenRTB macro ${AUCTION_PRICE}
for OpenRTB S2S supply integrations. This macro expands to the clearing price using the same currency and units (CPM) as the bid.
You must support the ${AUCTION_PRICE}
macro in the Bid object field that corresponds with the chosen billing method. That field will be one of the following:
adm
: For desktop and mobile web.burl
: For non-video mobile app content that is not pre-rendered.imptrackers
: For pre-rendered ,non-video mobile app content, like cached ads.
NOTE
OpenX does not support clearing price replacement or billing through the
nurl
field. The only exception is for VAST URI (video) responses.
Unsupported OpenRTB Bid Response Fields
OpenX has no plan to support the following fields.
Object | Field location | Field name |
---|---|---|
Bid | BidResponse.seatbid.bid.adid | adid |
Bid | BidResponse.seatbid.bid.iurl | iurl |
Bid | BidResponse.seatbid.bid.cid | cid |
Sample OpenX OpenRTB Bid Responses
OpenX responds to your bid request with an ad via an OpenRTB bid response. See examples for web and app inventory below.
Web
Click to see a sample for a web display ad
{
"seatbid": [{
"seat": "OpenX",
"bid": [{
"w": 300,
"price": 0.76,
"impid": "1",
"id": "e2101ebf-f746-4eb2-9239-1848ce661d58",
"h": 250,
"crid": "CRID",
"adomain": [
"advertiser.com"
],
"adm": "AD_MARKUP"
}]
}],
"id": "80ce30",
"cur": "USD"
}
App
Click to see a sample for an app display ad
{
"seatbid": [{
"seat": "OpenX",
"bid": [{
"w": 300,
"price": 2.5,
"impid": "1",
"id": "6c5b0247-9152-4bbc-a5c5-b0ee3293b1c9",
"h": 250,
"ext": {
"imptrackers": [
"IMPRESSION_TRACKER"
]
},
"crid": "CRID",
"adomain": [
"advertiser.com"
],
"adm": "AD_MARKUP"
}]
}],
"id": "afVbta4q5tLDOzB2eP1IoQ",
"cur": "USD"
}