Skip to main content
Categories
< All Topics
Print

Paradox RTB Bid Response Specifications


Note: The Paradox RTB Bid Response is done using JSON and XML.


The response for a bid request should have the following structure:

Bid Response Object

AttributeDescription
idID of the impression object to which this bid applies, must match id sent in the request (string)
imgUrlImage url (only for type banner)
iconUrlIcon url (only for type push_notification and must be of requested dimensions)
clickUrlForward url when campaign is clicked (for type banner or push_notification)
urlForward url when campaign is clicked (only for type popunder)
titleTitle of the ad (only for type push_notification)
descriptionDescription of the ad (only for type push_notification)
valueBid price in CPM or CPC (float)
imptrackersImpression trackers, optional (only for type push_notification)
btypePricing Model. Values: 1 = CPM, 2 = CPC. Default = 1 (int). Note: When response is for an Email Clicks zone request, 1 = Smart CPC.
bUrlBilling notification URL, it is recommended to use HTTP over HTTPS for bUrl

* Only Push Notification ads accept the CPC pricing model. * The bURL is called when impression or click has been delivered, depending on CPM or CPC from btype field (default CPM).

Bid Response in JSON

Banner

{
    "bid": {
        "id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
        "imgUrl" : "http://mysite.com/images/myad.jpg",
        "clickUrl" : "http://mysite.com/landingpages/mypage",
        "btype": 1,
        "value" : 0.34,
        "bUrl": "https://mysite.com/my_billing_notification_url"
    }
}

Email Clicks

{
    "bid": {
        "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
        "clickUrl": "http://mysite.com/landingpages/mypage?el={email_encoded}",
        "value": 0.07,
        "btype": 2,
        "nUrl": "http://network-domain.com/win-notification",
        "bUrl": "https://mysite.com/my_billing_notification_url"
    }
}

Popunder

{
    "bid": {
        "id" : "dd4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
        "url" : "http://mysite.com/landingpages/mypage",
        "btype": 1,
        "value" : 0.13,
        "bUrl": "https://mysite.com/my_billing_notification_url"
    }
}

Push Notifications

{
    "bid": {
        "id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
        "iconUrl" : "http://mysite.com/images/myadicon.jpg",
        "clickUrl" : "http://mysite.com/landingpages/mypage",
        "title": "My Ad Title",
        "description": "My Ad Description Text",
        "btype": 2,
        "value" : 0.13,
        "bUrl": "https://mysite.com/my_billing_notification_url",
        "imptrackers": [
            "https://mytracker.com"
        ]
    }
}

* Only one imptracker URL is allowed in the case of Push Notification ads

Bid Response in XML

Banner

<?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>
        <btype>1</btype>
        <value>0.34</value>
        <bUrl><![CDATA[https://mysite.com/my_billing_notification_url]]></bUrl>
    </bid>
</result>

Direct Link

<?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>
        <bUrl><![CDATA[https://mysite.com/my_billing_notification_url]]></bUrl>
    </bid>
</result>

Email Clicks

<?xml version="1.0"?>
<result>
    <bid>
        <id><![CDATA[d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa]]></id>
        <clickUrl><![CDATA[http://mysite.com/landingpages/mypage?el={email_encoded}]]></clickUrl>
        <value><![CDATA[0.07]]></value>
        <btype><![CDATA[2]]></btype>
        <nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
        <bUrl><![CDATA[https://mysite.com/my_billing_notification_url]]></bUrl>
    </bid>
</result>

Popunder

<?xml version="1.0"?>
<result>
    <bid>
        <id>d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa</id>
        <url><![CDATA[http://mysite.com/landingpages/mypage]]></url>
        <btype>1</btype>
        <value>0.13</value>
        <bUrl><![CDATA[https://mysite.com/my_billing_notification_url]]></bUrl>
    </bid>
</result>

Push Notification

<?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>
        <title>My Ad Title</title>
        <description>My Ad Description Text</description>
        <btype>2</btype>
        <value>0.13</value>
        <imptrackers><![CDATA[https://mytracker.com]]></imptrackers>
        <bUrl><![CDATA[https://mysite.com/my_billing_notification_url]]></bUrl>
    </bid>
</result>

No Bid Response

To answer a bid request without making an actual bid, an HTTP response code 204 “No Content” should be sent.

Table of Contents
Translate »