OpenRTB BidResponse

Fields

FieldTypeDescription
cf_latitudeFloat; optionalLatitude of the incoming request, e.g. 30.27130
cf_longitudeFloat; optionalLongitude of the incoming request, e.g. -97.74260
cf_coloString; optionalThe three-letter airport code (e.g. ATX, LUX) representing the colocation which processed the request
cf_asnInteger; optionalThe Autonomous System Number (ASN) of the request, e.g. 395747
cf_countryString; optionalThe two-letter country code of origin for the request. This is the same value as that provided in the CF-IPCountry header, e.g. "US"
cf_cityString; optionalCity of the incoming request, e.g. “Austin”.
cf_continentString; optionalContinent of the incoming request, e.g. “NA”
cf_postal_codeString; optionalPostal code of the incoming request, e.g. “78701”
cf_regionString; optionalIf known, the ISO 3166-2 name for the first level region associated with the IP address of the incoming request, e.g. “Texas”.
cf_region_codeString; optionalIf known, the ISO 3166-2 code for the first level region associated with the IP address of the incoming request, e.g. “TX”.
worker_cf_rayString; requiredThe Cf-Ray of the worker that handled the request
client_ipString; requiredThe ip of the request
timestampInteger; requiredThe timestamp of the request
dateString; requiredThe date of the request in the format YYYY-MM-DD
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.
curString; optionalTBD
bididString; requiredThe currency of the bid response. For more information, see List of currencies.
seatbid_seatString; requiredUnique identifier for the agency (when multiple agencies or independent direct clients use a DSP).
seatbid_groupInteger; optionalTBD
seatbid_bid_adidString; optionalTBD
seatbid_bid_adomainArray of Strings; requiredThe domain/landing page/brand to identify the advertiser; limited to 128 characters.
seatbid_bid_admString; requiredThe actual ad markup: XHTML if responding to a Banner Object; VAST URL if responding to a Video Object.
seatbid_bid_bundleString; optionalThe app name or bundle being advertised (e.g. com.foo.mygame) if applicable;
seatbid_bid_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.
seatbid_bid_catArray of Strings; optionalThe IAB Category of the Advertiser.
seatbid_bid_cidString; optionalTBD
seatbid_bid_cridString; optionalTBD
seatbid_bid_dealidString; optionalA unique identifier to represent a deal.
seatbid_bid_dsp_idString; optionalAdded by AIDEM after receiving the response. If sent it will be overwritten.
seatbid_bid_hInteger; requiredHeight of the creative in device-independent pixels.
seatbid_bid_idString; requiredA unique identifier to represent this bid.
seatbid_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.
seatbid_bid_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).
seatbid_bid_wInteger; requiredWidth of the creative in device-independent pixels.