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 |
|---|---|---|---|
| format | Object Array | Mandatory if “w” and “h” are not set | See Format Object. Formats allowed in the auction; it is an array to reflect the fact that many publisher placements support several sizes considered as part of one auction (e.g. 300x250 or 300x600). |
| w | Integer | Mandatory if “format” is not set | Width in pixels of the banner supported size |
| h | Integer | Mandatory if “format” is not set | Height in pixels of the banner supported size |
| wmin | Integer | Recommended if “format” is not set | Minimum width in pixels of the banner supported size |
| wmax | Integer | Recommended if “format” is not set | Maximum width in pixels of the banner supported size |
| hmin | Integer | Recommended if “format” is not set | Minimum height in pixels of the banner supported size |
| hmax | Integer | Recommended if “format” is not set | Maximum height in pixels of the banner supported size |
| pos | Integer | Recommended | Follows the Ad Position IAB standard for Above-The-Fold, Below-The-Fold, etc. |
| topframe | Integer | Recommended | Indicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes |
| api | Integer | Recommended | List of supported API frameworks for this impression as described in OpenRTB 2.5. If you are sending inApp traffic, please consider add OMID-1 flag (7) if is supported. |
| battr | Integer Array | Recommended | Blocked creatives attributes |
| btype | Integer Array | Recommended | Blocked banner ad types |
| expdir | Integer Array | Optional | Directions in which the banner may expand |
...
| Field | Type | Status | Comment |
|---|---|---|---|
| fd | Integer | Mandatory | Entity responsible for the final impression sale decision, 0 = exchange / 1 = upstream source |
| pchain | String | Recommended if "schain" is not set | TAG payment ID chain string |
| ext.schain | String | Recommended if "pchain" is not set | Per IAB's supply chain object proposal |
| ext.omidpn | String | Recommended if inApp | Identifier of the OM SDK integration |
| ext.omidpv | String | Recommended if inApp | Version of the OM SDK integration |
| Info | ||
|---|---|---|
| ||
For pchain implementation we accept both TAG ID or domain identification |
...
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.
...