EXADS RTB Bid Request Specifications
Note: The EXADS RTB Bid Request is done using JSON for POST and a URL for GET.
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 two HTTP methods for requests: POST and GET.
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 and can also send the same parameters through GET:
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
}
Bid Request GET: URL
Banner: URL
https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id={imp_id}&url={url}&ua={user_agent}&ip={user_ip}&remote_addr={user_remote_addr_ip}&x_forwarded_for={user_x_forwarded_for_ip}&keyword={keyword}&language={language}&user_id={user_id}&sub={sub}&export=json&type=banner&size={format}
https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&ip=131.34.123.159&language=en&type=banner&remote_addr=131.34.123.159&ua=Mozilla/5.0%20(X11;%20Linux%20x86_64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/66.0.3359.139%20Safari/537.36&url=https://sitedomain.com/page&user_id=57592f333f8983.043587162282415065&export=json&keyword=Lifestyle&size=300x250
Direct Link: URL
https://rtb.{networkdomain}/rtb.php?idzone=3206099&fid=326d931254f7552d8f3b80cf34e9e09a2924867c&id={imp_id}&url={url}&ua={user_agent}&ip={user_ip}&remote_addr={user_remote_addr_ip}&x_forwarded_for={user_x_forwarded_for_ip}&keyword={keyword}&language={language}&user_id={user_id}&sub={sub}&export=json&type=direct_link&el={email_encoded}
http://rtb.{networkdomain}/rtb.php?idzone=3206099&fid=326d931254f7552d8f3b80cf34e9e09a2924867c&ua=Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36&ip=131.34.123.159&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&type=direct_link&keyword=1&export=xml&el=dGVzdGVAZW1haWwuY29t
Email Clicks: URL
https://rtb.{networkdomain}/rtb.php?idzone=3945011&fid=94b2faee46aa326369b626ef753083231b3c8e6c&id={imp_id}&url={url}&ua={user_agent}&ip={user_ip}&remote_addr={user_remote_addr_ip}&x_forwarded_for={user_x_forwarded_for_ip}&keyword={keyword}&language={language}&user_id={user_id}&sub={sub}&export=json&type=email_click&el={email_encoded}
https://syndication.exads.rocks/rtb.php?idzone=3945011&fid=94b2faee46aa326369b626ef753083231b3c8e6c&ua=Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&type=email_click&keyword=1&export=xml&ip=192.168.1.70&el=dGVzdGVAZW1haWwuY29t
Popunder: URL
https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id={imp_id}&url={url}&ua={user_agent}&ip={user_ip}&remote_addr={user_remote_addr_ip}&x_forwarded_for={user_x_forwarded_for_ip}&keyword={keyword}&language={language}&user_id={user_id}&sub={sub}&export=json&type=popunder
https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&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%20(X11;%20Linux%20x86_64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/66.0.3359.139%20Safari/537.36&url=https://sitedomain.com/page&user_id=57592f333f8983.043587162282415065&export=json&keyword=Lifestyle
Push Notifications - 720 x 480: URL
https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id={imp_id}&url={url}&ua={user_agent}&ip={user_ip}&remote_addr={user_remote_addr_ip}&x_forwarded_for={user_x_forwarded_for_ip}&keyword={keyword}&language={language}&user_id={user_id}&sub={sub}&export=json&type=push_notification&size={format}
https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&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%20(X11;%20Linux%20x86_64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/66.0.3359.139%20Safari/537.36&url=https://sitedomain.com/page&user_id=57592f333f8983.043587162282415065&sub=4312&export=json&keyword=Lifestyle&size=720x480
Push Notifications - 192 x 192: URL
Here size parameter may be omitted. It will just be assumed as 192x192 by default for backwards compatibility.
https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id={imp_id}&url={url}&ua={user_agent}&ip={user_ip}&remote_addr={user_remote_addr_ip}&x_forwarded_for={user_x_forwarded_for_ip}&keyword={keyword}&language={language}&user_id={user_id}&sub={sub}&export=json&type=push_notification&size=192x192
https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&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%20(X11;%20Linux%20x86_64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/66.0.3359.139%20Safari/537.36&url=https://sitedomain.com/page&user_id=57592f333f8983.043587162282415065&sub=4312&export=json&keyword=Lifestyle&size=192x192