BidResponse

Your bidding API should respond with the parameters outlined below. Bid responses may contain multiple bids that correspond to a single impression.

BidResponse object

The top level Bid Response Object and accompanying fields are below, followed by each lower level object contained within it.

FieldTypeDescription
idString; requiredA unique identifier for this request, as indicated in the id field of the Bid Request Object.
Note: This must be equal to the value received in the bid request.
bididString; optionalTBD
curString; requiredThe currency of the bid response. For more information, see List of currencies.
seatbidArray of Objects; requiredThe Seat Bid Object.

SeatBid object

FieldTypeDescription
seatString; requiredUnique identifier for the agency (when multiple agencies or independent direct clients use a DSP).
groupInteger; optionalTBD
bidArray of Objects; requiredThe Bid Object.

Bid object

FieldTypeDescription
adidString; optionalTBD
adomainArray of Strings; requiredThe domain/landing page/brand to identify the advertiser; limited to 128 characters.
admString; requiredThe actual ad markup: XHTML if responding to a Banner Object; VAST XML if responding to a Video Object.
bundleString; optionalThe app name or bundle being advertised (e.g. com.foo.mygame) if applicable;
burlString; requiredThe billing notice URL called by an exchange when a winning bid becomes billable based on publisher criteria (begin-to-render for web).
Note:
- It should contain the ${AUCTION_PRICE} notification macro and should be a part of a valid URL.
- It may contain the ${AUCTION_PRICE} notification macro in both the burl and adm fields. However, only impressions tracked from burl are considered billable.
catArray of Strings; optionalThe IAB Category of the Advertiser.
cidString; optionalTBD
cridString; optionalTBD
dealidString; optionalA unique identifier to represent a deal.
dsp_idString; optionalAdded by AIDEM after receiving the response. If sent it will be overwritten.
hInteger; requiredHeight of the creative in device-independent pixels.
idString; requiredA unique identifier to represent this bid.
impidString; requiredA unique identifier for this impression (indicated in the id field of the Impression Object); must be equal to the value received in the bid request.
priceFloat; requiredThe bid price represented as cost per thousand impressions (CPM). By default, bidding is in dollars represented as floating point numbers (for example, 2.71828).
wInteger; requiredWidth of the creative in device-independent pixels.