Table of Contents
Overview
OpenRTB is the standardized language of communication between SSPs and DSPs. It is used as the format of requests and responses when conducting bids in real-time using a near-instantaneous online auction. OpenRTB also allows for targeting based on precise demographics, whereas traditional buying and selling is often more broadly targeted.
Freewheel's Programmatic module communicates with DSPs using the OpenRTB protocol as defined by the IAB, either version 2.2, 2.5, or 2.6 (depending on specific DSP configurations).
This documents explains what values Freewheel passes for the different fields in the OpenRTB specification for bid requests (as well as values FreeWheel consumes in the OpenRTB bid responses), whether the value can be set by clients, and the logic for setting the values. In case of questions, please reach out to your MRM account team.
Any fields not listed in the tables below are not supported by FreeWheel
Bid Response Object
| Field | Description | Frequency of Field |
|---|---|---|
| id | ID of the bid request to which this is a response. | Required |
| seatbid | Array of seatbid objects; 1+ required if a bid is to be made. See seat bid object | Required |
| bidid | Bidder-generated response ID to assist with logging/tracking. | Optional |
| cur | Bid currency using ISO-4217 alpha codes. Must be one of the allowed currencies specified in the bid request. | Required |
Seat Bid Object
| Field | Description | Frequency of Field |
|---|---|---|
| bid | Array of 1+ Bid objects each related to an impression. Multiple bids can relate to the same impression. See bid object | Required |
| seat | ID of the buyer seat (e.g., advertiser, agency) on whose behalf this bid is made.
| Optional but highly recommended |
Bid Object
| Field | Description | Frequency of Field |
|---|---|---|
| id | Bidder generated bid ID to assist with logging/tracking. If not present, FreeWheel will filter out the bid. | Required |
| impid | ID of the Imp object in the related bid request. | Required |
| price | Bid price expressed as CPM although the actual transaction is for a unit impression only. | Required |
| adid | A unique ID of the ad from the bidder. | Optional but highly recommended |
| nurl | Win notice URL called by the exchange if the bid wins (not indicative of a delivered, viewed, or billable ad). | Optional |
| adm | Convey ad markup. | Required |
| adomain | Advertiser domain for block list checking (e.g., “ford.com”). This can be an array in the case of rotating creatives. FreeWheel only uses the first domain. | Optional but highly recommended |
| lurl (v2.5) | Loss notice URL called by FreeWheel when a bid is known to have been lost. FreeWheel supports the ${AUCTION_LOSS} macro (OpenRTB2.5 only). Code supported (IAB compliant): INTERNAL_ERROR(1), CREATIVE_FILTERED_PENDING(201), CREATIVE_FILTERED_DISAPPROVED_BY_EXCHANGE(202), | Optional |
| cid | Campaign ID of the ad. | Optional but highly recommended |
| crid | Creative ID of the ad. | Optional but highly recommended |
| dealid | Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal. | Optional |
