Revisions history

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
1.2	In-App support. S2S integration. NativeAd support
1.3	Ads.txt recommendations

Basics

This document describes the process of integration of the new publishers into the platform. Direct inventory selling 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.
Registering and configuring the publisher tags in the platform.
Start calling dedicated URL(s) for the interested inventory types (video, etc.) with the special parameters settled.

After the publisher is already registered in the platform, you can start directly selling inventory. For that you ought to perform a special HTTP GET request with the appropriate parameters.

XMLHttpRequest.withCredentials is required. It is needed to detect known users on bid requests. Value must be "true".

Publisher Tags

One publisher can integrate multiple ad tags.

Tags settings may be preconfigured in the platform.

If tag is not configured in platform - it is a custom tag. In that case all required parameters must be provided in the URL

Ads.txt

To get high quality demand from the most careful Getintent buyers, it is highly recommended that publishers add the following lines to the ads.txt file on their domains or create this file on their domains if there is no such a file:

adhigh.net, [ID], RESELLER
getintent.com, [ID], RESELLER

Where [ID] must be replaced with the ID of the underlying publisher registered in the platform.

More details on Ads.txt can be found on the official IAB website

Banner inventory

URL: http(https)://px.adhigh.net/rtb/direct_banner?[params]

Response format: see resp_type parameter below

Base parameters

Name	Mandatory	Description	Example
pid	required	The ID of the underlying publisher, registered in the platform.	pid=4
tid	required	The ID of the publisher Tag (Preconfigured in the platform or custom)	tid=abc
size	required for custom tag	The size of the banner.	size=320x240
resp_type	optional	The type of the output: RAW (raw markup) JSON (json output with markup) JS (JavaScript registering variable with response data) Default: RAW	resp_type=JS
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

Web inventory

Name	Mandatory	Description	Example
sid	optional	The ID of the publisher web site.	sid=xyz
url	optional required for Server to Server integrations required when Referer header doesn't provide valid page url	Url of the page.	url=google.com

In-App inventory

Name	Mandatory	Description	Example
app_bundle	required	The ID of the application (bundle id)	app_bundle=495583717 app_bundle=com.example.android
app_name	optional	The name of the application	app_name=My%20Application
app_storeurl	optional	The store url of the application	app_storeurl=https%3A%2F%2Fitunes.apple.com%2Fru%2Fapp%2Finstagram%2Fid389801252%3Fmt%3D8
app_cat	optional	The category of the application (IAB terminology)	app_cat=IAB12
device_type	optional	Device Type: 1 - Mobile/Tablet 2 - Personal Computer 3 - Connected TV 4 - Phone 5 - Tablet 6 - Connected Device 7 - Set Top Box	device_type=4
device_make	optional	Device Manufacturer	device_make=Apple
device_model	optional	Device Model	device_model=iPhone
device_ifa	required	Device Advertising ID	device_ifa=8FCDB488-8814-46A8-A485-003DAB51E1DE

Server to Server integration

Name	Mandatory	Description	Example
ip	required	The IP address of user device.	ip=123.12.12.121
ua	required	The User-Agent of user device.	ua=Mozilla%2F5.0%20(X11%3B%20Linux%20x86_64%3B%20rv%3A63.0)%20Gecko%2F20100101%20Firefox%2F63.0
url	required for Web inventory	Url of the page	url=google.com

Video inventory

URL: http(https)://px.adhigh.net/rtb/direct_vast?[params]

Response format: VAST XML

Base parameters

Name	Mandatory	Description	Example
pid	required	The ID of the underlying publisher, registered in the platform.	pid=4
tid	required	The ID of the publisher Tag (Preconfigured in the platform or custom)	tid=abc
protocols	optional	The numeric list of the restricted VAST protocol versions, split by comma. 1 – VAST 1.0 2 – VAST 2.0 3 – VAST 3.0 4 – VAST 1.0 Wrapper 5 – VAST 2.0 Wrapper 6 – VAST 3.0 Wrapper Unless provided, it will match all versions of the VAST protocol.	protocols=2,3,5,6
size	optional	The size of the player. Unless provided, the size will be taken from the Tag configuration in the platform, if set.	size=640x480
mimes	optional*	The list allowed mime types, split by comma. Unless provided, the system will try to fill it with the list of mime types in the Tag configuration in the platform. Unless, it will match any mime type.	mimes=application%2Fjavascript,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. Unless provided, the system will try to take it from the Publisher configuration. Unless, an empty VAST response will be served.	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
skippable	optional	Skippability of the inventory. Possible values (case insensitive): ALLOW - skippable inventory is allowed NOT_ALLOW - skippable inventory is not allowed REQUIRE - only skippable inventory is allowed UNKNOWN - skippability is unknown (default value)	skippable=allow

Web inventory

Name	Mandatory	Description	Example
sid	optional	The ID of the publisher web site.	sid=xyz
url	optional required for Server to Server integrations required when Referer header doesn't provide valid page url	Url of the page.	url=google.com

