...
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:
...
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
}
}
]
} |