Bid Response

Note

Fields marked with asterisk (*) are optional.

Response Object

Parameter

Type

Description

id

string

Specifies the ID of the bid request to which this is a response to, for example, “d7d1e107-fe7c-4a57-9592-d1d41fa702d9”.

seatbid

array of objects

An array of Seat Bid objects, see the Seat Bid Object section. The length of the array can be either 1+ (for yes-bid) or 0 (for no-bid).

cur*

string

Specifies the ID of the bid request to which this is a response to, for example, “d7d1e107-fe7c-4a57-9592-d1d41fa702d9”.

nbr*

string

Returns a reason why the impression was not forwarded to any Buyers. A No Bid Reason response if different to a No Bid Response.

Seat Object

Parameter

Type

Description

bid

array of objects

An array of Seat Bid objects, see the Seat Bid Object section. The length of the array can be either 1+ (for yes-bid) or 0 (for no-bid).

seat*

string

ID of the bidder seat on whose behalf this bid is made. The value should match one of the values supplied in the wseat field of the bid request and it is REQUIRED if the wseat field is present in bid request. For example, “34”.

Bid Object

Parameter

Type

Description

id

string

A bidder generated ID for the bid object, used for tracking and debugging purposes.

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.

adm*

string

Used to pass creative markup for display (banner), video, or audio ads.

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.).

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, en.

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.

bundle*

string

A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.mygame).

cat*

array of strings

Array of IAB content categories, for example, [“IAB1”, “IAB2-3”].

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.