Open RTB Advertiser Request and Response Examples
Open RTB Advertiser Request
Banner
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"at":1,
"imp": [
{
"id": "974090632",
"instl": 0,
"banner": {
"w": 300,
"h": 250
},
"bidfloor": 0.5,
"bidfloorcur": "USD",
"secure": 1
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "131.34.123.159",
"geo": {
"country": "IRL"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "131.34.123.159",
"x_forwarded_for": "",
"accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 445566
}
}
Direct Links
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"imp": [
{
"id": "974090632",
"instl": 0,
"el": "dGVzdGVAZW1haWwuY29t"
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "192.168.1.70",
"geo": {
"country": "PRT"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "192.168.1.70",
"x_forwarded_for": "192.168.1.70"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 1221
}
}
Email Clicks
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"imp": [
{
"id": "974090632",
"instl": 0,
"el": "dGVzdGVAZW1haWwuY29t"
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "192.168.1.70",
"geo": {
"country": "PRT"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "192.168.1.70",
"x_forwarded_for": "192.168.1.70"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 445566
}
}
Fullpage Interstitial (Mobile and Desktop)
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"at":1,
"imp": [
{
"id": "974090632",
"instl": 1
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "120.52.73.97",
"geo": {
"country": "IRL"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 445566
}
}
In-Stream
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"at":1,
"imp": [
{
"id": "974090632",
"video": {
"mimes": [
"video/mp4"
],
"protocols": [
3,
6
],
"linearity": 1,
"boxingallowed": 1
},
"bidfloor": 0.5,
"bidfloorcur": "USD",
"secure": 1
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "131.34.123.159",
"geo": {
"country": "IRL"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "131.34.123.159",
"x_forwarded_for": "",
"accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 445566
}
}
Native
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"at":1,
"imp": [
{
"id": "90180978",
"native": {
"request":"{\"native\":{\"ver\":\"1.2\",\"context\":1,\"plcmttype\":4,\"plcmtcnt\":3,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":3,\"wmin\":100,\"hmin\":100}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}}]}}",
"ver": "1.2"
},
"secure": 1
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "131.34.123.159",
"geo": {
"country": "IRL"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "131.34.123.159",
"x_forwarded_for": "",
"accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 445566
}
}
Popunder
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"at":1,
"imp": [
{
"id": "974090632",
"instl": 1,
"bidfloor": 0.5,
"bidfloorcur": "USD",
"secure": 1
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "120.52.73.97",
"geo": {
"country": "IRL"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 445566
}
}
Push Notifications - 720 x 480
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"at":1,
"imp": [
{
"id": "90180978",
"native": {
"request":"{\"native\":{\"ver\":\"1.2\",\"plcmttype\":500,\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":1,\"w\":720,\"h\":480,\"wmin\":720,\"hmin\":480}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}}]}}",
"ver": "1.2"
},
"secure": 1
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "131.34.123.159",
"geo": {
"country": "IRL"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "131.34.123.159",
"x_forwarded_for": "",
"accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 445566
}
}
Push Notifications - 192 x 192
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"at":1,
"imp": [
{
"id": "90180978",
"native": {
"request":"{\"native\":{\"ver\":\"1.2\",\"plcmttype\":500,\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":1,\"w\":192,\"h\":192,\"wmin\":192,\"hmin\":192}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}}]}}",
"ver": "1.2"
},
"secure": 1
}
],
"site": {
"id": "12345",
"domain": "sitedomain.com",
"cat": ["IAB25-3"],
"page": "https://sitedomain.com/page",
"keyword": "lifestyle",
"ext": {
"exchangecat": 508,
"idzone": 445566
}
},
"device": {
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
"ip": "131.34.123.159",
"geo": {
"country": "IRL"
},
"language": "en",
"os": "Linux & UNIX",
"js": 0,
"ext": {
"remote_addr": "131.34.123.159",
"x_forwarded_for": "",
"accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
}
},
"user": {
"id": "57592f333f8983.043587162282415065"
},
"ext": {
"sub": 445566
}
}
Open RTB Advertiser Response
Banner / iFrame / Popunder / In-Stream / Push Notifications JSON
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"seatbid": [{
"bid": [{
"id": "12ab3d",
"impid": "90180978",
"price": 0.55,
"adm": "<ExoClick_XML_OR_JSON_AD_MARKUP>",
"nurl": "https://mysite.com/my_notification_url",
"burl": "https://mysite.com/my_billing_notification_url",
"ext": {
"btype": 1
}
}]
}]
}
Direct Links JSON
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"bidid": 123,
"seatbid": [{
"bid": [{
"id": "12ab3d",
"adid": 1,
"impid": "90180978",
"price": 0.12,
"adm": "<ExoClick_XML_AD_MARKUP>",
"nurl": "https://mysite.com/my_notification_url",
"burl": "https://mysite.com/my_billing_notification_url",
"ext":{
"btype": 2
}
}]
}]
}
Email Clicks JSON
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"bidid": 123,
"seatbid": [{
"bid": [{
"id": "12ab3d",
"adid": 1,
"impid": "90180978",
"price": 0.12,
"adm": "<ExoClick_XML_AD_MARKUP>",
"nurl": "https://mysite.com/my_notification_url",
"burl": "https://mysite.com/my_billing_notification_url",
"ext":{
"btype": 2
}
}]
}]
}
Fullpage Interstitial (Mobile and Desktop) JSON
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"seatbid": [{
"bid": [{
"id": "12ab3d",
"impid": "90180978",
"price": 0.55,
"adm": "<ExoClick_XML_OR_JSON_AD_MARKUP>",
"nurl": "http://mysite.com/win-notification",
"burl": "https://mysite.com/my_billing_notification_url",
"ext": {
"btype": 1
}
}]
}]
}
Native JSON
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"seatbid": [
{
"bid": [
{
"id": "12ab3d",
"impid": "90180978",
"price": 0.71,
"nurl": "https://mysite.com/my_notification_url",
"burl": "https://mysite.com/my_billing_notification_url",
"adm": "<ExoClick_JSON_AD_MARKUP_1>",
"ext": {
"btype": 1
}
}
]
},
{
"bid": [
{
"id": "12ab3e",
"impid": "1915966848",
"price": 0.62,
"nurl": "https://mysite.com/my_notification_url_2",
"burl": "https://mysite.com/my_billing_notification_url",
"adm": "<ExoClick_JSON_AD_MARKUP_2>",
"ext": {
"btype": 1
}
}
]
}
]
}
ADM structure examples
Banner ADM
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
<imageAd>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage]]></clickUrl>
<imgUrl><![CDATA[http://mysite.com/images/myad.jpg]]></imgUrl>
</imageAd>
</ad>
Direct Links ADM
<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
<ad>
<emailClick>
<url><![CDATA[https://mysite.com/landingpages?el={email_encoded}]]></url>
</emailClick>
</ad>
Email Clicks ADM
<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
<ad>
<emailClick>
<url><![CDATA[https://mysite.com/landingpages?el={email_encoded}]]></url>
</emailClick>
</ad>
Iframe HTML Banner ADM
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
<iframeAd>
<url><![CDATA[http://mysite.com/iframe_url]]></url>
</iframeAd>
</ad>
Fullpage Interstitial Iframe (Mobile and Desktop) ADM
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
<iframeAd>
<url><![CDATA[http://mysite.com/landingpages/mypage]]></url>
</iframeAd>
</ad>
Fullpage Interstitial Banner (Mobile and Desktop) ADM
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
<imageAd>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage]]></clickUrl>
<imgUrl><![CDATA[http://mysite.com/images/myad.jpg]]></imgUrl>
</imageAd>
</ad>
Popunder ADM
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
<popunderAd>
<url><![CDATA[http://mysite.com/landingpages/mypage]]></url>
</popunderAd>
</ad>
In-Stream Ads ADM
- Remote VAST
{\"instream\":{\"remoteUrl\":\"https:\/\/mysite.com\/vasturl\"}}
Based on the following JSON object:
{
"instream": {
"remoteUrl": "https://mysite.com/vasturl"
}
}
- Local VAST
{\"instream\":{\"videoUrl\":\"https:\/\/mysite.com\/video.mp4\",\"clickUrl\":\"https:\/\/mysite.com\/clickurl\",\"trackingEvents\":[{\"type\":\"impression\",\"url\":\"https:\/\/mysite.com\/impression\"},{\"type\":\"complete\",\"url\":\"https:\/\/mysite.com\/complete\"},{\"type\":\"progress\",\"offset\":\"00:00:10.000\",\"url\":\"https:\/\/mysite.com\/progress10secs\"}],\"cta\":{\"displayUrl\":\"somedomain.com\",\"text\":\"Click Here\"}}}}}
Based on the following JSON object:
{
"instream": {
"videoUrl": "https://mysite.com/video.mp4",
"clickUrl": "https://mysite.com/clickurl",
"trackingEvents": [
{
"type": "impression",
"url": "https://mysite.com/impression"
},
{
"type": "complete",
"url": "https://mysite.com/complete"
},
{
"type": "progress",
"offset": "00:00:10.000",
"url": "https://mysite.com/progress10secs"
}
],
"cta": {
"displayUrl": "somedomain.com",
"text": "Click Here"
}
}
}
Native Ads ADM
{\"native\":{\"link\":{\"url\":\"http:\/\/mysite.com\/landingpages\/mypage\"},\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"url\":\"http:\/\/mysite.com\/images\/myad.jpg\",\"w\":300,\"h\":300,\"ext\":{\"crop_anchor_point\":1}}},{\"id\":2,\"title\":{\"text\":\"Ad Title\"}},{\"id\":3,\"data\":{\"type\":2,\"value\":\"Ad description\"}},{\"id\":4,\"data\":{\"type\":1,\"value\":\"Ad brand\"}}],\"imptrackers\":[\"https://mytracker1.com\"],\"eventtrackers\":[{\"event\":1,\"method\":1,\"url\":\"https://myEventTracker1.com\"}]}}
Which is based on the following JSON object:
{
"native": {
"link": {
"url": "http://mysite.com/landingpages/mypage"
},
"assets": [
{
"id": 1,
"required": 1,
"img": {
"url": "http://mysite.com/images/myad.jpg",
"w": 300,
"h": 300,
"ext": {
"crop_anchor_point": 1
}
}
},
{
"id": 2,
"title": {
"text": "Ad Title"
}
},
{
"id": 3,
"data": {
"type": 2,
"value": "Ad description"
}
},
{
"id": 4,
"data": {
"type": 1,
"value": "Ad brand"
}
}
],
"imptrackers": [
"https://mytracker1.com"
],
"eventtrackers": [
{
"event": 1,
"method": 1,
"url": "https://myEventTracker1.com"
}
]
}
}
Push Notification ADM
{\"native\":{\"link\":{\"url\":\"http:\/\/mysite.com\/landingpages\/mypage\"},\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"url\":\"http:\/\/mysite.com\/images\/myad.jpg\",\"w\":720,\"h\":480}},{\"id\":2,\"title\":{\"text\":\"Ad Title\"}},{\"id\":3,\"data\":{\"type\":2,\"value\":\"Ad description\"}}],\"imptrackers\":[\"https://mytracker1.com\"]}}
Which is based on the following JSON object:
{
"native": {
"link": {
"url": "http://mysite.com/landingpages/mypage"
},
"assets": [
{
"id": 1,
"required": 1,
"img": {
"url": "http://mysite.com/images/myad.jpg",
"w": 720,
"h": 480
}
},
{
"id": 2,
"title": {
"text": "Ad Title"
}
},
{
"id": 3,
"data": {
"type": 2,
"value": "Ad description"
}
}
],
"imptrackers": [
"https://mytracker1.com"
]
}
}