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.
...
| Field | Type | Status | Comment |
|---|---|---|---|
| id | String | Mandatory | Exchange-specific site ID |
| page | String | Mandatory | The URL of the page on which the impression will be shown; field should be absent when unknown or alternatively an empty string |
| publisher | Object | Mandatory | See Publisher Object |
| domain | String | Recommended | The domain of the page |
| cat | String Array | Recommended | Array of IAB content categories of the site as described in OpenRTB 2.5. Max 8 categories. |
| ref | String | Recommended | The referrer URL that caused navigation to the current page |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "123",
"page": "http://example.com/section/page.html",
"cat": [ "IAB1-2" ],
"publisher": {
"id": "456",
"domain": "example.com",
"name": "Example Inc"
}
} |
App Object
| Field | Type | Status | Comment |
|---|---|---|---|
| id | String | Obligatorio | Exchange-specific app ID |
| name | String | Obligatorio | The application’s name |
| bundle | String | Obligatorio | Application bundle or package name (e.g. "com.foo.mygame" on Android and numeric on iOS) |
| domain | String | Recomendado | Application domain |
| storeurl | String | Recomendado | Application store URL (e.g. iTunes store URL or Android store URL) |
| cat | String Array | Recomendado | Array of IAB content categories of the site as described in OpenRTB 2.5. Max 8 categories. |
Example
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "12345",
"name": "My App",
"bundle": "com.foo.myapp",
"domain": "myapp.com",
"storeurl": "https://store.com/app/12345",
"cat": [ "IAB1-2" ],
"publisher": {
"id": "456",
"domain": "example.com",
"name": "Example Inc"
}
} |
...
E-Planning provides partner with a sync URL, which partner should fire from traffic using an IFRAME tag. After URL is called from user's browser E-Planning will handle user's cookies on its side. Then E-Planning will redirect the user to a redirect URL which SSP provides to E- Planning.
There is a placeholder in this redirect URL, which E-Planning will replace with buyeruid generated on our side. This process only applies to Web auctions, not being necessary in In-App.
Example of supply partner’s redirect URL: http://test-partner-domain.com/?uid=$UID, E-Planning will replace $UID placeholder with some buyeruid (e.g. “e3cf38b549b50e01”) and redirect user using this URL.
Partner shall pass a redirect URL as "redir" parameter in E-Planning sync URL:
https://ads.us.e-planning.net/uspd/1/<CLIENT_ID>?ruidm=1&du=<ENCODED_REDIRECT_URL>
Note <CLIENT_ID> is provided by E-Planning
Here is the example of final sync IFRAME tag:
| Code Block | ||
|---|---|---|
| ||
<iframe src="https://ads.us.e-planning.net/uspd/1/5a1ad71d2d53a0f5?ruidm=1&du=https%3A%2F%2Ftest-partner-domain.com%2F%3Fuid%3D%24UID" width="0" height="0" style="display: none;"></iframe> |
It will redirect to:
https://test-partner-domain.com/?uid=e3cf38b549b50e01
buyeruid format
E-Planning’s buyeruid is a fixed 16 characters length string in all cases, eg: "e3cf38b549b50e01"
Compression
E-Planning can receive compressed bid requests from partners and send them back compressed bid responses. E-Planning recommends usage of compression in requests and responses to decrease auction latency and save network bandwith.
...