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 |
|---|---|---|---|
| w | Integer | Mandatory | The width of the player, in pixels |
| h | Integer | Mandatory | The height of the player, in pixels |
| maxduration | Integer | Mandatory | Maximum video ad duration, in seconds |
| minduration | Integer | Mandatory | Minimum video ad duration, in seconds |
| mimes | String Array | Mandatory | A list of supported video content MIME types. Popular MIME types supported by HTML5 players include: video/mp4, video/webm, video/ogg. For VPAID support, make sure to specify application/javascript. |
| protocols | Integer Array | Mandatory | An array of supported video protocols. At least one supported protocol must be specified, where: 2 = VAST 2.0, 3 = VAST 3.0, 5 = VAST 2.0 Wrapper, 6 = VAST 3.0 Wrapper |
| pos | Integer | Recommended | Follows the Ad Position IAB standard for Above-The-Fold, Below-The-Fold, etc. |
| 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 |
| boxingallowed | Integer | Recommended | Specifies whether letter-boxing of 4:3 content into a 16:9 window is allowed, where: 0 = boxing is not allowed, 1 = boxing is allowed (default setting) |
| delivery | Integer Array | Optional | A list of supported delivery methods. If blank, it is assumed that all are supported, where: 1 = streaming, 2 = progressive |
| linearity | Integer Array | Optional | Specifies whether the ad impression is linear or non-linear. If the field is blank, the ad impression can be of any type, where: 1 = linear/in stream, 2 = non-linear/overlay |
...
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.
...