For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Open RTB Bid Response Specifications

The response for a bid request has the following structure:

Bid Response Object

Attribute
Required?
Description

id

Yes

ID of the bid request (string)

seatbid

Yes

Collection of bids made by the bidder on behalf of a specific seat.

seatbid

Attribute
Required?
Description

bid

Yes

ID of the impression object to which this bid applies (string)

seatbid.bid

Attribute
Required?
Description

id

Yes

ID for the bid object chosen by the bidder (string)

impid

Yes

ID of the impression object to which this bid applies (string)

price

Yes

Bid price in CPM or CPC (float)

adm

Yes

EXADS XML/JSON Ad Markup (string)

nurl

Yes*

Win notification URL, it is recommended to use HTTP over HTTPS for nurl (string)

burl

No

Billing notification URL. Called server-to-server when the impression or click becomes billable (CPM or CPC, per the btype field), so it can be counted from the billable event instead of the pixel. (string)

cid

No

Campaign ID to assist with ad quality checking (string)

crid

No

Creative ID to assist with ad quality checking (string)

cat

Yes

IAB content categories of the creative (string array)

ext

No

EXADS specific extension (object)


Note: The nURL must be notified in order to ensure campaign capping and avoid getting the same response every time.


seatbid.bid.ext

Attribute
Required?
Description

btype

Recommended

Pricing Model. Values: 1 = CPM, 2 = CPC. Default = 1 (int). Note: When response is for an Email Clicks zone request, 1 = Smart CPC.


Note: Only Push Notification and Native ad formats may bid with the CPC pricing model.


JSON Examples

Full Page Interstitial: JSON

Email Clicks: JSON

In-Stream Video, Outstream Video, Video Slider

Native: JSON

ADM Examples

Email Clicks: XML

In-Stream Video, Outstream Video, Video Slider: XML


Note: See VAST Tag related documentation.


Popunder: XML

Full Page Interstitial: XML

Native Ads: JSON

For native ads the adm parameter should contain a JSON encoded string like this:

Push Notification Ads: JSON

For Push Notification ads the adm parameter will contain a JSON encoded string like the following (note that we use the 'native' object to implement push notification ads). Width and height depend on the width and height coming from request. Currently supported dimensions are 192x192 and 720x480. One image asset per notification.

Which is based on the following JSON object:

No Bid Response

To answer a bid request without making an actual bid, an HTTP response code 204 "No Content" will be sent.

Win Notification

When the parameter Bid Response Object -> Seat Bid Object -> Bid Object -> nurl is in the bid response, a GET request must be performed to such URL.

Billing Notification

When the parameter Bid Response Object -> Seat Bid Object -> Bid Object -> burl is in the bid response, a GET request is performed to that URL when the impression or click becomes billable (CPM or CPC, per the btype field). This allows the impression or click to be counted from the billable event rather than from pixel-based tracking.

If both nurl and burl are present, both should be called.

Last updated

Was this helpful?