In-App inventory

Name	Mandatory	Description	Example
app_bundle	required	The ID of the application (bundle id)	app_bundle=495583717 app_bundle=com.example.android
app_name	optional	The name of the application	app_name=My%20Application
app_storeurl	optional	The store url of the application	app_storeurl=https%3A%2F%2Fitunes.apple.com%2Fru%2Fapp%2Finstagram%2Fid389801252%3Fmt%3D8
app_cat	optional	The category of the application (IAB terminology)	app_cat=IAB12
device_type	optional	Device Type: 1 - Mobile/Tablet 2 - Personal Computer 3 - Connected TV 4 - Phone 5 - Tablet 6 - Connected Device 7 - Set Top Box	device_type=4
device_make	optional	Device Manufacturer	device_make=Apple
device_model	optional	Device Model	device_model=iPhone
device_ifa	required	Device Advertising ID	device_ifa=8FCDB488-8814-46A8-A485-003DAB51E1DE

Server to Server integration

Name	Mandatory	Description	Example
ip	required	The IP address of user device.	ip=123.12.12.121
ua	required	The User-Agent of user device.	ua=Mozilla%2F5.0%20(X11%3B%20Linux%20x86_64%3B%20rv%3A63.0)%20Gecko%2F20100101%20Firefox%2F63.0
url	required for Web inventory	Url of the page	url=google.com

Video Examples

No inventory matches, no passback url:

<?xml version="1.0" encoding="utf-8"?><VAST version="2.0"></VAST>

No inventory matches, with passback url: http://ad.content.vast/passback :

<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 video ad:

<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>

Native inventory

URL: http(https)://px.adhigh.net/rtb/direct_native?[params]

Response format: JSON native object as in: OpenRTB Native Ads Specification v1.1 (See example below)

Base parameters

Name	Mandatory	Description	Example
pid	required	The ID of the underlying publisher, registered in the platform.	pid=4
tid	required	The ID of the publisher Tag	tid=abc

Web inventory

Name	Mandatory	Description	Example
sid	optional	The ID of the publisher web site.	sid=xyz
url	optional required for Server to Server integrations required when Referer header doesn't provide valid page url	Url of the page.	url=google.com

In-App inventory

Name	Mandatory	Description	Example
app_bundle	required	The ID of the application (bundle id)	app_bundle=495583717 app_bundle=com.example.android
app_name	optional	The name of the application	app_name=My%20Application
app_storeurl	optional	The store url of the application	app_storeurl=https%3A%2F%2Fitunes.apple.com%2Fru%2Fapp%2Finstagram%2Fid389801252%3Fmt%3D8
app_cat	optional	The category of the application (IAB terminology)	app_cat=IAB12
device_type	optional	Device Type: 1 - Mobile/Tablet 2 - Personal Computer 3 - Connected TV 4 - Phone 5 - Tablet 6 - Connected Device 7 - Set Top Box	device_type=4
device_make	optional	Device Manufacturer	device_make=Apple
device_model	optional	Device Model	device_model=iPhone
device_ifa	required	Device Advertising ID	device_ifa=8FCDB488-8814-46A8-A485-003DAB51E1DE

Server to Server integration

Name	Mandatory	Description	Example
ip	required	The IP address of user device.	ip=123.12.12.121
ua	required	The User-Agent of user device.	ua=Mozilla%2F5.0%20(X11%3B%20Linux%20x86_64%3B%20rv%3A63.0)%20Gecko%2F20100101%20Firefox%2F63.0
url	required for Web inventory	Url of the page	url=google.com

Native Examples

No inventory matches:

{ }

Response with NativeAd:

{
  "link": {
    "url": "https://f41-de.adhigh.net/p/click/f111448f120090a6direct04fom2000000000000lggvjjpdonnvam2rb/",
    "clicktrackers": []
  },
  "imptrackers": [
    "https://f41-de.adhigh.net/p/imp.gif?id=PiystpdevHH&s=direct&url=&b=f111448f120090a6direct04fom2000000000000lggvjjpdonnvam2rb0&w=100.0"
  ],
  "assets": [
    {
      "id": 1,
      "title": {
        "text": "Learn about this awesome thing"
      }
    },
    {
      "id": 2,
      "img": {
        "url": "https://cdn.adhigh.net/media/ad.jpg",
        "w": 300,
        "h": 250
      }
    }
  ]
}

Table of Contents

Revisions history

Basics

Publisher Tags

Ads.txt

Banner inventory

Base parameters

Web inventory

In-App inventory

Server to Server integration

Video inventory

Base parameters

Web inventory

In-App inventory

Server to Server integration

Video Examples

No inventory matches, no passback url:

No inventory matches, with passback url: http://ad.content.vast/passback :

Response with video ad:

Native inventory

Base parameters

Web inventory

In-App inventory

Server to Server integration

Native Examples

No inventory matches:

Response with NativeAd: