Response Bid Object¶
Note
- (*) Fields marked with an asterisk are optional.
- While individually neither of the following fields is required, one
of them must be in the response:
adm,adm_native.
| Value | Type | Description |
|---|---|---|
| id | string | A bidder generated ID for the bid object, used for tracking and debugging
purposes, for example 3. |
| impid | string | The ID of the impression object (imp) from the bid request to which
this bid response applies, for example "1" |
| price | float | The bid price as a float value, expressed as CPM. All prices assumed
to be in USD if the cur parameter is omitted, for example 1.23 |
| protocol* | integer | The Video response protocol of the markup if applicable, see the Video Response Protocols table for the valid values. Note: This field is required in video responses. |
| adm* | string | Used to pass creative markup for display (banner), video, or audio ads.
One of either
|
| adm_native* | object | Used for native bid responses, see the Native Response Object
for the data it contains. One of either adm or adm_native
should be present in the response. |
| burl | string | The Billing notice URL called by the exchange using a server-to-server call when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.).” This field should contain the win price macro, see the Macros section.
|
| iurl* | string | Sample image URL (without cache busting) for content checking. REQUIRED when bidding on on banner bid requests.
|
| language* | string | The Alpha-2 ISO 639-1 code for the creative’s language, for example,
jp. The nonstandard code "xx" may also be used if the creative
has no linguistic content (e.g., a banner with just a company logo). |
| adomain | array of strings | Advertiser’s primary or top-level domain for advertiser checking. This
can be a list of domains if there is a rotating creative. Note that
some Suppliers allow only one domain. To those Suppliers BidSwitch only sends the
first domain from the list, for example, ["advertiser.com"] |
| cat* | array of strings | Array of IAB content categories, for example, ["IAB1", "IAB2-3"].
Based on the IAB taxonomy, and extended with additional sensitive
categories listed in the Sensitive Categories and Rich Media section. |
| cid* | string | Campaign ID or similar that is used by the Buyer to track and
organize their campaigns, for example, 102. |
| crid | string | Creative ID to assist with ad quality checking, for example “3021” |
| attr* | array of integers | Creative attributes as defined in the OpenRTB protocol, for example,
[1,3]. |
| dealid* | string | Reference to the deal.id from the bid request, if this bid
pertains to a private marketplace direct deal, for example,
"AA-1234" |
| h* | integer | The height of the creative in pixels when an alternative ad size is used,
relevant for banner ads only. 250 |
| w* | integer | The width of the creative in pixels when an alternative ad size is used,
relevant for banner ads only. 300 |
| ext* | object | This field can be used to supply information about the creative agency for whom the Buyer is working, see the Bid Ext Object section below for details. |
Bid Ext Object¶
| Value | Type | Description |
|---|---|---|
| advertiser_name* | string | The name of the advertiser serving the creative, for example,
"Coca-Cola" |
| agency_name* | string | The name of the agency representing the advertiser, for example,
"CCA" |
| agency_id* | string | ID of the agency representing the advertiser, for example, “123” |