EXADS RTB Bid Request Specifications
Note: The EXADS RTB Bid Request is done using JSON for POST.
Bid Request Headers
- EXADS RTB Version HTTP Header: x-exadsrtb-version: 1.0
- Keep-Alive HTTP Header: Connection: Keep-Alive
- Content JSON: Content-Type: application/json
- Data Encoding Header: Accept-Encoding
Bid Request Object
We allow one HTTP method for requests: POST.
When requesting bids for a specific context, the platform will perform an HTTP request with a timeout of 300ms. It will send the following object encoded as JSON in the request body as POST:
Attribute | Description |
---|---|
id | Unique bid request ID (string)* |
ip | IP address of the user (string)* |
language | Browser language using ISO-639-1-alpha-2 (string)* |
remote_addr | Main IP address of the user (string) |
x_forwarded_for | X-FORWARDED-FOR IP address of the user or empty if not set (string) |
type | Request type. Can be "banner", "popunder" or "push_notification" (string)* |
ua | Browser user agent (string)* |
url | Full URL of the page where the ad will be shown (string)* |
user_id | Unique user ID (string)* |
export | Response type. Can be "json" or "xml" (string)* |
keyword | keyword (string) |
size | Publisher ad type size (string)** |
sub | The sub will be an integer number representing the ID of the zone where the request was originated from |
* mandatory fields
** mandatory only for type banner
Bid request POST: JSON
Note: EXADS POST Bid requests are done using JSON only, so there are no XML examples below.
Banner: JSON
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "banner",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"export": "json",
"keyword": "Lifestyle",
"size": "300x250",
"sub": 445566
}
Popunder: JSON
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "popunder",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"export": "json",
"keyword": "Lifestyle",
"sub": 445566
}
Push Notifications 720x480: JSON
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "push_notification",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"export": "json",
"keyword": "Lifestyle",
"size": "720x480",
"sub": 445566
}
Push Notifications 192 x 192: JSON
Here size parameter may be omitted. It will just be assumed as 192x192 by default for backwards compatibility.
{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "push_notification",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"export": "json",
"keyword": "Lifestyle",
"size": "192x192",
"sub": 445566
}