Bid Response objects and parameters

The BidResponse contains one or more SeatBids, each with Bids specifying creative details, price, and targeting. Mandatory fields must follow the OpenRTB spec, while optional fields can improve targeting, analytics, and performance with Adagio’s DSP partners.

circle-info

Adagio populates as many fields as possible among those listed below. The actual content of each response depends on:

  • the information provided in the original ad request,

  • the data returned by bidders in their bid responses.

1. bidresponse object

Field
Type
Description

id

string

ID of the of the bidRequest to which this is a response

seatbid

Array of seatbid objects; with at least 1 entry is a bid is to be made.

bidid

string

Bidder generated response ID to assist with logging/tracking.

cur

string; default "USD"

Bid currency. Refer to Supported Currencies

nbr

integer

Reason for not bidding. Due to cost optimisation, Adagio uses HTML request's headers error codes instead of nbr codes in their body.

2. seatbid object

Field
Type
Description

seat

string

ID of the demand partner seat on Adagio's platform.

bid

array of objects

Array of bid objects for impressions.

3. bid object

Field
Type
Description

id

string

Bidder-generated bid ID.

impid

string

ID of the impression being bid on.

price

float

Bid price CPM in currency specified.

adm

string

Optional means of conveying ad markup (e.g., HTML, VAST XML) in case the bid wins; supersedes the win notice if markup is included in both. Substitution macros (Refer to IAB Section 4.4arrow-up-right) may be included.

crid

string

Creative ID to assist with ad quality checking .

nurl

string

Win notice URL called by the exchange if the bid wins (not necessarily indicative of a delivered, viewed, or billable ad); optional means of serving ad markup. Substitution macros (Refer to IAB Section 4.4arrow-up-right) may be included in both the URL and optionally returned markup.

burl

string

Billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.). Substitution macros (Refer to IAB Section 4.4arrow-up-right) may be included.

lurl

string

Loss notice URL called by the exchange when a bid is known to have been lost based on exchange-specific business policy (e.g., typically delivered, viewed, etc.). Substitution macros (Refer to IAB Section 4.4arrow-up-right) may be included.

adid

string

ID of a preloaded ad to be served if the bid wins

bundle

string

App bundle or package name.

cat

string array

Creative IAB category. The taxonomy to be used is defined by the cattax field.

cattax

integer; default 1

The taxonomy in use. Refer to List: Category Taxonomiesarrow-up-right for values.

attr

integer array

Creative attributes.

language

string

Language of creative (ISO-639-1).

adomain

string array

Advertiser domain for block list checking (e.g., “ford.com”). This can be an array of for the case of rotating creatives.

apis

integer array

List of supported APIs for the markup. If an API is not explicitly listed, it is assumed to be unsupported. Refer to List: API Frameworksarrow-up-right in AdCOM 1.0.

protocol

integer

Video response protocol of the markup if applicable. Refer to List: Creative Subtypes - Audio/Videoarrow-up-right in AdCOM 1.0.

exp

integer

Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression. Violating this might result in ignored billable impression or IVT.

dur

integer

Duration of the video creative in seconds if applicable.

mtype

integer

Type of the creative markup so that it can properly be associated with the right sub-object of the BidRequest.Imp. Values: 1 = Banner 2 = Video, 3 = Audio 4 = Native

w

integer

Width of the creative in device-independent pixels (DIPS).

h

integer

Height of the creative in device-independent pixels (DIPS).

wratio

integer

Relative width of the creative when expressing size as a ratio.

hratio

integer

Relative height of the creative when expressing size as a ratio.

References

Last updated

Was this helpful?