...
Revision | Changes |
1.0 | Initial version |
| 1.0.1 | "url" field added |
| 1.0.2 | "vi_format" field added |
| 1.0.3 | "api" field added |
| 1.1 | Banner support. |
Basics
This document describes the process of integration of the new publishers into the platform. Direct inventory buying is typically achieved by calling dedicated URL, provided by the platform, with a set of special parameters, which allows to narrowly target the inventory. Before that, the publisher should be registered in the platform and receive its unique ID. The workflow of the integration process consists of next steps:
- Registering and configuring the publisher in the platform.
- Start calling dedicated URL(s) for the interested inventory types (video, etc.) with the special parameters settled.
Video inventory
After the publisher is already registered in the platform, you can start directly buying banner/video inventory. For that you ought to perform a special HTTP GET request with the appropriate parameters.
Banner inventory
URL: http(https)://px.adhigh.net/rtb/direct_banner?[params]
Available parameters:
| Name | Mandatory | Description | Example |
|---|---|---|---|
| pid | required | The ID of the underlying publisher, registered in the platform. | pid=7 |
| tid | required | The ID of the publisher Tag. | tid=abc |
| size | required | The size of the banner. | size=320x240 |
| resp_type | optional | The type of the output:
Default: RAW | resp_type=JS |
| floor | optional | Floor price for the advertiser bids. | floor=1.13 |
| cpm | optional | The CPM price in the currency of the Publisher. Unless provided, the price will be taken from special Tag configuration. Unless, it will be taken from Publisher configuration. Unless the CPM will be equal to the bid, made by the advertiser. | cpm=5.3 |
| cur | optional | Bid currency. Unless provided, will be taken from the Publisher configuration. | cur=USD |
| url | optional | Url of the page. | url=google.com |
| pburl | optional | Passback URL. After an empty bid or error, request will be redirected to this page. Unless provided, will be taken from the Publisher configuration. | pburl=anotheradserver.com |
Video inventory
URL: http(https)://px.adhigh.net/p/direct_vast?[params]
See the list of the available parameters belowAvailable parameters:
Name | Mandatory | Description | Example |
pid | required | The ID of the underlying publisher registered in the platform. | pid=5 |
cpm | optional | The CPM price in the currency of the Publisher. Unless provided, the price will be taken from special Tag configuration. Unless, it will be taken from Publisher configuration. | cpm=1.30412 |
tid | optional | The ID of the publisher Tag. | tid=A1415154ECB |
| url | optional | Url of the page. | url=search.google.com |
protocols | optional | The numeric list of the restricted VAST protocol versions, split by comma.
| protocols=2,3,5,6 |
size | optional | The size of the player. | size=640x480 |
mimes | optional | The list of URL-encoded allowed mime types, split by comma. | mimes=application%2Fx-shockwave-player,video%2Fmp4 |
min_dur | optional | Minimal duration of video ad in seconds. | min_dur=30 |
max_dur | optional | Maximal duration of the video ad in seconds. | max_dur=60 |
min_btr | optional | Minimal bitrate of the video ad, kbps. | min_btr=128 |
max_btr | optional | Maximal bitrate of the video ad, kbps. | max_btr=512 |
pb | optional | Passback VAST URL, which will be returned in the VAST Wrapper in case no inventory is matched for the given request. | pb=http%3A%2F%2Fad.content.vast%2Fpassback |
| vi_format | optional | Video inventory format. Possible values: 1 - In-Stream video 2 - Out-Stream video Unless provided or directly set in publisher tag configuration in the platform, an inventory is marked as In-Stream. | vi_format=2 |
| api | optional | API of the inventory. Possible values: 1 - VPAID 1.0 2 - VPAID 2.0 3 - MRAID-1 4 - ORMMA 5 - MRAID-2 | api=1,3 |
Video Examples
No inventory matches, no passback url
...