EXADS RTB Bid Response Specifications
Note: The EXADS RTB Bid Response is done using JSON and XML.
The response for a bid request will have the following structure:
Bid Response Object
Attribute | Description |
---|---|
id | ID of the impression object to which this bid applies (string) |
imgUrl | Image url (only for type banner) (string) |
iconUrl | Icon url (only for type push_notification and must be of requested dimensions) (string) |
clickUrl | Forward url when campaign is clicked (for type banner or push_notification) (string) |
nUrl | Win notification URL (string) |
url | Forward url when campaign is clicked (only for type popunder) (string) |
title | Title of the ad (only for type push_notification) (string) |
description | Description of the ad (only for type push_notification) (string) |
value | Bid price in CPM (float) |
btype | Pricing Model. Values: 1 = CPM, 2 = CPC. Default = 1 (int). Note: When response is for an Email Clicks zone request, 1 = Smart CPC. |
* Push Notification ad format may receive bids with the CPC pricing model. Direct Link format may also when used for Email Click zone requests.
Bid Response in JSON
Banner: JSON
{
"bid": {
"id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"imgUrl" : "http://mysite.com/images/myad.jpg",
"clickUrl" : "http://mysite.com/landingpages/mypage",
"nUrl": "http://network-domain.com/win-notification",
"btype": 1,
"value" : 12.34
}
}
Direct Link: JSON
{
"bid": {
"id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"url" : "http://mysite.com/landingpages/mypage",
"nUrl": "http://network-domain.com/win-notification",
"btype": 2,
"value" : 0
}
}
Email Clicks: JSON
{
"bid": {
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"clickUrl": "http://mysite.com/landingpages/mypage?el={email_encoded}",
"value": 0.07,
"btype": 2,
"nUrl": "https://mysite.com/my_notification_url"
}
}
Popunder: JSON
{
"bid": {
"id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"url" : "http://mysite.com/landingpages/mypage",
"nUrl": "http://network-domain.com/win-notification",
"btype": 1,
"value" : 21.13
}
}
Push Notifications: JSON
{
"bid": {
"id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"iconUrl" : "http://mysite.com/images/myadicon.jpg",
"clickUrl" : "http://mysite.com/landingpages/mypage",
"nUrl": "http://network-domain.com/win-notification",
"title": "My Ad Title",
"description": "My Ad Description Text",
"btype": 2,
"value" : 0.13
}
}
In-Page Push Notifications: JSON
{
"bid": {
"id": "5c2e180f3a1371d9256f6616c6792fb2c7a64772",
"value": 0.0035000000000000005,
"clickUrl": "http://mysite.com/landingpages/mypage",
"imgUrl": "http://mysite.com/images/myad.jpg",
"title": "Title",
"description": "Description",
"btype": 1,
"nUrl": "http://network-domain.com/win-notification"
}
}
Bid Response in XML
Banner: XML
<?xml version="1.0"?>
<result>
<bid>
<id>d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa</id>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage]]></clickUrl>
<imgUrl><![CDATA[http://mysite.com/images/myad.jpg]]></imgUrl>
<nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
<btype>1</btype>
<value>12.34</value>
</bid>
</result>
Direct Link: XML
<?xml version="1.0"?>
<result>
<bid>
<id><![CDATA[d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa]]></id>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage]]></clickUrl>
<value><![CDATA[0]]></value>
<btype><![CDATA[2]]></btype>
<nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
</bid>
</result>
Email Clicks: XML
<?xml version="1.0"?>
<result>
<bid>
<id>
<![CDATA[d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa]]>
</id>
<clickUrl>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage?el={email_encoded}]]></clickUrl>
</clickUrl>
<value>
<![CDATA[0.07]]>
</value>
<btype>
<![CDATA[2]]>
</btype>
<nUrl>
<![CDATA[https://mysite.com/my_notification_url]]>
</nUrl>
</bid>
</result>
Popunder Ads: XML
<?xml version="1.0"?>
<result>
<bid>
<id>d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa</id>
<url><![CDATA[http://mysite.com/landingpages/mypage]]></url>
<nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
<btype>1</btype>
<value>21.13</value>
</bid>
</result>
Push Notifications: XML
<?xml version="1.0"?>
<result>
<bid>
<id>d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa</id>
<iconUrl><![CDATA[http://mysite.com/images/myad.jpg]]></iconUrl>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage]]></clickUrl>
<nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
<title>My Ad Title</title>
<description>My Ad Description Text</description>
<btype>2</btype>
<value>0.13</value>
</bid>
</result>
No Bid Response
To answer a bid request without making an actual bid, an HTTP response code 204 "No Content" will be sent.
Win Notification
When the parameter Bid Response Object -> nUrl is in the bid response, a GET request must be performed to such URL.