Browse the documentation

Generic RTB — XML

Hosts: {rtb_domain} is your network's RTB domain, used by the bidder endpoints; a network without a dedicated RTB domain uses its ad domain there. {ad_domain} is the network's ad-serving domain. Inside the panel both are filled in for you.

XML-flavoured request/response for integrations that prefer XML. Same fields as the JSON shape, different envelope. Served from the same /rtb/run.go endpoint — the SSP campaign config decides whether the response is JSON or XML.

Endpoint#

GET request to https://{rtb_domain}/rtb/run.go with the placement parameters as query string. token is the SSP campaign token (required). Without it the endpoint returns 406 No Token found. Same path as every other protocol — feed settings drive the response shape.

Standard request

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}

Banner — with size

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}&w=300&h=250

Push — with subscription age

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}&subage=10

Mail clicks — with email

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}&email={recipient_email}

Full — every supported param

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}&email={recipient_email}&w={width}&h={height}&subage={days}&subage_dt={yyyy-mm-dd}&subage_ts={unix_ts}&bidfloor={floor_cpm}&keywords={comma_separated_kw}

Query parameters#

Reference

token       SSP campaign token (required)
ip          Client IP                                 e.g. 8.8.8.8
ua          User agent string                         e.g. Mozilla/5.0 …
subid       Pass-through sub-id for tracking          (optional)
ref         Referrer / site URL                       e.g. https://site.com/page
ln          Language code                             e.g. en, nl, de
email       Recipient email (mail-click traffic only)
w, h        Banner dimensions in pixels
subage      Push: subscription age in days
subage_dt   Push: subscription date (YYYY-MM-DD)
subage_ts   Push: subscription unix timestamp
bidfloor    Override the campaign's bid floor (CPM)
keywords    Comma-separated targeting keywords

Listing forms#

Listing — flat attributes

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <listing
    title="Example Title"
    descr="Example Description"
    bid="0.002000"
    url="url_to_follow"
    icon="url_to_icon"
    image="url_to_image" />
</result>

Listing — nested bid

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <bid>
    <id></id>
    <iconUrl><![CDATA[url_to_icon]]></iconUrl>
    <imageUrl><![CDATA[url_to_image]]></imageUrl>
    <title><![CDATA[Example Title]]></title>
    <description><![CDATA[Example Description]]></description>
    <url><![CDATA[url_to_follow]]></url>
    <price>0.002000</price>
  </bid>
</result>

Link

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <link bid="0.0001" url="url_to_follow" />
</result>

Listing (bid + url)

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <listing bid="0.0001" url="url_to_follow" />
</result>

Results

<?xml version="1.0" encoding="UTF-8"?>
<results>
  <result>
    <url>url_to_follow</url>
    <bid>0.0001</bid>
  </result>
</results>