...
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:
...
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.
...
If tag is not configured in platform - it is a custom tag. In that case all required parameters must be provided in the URL
Banner inventory
URL: http(https)://px.adhigh.net/rtb/direct_banner?[params]
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
Creative code (aka JS tag) for adservers
Code to integrate with adserver's:
| Блок кода | ||
|---|---|---|
| ||
<script src="https://px.adhigh.net/rtb/direct_banner?pid={pid}&tid={tid}&size={size}&resp_type=dw"></script> |
See parameters descruption below.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:
Default: RAW | resp_type=JSDW |
| 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 |
...
| 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 | 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 |
Passback Code
Each tag may be configured with pass back html code that will be served by Getintent direct banner tag in cases of missing demand from Getintent platform.
Passback code works only with resp_type=DW parameter.
Server to Server integration
...
URL: http(https)://px.adhigh.net/prtb/direct_vast?[params]
Response format: VAST XML
...
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.
Unless provided, it will match all versions of the VAST protocol. | protocols=2,3,5,6 | ||||||
size | optional | The size of the player. | size=640x480 | ||||||
mimes | optional* |
The list allowed mime types, split by comma. | 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. | pb=http%3A%2F%2Fad.content.vast%2Fpassback | ||||||
| vi_format | optional | Video inventory format. Possible values:
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:
| api=1,3 | ||||||
| skippable | optional | Skippability of the inventory. Possible values (case insensitive):
| 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 | 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:
...
URL: http(https)://px.adhigh.net/prtb/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 | 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
}
}
]
} |