EXADS RTB Bid Request Specifications

Note: The EXADS RTB Bid Request is done using JSON for POST and a URL for GET.

Suggested 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

We allow two HTTP methods for requests: POST and GET.

Bid Request Object

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)*
sub	This should be a number between six and ten digits: Do not use zeroes at the beginning of Sub IDs.
export	Response type. Can be "json" or "xml" (string)*
keyword	Keywords can be used to ensure ad zones get the right type of advertising. Keywords should be a string of comma-separated words
size	Publisher ad type size (string)**
el	Base64 Encoded Email (string)***

* mandatory fields

** mandatory only for Banner

*** available only for RTB Direct Links and RTB Email Clicks

Bid request POST: JSON

Note: EXADS RTB 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",
    "sub": 1234,
    "export": "json",
    "keyword": "lifestyle, humour",
    "size": "300x250"
}

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",
    "sub": 4312,
    "export": "json",
    "keyword": "lifestyle, humour"
}

Push Notifications - 720 x 480: 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",
    "sub": 4312,
    "export": "json",
    "keyword": "lifestyle, humour",
    "size": "720x480"
}

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",
    "sub": 4312,
    "export": "json",
    "keyword": "lifestyle, humour",
    "size": "192x192"
}

In-Page Push Notifications: JSON

{
    "id": "5c2e180f3a1371d9256f6616c6792fb2c7a64772",
    "ip": "131.34.123.159",
    "language": "en",
    "type": "in_page_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",
    "sub": 1234,
    "export": "json",
    "keyword": "Adult"
}

Direct Link: JSON

{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "ip": "131.34.123.159",
    "language": "en",
    "type": "direct_link",
    "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",
    "sub": 4312,
    "export": "json",
    "keyword": "lifestyle, humour",
    "el": "dGVzdEBleGFkcy5jb20="
}

Bid request GET: URL

Banner: URL

https://rtb.{examplenetworkdomain}/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&sub=1234&export=json&keyword=lifestyle,humour&size=300x250

Email Clicks: URL

https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&type=email_click&keyword=lifestyle,humour&export=xml&ip=192.168.1.70&ua=Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36&user_id=1&el=dGVzdGVAZW1haWwuY29t

Popunder: URL

https://rtb.{examplenetworkdomain}/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&sub=4312&export=json&keyword=lifestyle,humour

Push Notifications 720 x 480: URL

https://rtb.{examplenetworkdomain}/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,humour&size=720x480

Push Notifications 192 x 192: URL

Here the size parameter may be omitted. It will just be assumed as 192x192 by default for backwards compatibility.

https://rtb.{examplenetworkdomain}/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,humour&size=192x192

In-Page Push Notifications: URL

http://rtb.{examplenetworkdomain}/rtb.php?idzone=5307609&fid=bd1110cd7802712c5f7abb146954fb89748c236b&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&ip=131.34.123.159&language=en&type=in_page_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,humour&size=192x192

Direct Link: URL

http://rtb.{examplenetworkdomain}/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=lifestyle,humour&export=xml&el=dGVzdGVAZW1haWwuY29t

Documentation

Open RTB

EXADS RTB