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 |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "id": "456", "domain": "example.com", "name": "Example Inc" } |
Content Object
This object describes the content in which the impression will appear, which may be syndicated or non-syndicated content. This object may be useful when syndicated content contains impressions and does not necessarily match the publisher’s general content. This object is highly recommended in CTV inventory and should be sent whenever possible.
Field | Type | Status | Comment |
---|---|---|---|
id | String | Recommended | ID uniquely identifying the content |
episode | Integer | Recommended | Episode number |
title | String | Recommended | Content title |
series | String | Recommended | Content series |
season | String | Recommended | Content season |
artist | String | Recommended | Artist credited with the content |
genre | String | Recommended | Genre that best describes the content |
album | String | Recommended | Album to which the content belongs |
producer | Object | Recommended | Details about the content producer (see "Producer Object") |
url | String | Recommended | URL of the content, for buy-side contextualization or review |
cat | String Array | Recommended | Array of IAB content categories that describe the content |
prodq | Integer | Recommended | Production quality. Refer to List: Production Qualities in AdCOM 1.0 |
context | Integer | Recommended | Type of content (game, video, text, etc.). Refer to List: Content Contexts in AdCOM 1.0 |
contentrating | String | Recommended | Content rating (e.g., MPAA) |
userrating | String | Recommended | User rating of the content (e.g., number of stars, likes, etc.). |
qagmediarating | Integer | Recommended | Media rating per IQG guidelines. Refer to List: Media Ratings in AdCOM 1.0 |
keywords | String | Recommended | Comma separated list of keywords describing the content |
livestream | Integer | Recommended | 0 = not live, 1 = content is live |
sourcerelationship | Integer | Recommended | 0 = indirect, 1 = direct |
len | Integer | Recommended | Length of content in seconds; appropriate for video or audio |
language | String | Recommended | Content language using ISO-639-1-alpha-2 |
embeddable | Integer | Recommended | Indicator of whether the content is embeddable (e.g., an embeddable video player), where 0 = no, 1 = yes |
channel | Object | Recommended | Details about the channel the content is on (see "Channel Object") |
Producer Object
This object defines the producer of the content in which the ad will be shown. This is particularly useful when the content is syndicated and may be distributed through different publishers and thus when the producer and publisher are not necessarily the same entity.
Field | Type | Status | Comment |
---|---|---|---|
id | String | Recommended | Content producer or originator ID |
name | String | Recommended | Content producer or originator name (e.g., “Warner Bros”) |
cat | String | Recommended | Array of IAB content categories that describe the content producer |
domain | String | Recommended | Highest level domain of the content producer (e.g., “producer.com”) |
Channel Object
This object describes the channel an ad will be displayed on. A Channel is defined as the entity that curates a content library, or stream within a brand name for viewers. Examples are specific view selectable ‘channels’ within linear and streaming television (MTV, HGTV, CNN, BBC One, etc) or a specific stream of audio content commonly called ‘stations.’ Name is a human-readable field while domain and id can be used for reporting and targeting purposes.
Field | Type | Status | Comment |
---|---|---|---|
id | String | Recommended | A unique identifier assigned by the publisher. This may not be a unique identifier across all supply sources |
name | String | Recommended | Channel the content is on (e.g., a local channel like “WABC-TV") |
domain | String | Recommended | The primary domain of the channel (e.g. “abc7ny.com” in the case of the local channel WABC-TV). It is recommended to include the top private domain (PSL+1) for DSP targeting normalization purposes |
User Object
Field | Type | Status | Comment |
---|---|---|---|
id | String | Recommended | The user’s ID (SSP wide) |
buyeruid | String | Recommended | The E-Planning’s user ID. See user matching section below for comments on how it is obtained |
...
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.
...