OpenRTB connection
This specification is intended for Supply-Side platforms who want to integrate with E-Planning to sell their inventory. Complying with this specification will allow for a faster and more efficient integration to E-Planning’s production environment.
Contents
- 1 Auction
- 2 RTB Server-to-Server Protocol
- 3 Bid Request
- 3.1 Request Top-Level Object
- 3.2 Imp Object
- 3.3 Banner Object
- 3.4 Video Object
- 3.5 Format Object
- 3.6 Site Object
- 3.7 App Object
- 3.8 Publisher Object
- 3.9 Content Object
- 3.10 Producer Object
- 3.11 Channel Object
- 3.12 User Object
- 3.13 Device Object
- 3.14 Geo Object
- 3.15 Regs Object
- 3.16 Source Object
- 3.17 Bid Request example
- 4 Bid Response
- 5 Auction pricing macros
- 6 User Matching
- 6.1 buyeruid format
- 7 Compression
- 8 Persistent connections
Auction
What is often referred to as an “auction” consists of:
A bid request being sent to E-Planning (among other buyers)
E-Planning returning a bid response
The partner selecting a winner (if any)
The partner allowing the winner to display an ad to the user
Each of these steps will be specified in this document, along with parallel but equally important operations such as user matching.
RTB Server-to-Server Protocol
E-Planning uses JSON and the HTTP POST method.
E-Planning returns HTTP 204 to signal that it does not want to enter the auction.
The E-Planning RTB protocol and spec was built upon OpenRTB 2.3. However, some OpenRTB 2.5 features are supported (like Banner.format).
Bid Request
To invite E-Planning to enter an auction, the partner will be provided with a set of URLs (“endpoints”), each of them pointing to a different E-Planning data center. The general intent is that the data center closest to the partner’s data center should be used. Please reach out to your E-Planning technical contact for more details.
Only one bid request should be sent for a given auction, but multiple impression slots of the same can and should be included within a single bid request. The JSON file should have the structure below.
Note
Mandatory fields must be included.
Recommended fields have positive impact on bidding pattern when implemented properly.
Optional fields have positive impact on operations and reporting.
Request Top-Level Object
Field | Type | Status | Comment |
|---|---|---|---|
id | String | Mandatory | An identifier for the request, it can be used to connect the bid request to the bid response outside of the HTTP protocol |
tmax | Integer | Recommended | In milliseconds, the time after which bid responses will not enter the auction |
at | Integer | Mandatory | Auction type, where 1 = First Price, 2 = Second Price Plus |
imp | Object Array | Mandatory | See Imp object |
allimps | Integer | Recommended | Flag to indicate whether all the impressions of the context are available or not |
user | Object | Mandatory | See User object |
device | Object | Mandatory | See Device object |
site | Object | Mandatory for Web | See Site object |
app | Object | Mandatory for In-App | See App object |
source | Object | Mandatory | See Source object |
regs | Object | Mandatory | See Regs object |
badv | String Array | Recommended | Block list of advertisers by their domains |
bcat | String Array | Recommended | Blocked advertiser categories using the IAB content categories |
Example
Imp Object
Field | Type | Status | Comment |
|---|---|---|---|
id | String | Mandatory | A unique identifier for this impression within the context of the bid request (typically, starts with 1 and increments) |
banner | Object | Mandatory for display | A Banner object |
video | Object | Mandatory for video | A Video object |
bidfloorcur | String | Mandatory | Currency in which the bid response is expected, including the floor prices. using ISO-4217 alpha codes. Example: "USD" |
bidfloor | Float | Mandatory | The minimum amount for which the impression can be sold, expressed in the currency set in bidfloorcur |
secure | Integer | Mandatory | Set to1 if the snipped in the bid response must use HTTPS |