Publisher Integration Documentation
Revisions history
Revision | Changes |
1.0 | Initial version |
...
After the publisher is already registered in the platform, you can start directly buying video inventory. For that you ought to perform a special HTTP GET request with the appropriate parameters:
http://px.adhigh.net/p/direct_vast?\[params\]anchor
See the list of the available parameters below:
Name | Mandatory | Description | Example |
pid | required | The ID of the underlying publisher registered in the platform. | pid=5 |
сpm | required | The CPM price in the currency of the Publisher. | cpm=1.30412 |
tid | optional | The ID of the publisher Tag. | tag=A1415154ECB |
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 |
...
Request: curl –i http://px.adhigh.net/p/direct_vast?pid=5&cpm=1.34&size=1024x768
Response:
| Блок кода | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?><VAST version="2.0"></VAST> |
...
No inventory matches, with passback url
Request: curl –i http://px.adhigh.net/p/direct_vast?pid=5&cpm=1.34&size=1024x768&pb=http%3A%2F%2Fad.content.vast%2Fpassback
Response:
| Блок кода | ||||
|---|---|---|---|---|
| ||||
<VAST version="2.0"> |
...
<Ad id="sqq1Ctjm8IR"> |
...
<Wrapper> |
...
<AdSystem>GetIntent</AdSystem> |
...
<VASTAdTagURI><![CDATA[http://ad.content.vast/passback]]></VASTAdTagURI> |
...
<Creatives/> |
...
</Wrapper> |
...
</Ad> |
...
</VAST> |
...
Response with media files
Request: curl –i http://px.adhigh.net/p/direct_vast?pid=5&tid=abc&cpm=1.34&size=328x434
Response:
| Блок кода | ||||
|---|---|---|---|---|
| ||||
<VAST version="3.0"> |
...
<Ad id="ew8YhEBzR7p"> |
...
<InLine> |
...
<AdSystem>GetIntent</AdSystem> |
...
<AdTitle>GetIntent</AdTitle> |
...
<Error>http://ad.server.com/test-app/p/video/error.gif?s=direct&code=\[ERRORCODE\]</Error> |
...
<Impression><![CDATA[http://ad.server.com/test-app/p/video/imp.gif?id=ew8YhEBzR7p&s=direct]]></Impression> |
...
<Creatives> |
...
<Creative> |
...
<Linear> |
...
<Duration>00:00:20</Duration> |
...
<MediaFiles> |
...
<MediaFile delivery="progressive" type="video/mp4" width="1280" height="1024"><![CDATA[http://d7y63ze08grg5.cloudfront.net/media/video/test.mp4]]></MediaFile> |
...
</MediaFiles> |
...
<TrackingEvents> |
...
<Tracking event="start"><![CDATA[http://ad.server.com/test-app/p/video/tracking.gif?s=direct&e=start]]></Tracking> |
...
<Tracking event="firstQuartile"><![CDATA[http://ad.server.com/test-app/p/video/tracking.gif?s=direct&e=firstQuartile]]></Tracking> |
...
<Tracking event="midpoint"><![CDATA[http://ad.server.com/test-app/p/video/tracking.gif?s=direct&e=midpoint]]></Tracking> |
...
<Tracking event="thirdQuartile"><![CDATA[http://ad.server.com/test-app/p/video/tracking.gif?s=direct&e=thirdQuartile]]></Tracking> |
...
<Tracking event="complete"><![CDATA[http://ad.server.com/test-app/p/video/tracking.gif?s=direct&e=complete]]></Tracking> |
...
<Tracking event="skip"><![CDATA[http://ad.server.com/test-app/p/video/tracking.gif?s=direct&e=skip]]></Tracking> |
...
<Tracking event="closeLinear"><![CDATA[http://ad.server.com/test-app/p/video/tracking.gif?s=direct&e=closeLinear]]></Tracking> |
...
</TrackingEvents> |
...
<VideoClicks> |
...
<ClickThrough><![CDATA[http://ad.server.com/test-app/p/click?id=ew8YhEBzR7p&s=direct]]></ClickThrough> |
...
</VideoClicks> |
...
</Linear> |
...
</Creative> |
...
</Creatives> |
...
</InLine> |
...
</Ad> |
...
</VAST> |