> For the complete documentation index, see [llms.txt](https://docs.exads.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exads.com/rtb/advertisers/open-rtb/open-rtb-advertisers-response.md).

# Open RTB Bid Response Specifications

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

## Bid Response Object <a href="#bid-response-object" id="bid-response-object"></a>

| Attribute | Required? | Description                                                        |
| --------- | --------- | ------------------------------------------------------------------ |
| id        | Yes       | ID of the bid request, must match id sent in the request (string)  |
| seatbid   | Yes       | Collection of bids made by the bidder on behalf of a specific seat |

### seatbid <a href="#seatbid" id="seatbid"></a>

| Attribute | Required? | Description                                                                                       |
| --------- | --------- | ------------------------------------------------------------------------------------------------- |
| bid       | Yes       | ID of the impression object to which this bid applies, must match id sent in the request (string) |

### seatbid.bid <a href="#seatbidbid" id="seatbidbid"></a>

| Attribute | Required? | Description                                                                                                                                                                                                                                              |
| --------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id        | Yes       | ID for the bid object chosen by the bidder (string)                                                                                                                                                                                                      |
| impid     | Yes       | ID of the impression object to which this bid applies (string)                                                                                                                                                                                           |
| price     | Yes       | Bid price in CPM or CPC (float)                                                                                                                                                                                                                          |
| adm       | Yes       | EXADS XML/JSON Ad Markup (string)                                                                                                                                                                                                                        |
| nurl      | Yes\*     | Win notification URL, it is recommended to use **HTTP** over HTTPS for nurl (string)                                                                                                                                                                     |
| burl      | No\*      | Billing notification URL, called by EXADS when the impression or click becomes billable (CPM or CPC, per the `btype` field), so it can be counted from the billable event instead of the pixel. Recommended to use **HTTP** over HTTPS for burl (string) |
| ext       | No        | EXADS specific extension (object)                                                                                                                                                                                                                        |

***

**Note**:

* The nURL must be notified in order to ensure campaign capping and avoid getting the same response every time.
* The bURL is called server-to-server when the impression or click becomes billable (CPM or CPC, per the `btype` field, default CPM), so the event can be counted from the billable event instead of the pixel.

***

### seatbid.bid.ext <a href="#seatbidbidext" id="seatbidbidext"></a>

| Attribute | Required?   | Description                                                                                                                             |
| --------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| btype     | Recommended | Pricing Model. Values: 1 = CPM, 2 = CPC. Default = 1 (int). **Note**: When response is for an Email Clicks zone request, 1 = Smart CPC. |

***

**Note**: Only Push Notification and Native ad formats may bid with the CPC pricing model.

***

## JSON Examples <a href="#json-examples" id="json-examples"></a>

### Banner / iFrame / Popunder / In-Stream / Push Notifications: JSON <a href="#banner--iframe--popunder--in-stream--push-notifications-json" id="banner--iframe--popunder--in-stream--push-notifications-json"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "seatbid": [{
        "bid": [{
            "id": "12ab3d",
            "impid": "1915966848",
            "price": 0.55,
            "adm": "<EXADS_XML_OR_JSON_AD_MARKUP>",
            "nurl": "https://www.dsp-network.com/win_notification_url",
            "burl": "https://www.dsp-network.com/billing_notification_url",
            "ext": {
                "btype": 1
            }
        }]
    }]
}
```

## Direct Links <a href="#direct-links" id="direct-links"></a>

```
{
    "id": "",
    "bidid": 123,
    "seatbid": [{
        "bid": [{
            "id": "12ab3d",
            "adid": 1,
            "impid": "",
            "price": 0.12,
            "adm": "<EXADS_XML_AD_MARKUP>",
            "ext":{
                "btype": 2  
            },
            "burl": "https://www.dsp-network.com/billing_notification_url"
        }]
    }]
}
```

## Email Clicks <a href="#email-clicks" id="email-clicks"></a>

```
{
    "id": "",
    "bidid": 123,
    "seatbid": [{
        "bid": [{
            "id": "12ab3d",
            "adid": 1,
            "impid": "",
            "price": 0.12,
            "adm": "<EXADS_XML_AD_MARKUP>",
            "ext":{
                "btype": 2  
            },
            "burl": "https://www.dsp-network.com/billing_notification_url"
        }]
    }]
}
```

### Fullpage Interstitial (Mobile and Desktop) <a href="#fullpage-interstitial-mobile-and-desktop" id="fullpage-interstitial-mobile-and-desktop"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "seatbid": [
        {
            "bid": [
                {
                    "id": "54f6f08b2e323e32ea9ec4fd6944d652c842699a",
                    "impid": "974090632",
                    "price": 0.05,
                    "adm": "<?xml version=\"1.0\"?>\n<ad><iframeAd><url><![CDATA[https://network-domain.com/fpi-render.php?data=TVRjME9UZ31]]></url></iframeAd></ad>\n",
                    "ext": {
                        "btype": 1,
                        "asset_mime_type": [
                            "video/mp4"
                        ]
                    },
                    "nurl": "https://www.dsp-network.com/win_notification_url",
                    "iurl": "https://www.dsp-network.com/file/video.mp4",
                    "cid": "7561981",
                    "crid": "195600_115116261",
                    "cat": [],
                    "adomain": [
                        "www.adomain.com"
                    ],
                    "w": 900,
                    "h": 1600,
                    "attr": []
                }
            ]
        }
    ],
    "cur": "EUR"
}
```

### Native: JSON <a href="#native-json" id="native-json"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "seatbid": [
      {
        "bid": [
          {
            "id": "12ab3d",
            "impid": "1915966848",
            "price": 0.71,
            "nurl": "https://www.dsp-network.com/win_notification_url",
            "burl": "https://www.dsp-network.com/billing_notification_url",
            "adm": "<EXADS_JSON_AD_MARKUP_1>",
            "ext": {
              "btype": 1
            }
          }
        ]
      }, 
      {
        "bid": [
          {
            "id": "12ab3e",
            "impid": "1915966848",
            "price": 0.62,
            "nurl": "https://www.dsp-network.com/win_notification_url",
            "burl": "https://www.dsp-network.com/billing_notification_url",
            "adm": "<EXADS_JSON_AD_MARKUP_2>",
            "ext": {
              "btype": 1
            }
          }
        ]
      }
    ]
}
```

## ADM Examples <a href="#adm-examples" id="adm-examples"></a>

As you can see above, the **adm** parameter can contain a piece of XML or JSON (or HTML in case of Banners). The examples below show examples of XML, JSON and HTML as used in this ADM parameter.

### Banner: XML <a href="#banner-xml" id="banner-xml"></a>

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
    <imageAd>
        <clickUrl><![CDATA[https://www.dsp-network.com/tracker/click]]></clickUrl>
        <imgUrl><![CDATA[https://www.dsp-network.com/images/myad.jpg]]></imgUrl>
    </imageAd>
</ad>
```

### Banner: HTML <a href="#banner-html" id="banner-html"></a>

```
<a href=\"https:\/\/dsp.com\/click-tracker.php?data=H4sIAAAAA...8Da8a74VIAQAA\" target=\"_blank\" ontouchstart=\"\" onclick=\"var href='https:\/\/dsp.com\/click-tracker.php?data=H4sIAAAAA...8Da8a74VIAQAA'; this.href = href + '&clickX=' + event.clientX + '&clickY=' + event.clientY;\"><img width=\"300\" height=\"250\" src=\"https:\/\/adasset.dsp.com\/images\/uid123\/7fed7f2794236bc6544da662be1368a1f5d73e91.jpg\" border=\"0px\" style=\"\"><\/a><img src=\"https:\/\/dsp.com\/impression.php?data=TVRZM056UTVOak...2Y1Yw--\" width=\"1\" height=\"1\" border=\"0\" \/>
```

### Direct Links: XML <a href="#direct-links-xml" id="direct-links-xml"></a>

```xml
<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
<ad>
    <emailClick>
        <url><![CDATA[https://www.dsp-network.com/landingpages?el={email_encoded}]]></url>
    </emailClick>
</ad>
```

### Email Clicks: XML <a href="#email-clicks-xml" id="email-clicks-xml"></a>

```xml
<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>
<ad>
    <emailClick>
        <url><![CDATA[https://www.dsp-network.com/landingpages?el={email_encoded}]]></url>
    </emailClick>
</ad>
```

### Iframe HTML Banner: XML <a href="#iframe-html-banner-xml" id="iframe-html-banner-xml"></a>

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
    <iframeAd>
        <url><![CDATA[https://www.dsp-network.com/iframe_url]]></url>
    </iframeAd>
</ad>
```

***

**Note**: The support for the iFrame markup response must be enabled by the network on the partner account level.

***

### Fullpage Interstitial Iframe (Mobile and Desktop): XML <a href="#fullpage-interstitial-iframe-mobile-and-desktop-xml" id="fullpage-interstitial-iframe-mobile-and-desktop-xml"></a>

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
    <iframeAd>
        <url><![CDATA[https://www.dsp-network.com/tracker/impression]]></url>
    </iframeAd>
</ad>
```

### Fullpage Interstitial Banner (Mobile and Desktop): XML <a href="#fullpage-interstitial-banner-mobile-and-desktop-xml" id="fullpage-interstitial-banner-mobile-and-desktop-xml"></a>

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
    <imageAd>
        <clickUrl><![CDATA[https://www.dsp-network.com/tracker/click]]></clickUrl>
        <imgUrl><![CDATA[https://www.dsp-network.com/images/myad.jpg]]></imgUrl>
    </imageAd>
</ad>
```

### Popunder: XML <a href="#popunder-xml" id="popunder-xml"></a>

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<ad>
    <popunderAd>
        <url><![CDATA[https://www.dsp-network.com/tracker/impression]]></url>
    </popunderAd>
</ad>
```

### In-Stream Ads: JSON <a href="#in-stream-a-ds-json" id="in-stream-a-ds-json"></a>

For In-Stream ads the **adm** parameter should contain a JSON encoded string. It can follow one of two structures, either by using Local VAST or Remote VAST.

By using local VAST the whole VAST tag will be generated on the network side and the partner will need to send all individual data needed for the ad to be correctly displayed. With the remote VAST the content will be loaded by using the VAST Wrapper standard.

**Local VAST**

```
{\"instream\":{\"videoUrl\":\"https:\/\/www.dsp-network.com\/video.mp4\",\"clickUrl\":\"https:\/\/www.dsp-network.com\/clickurl\",\"trackingEvents\":[{\"type\":\"impression\",\"url\":\"https:\/\/www.dsp-network.com\/impression\"},{\"type\":\"complete\",\"url\":\"https:\/\/www.dsp-network.com\/complete\"},{\"type\":\"progress\",\"offset\":\"00:00:10.000\",\"url\":\"https:\/\/www.dsp-network.com\/progress10secs\"}],\"cta\":{\"displayUrl\":\"somedomain.com\",\"text\":\"Click Here\"}}}
```

Based on the following JSON object:

```json
{
    "instream": {
        "videoUrl": "https://www.dsp-network.com/video.mp4",
        "clickUrl": "https://www.dsp-network.com/clickurl",
        "trackingEvents": [{
            "type": "impression",
            "url": "https://www.dsp-network.com/impression"
        }, {
            "type": "complete",
            "url": "https://www.dsp-network.com/complete"
        }, {
            "type": "progress",
            "offset": "00:00:10.000",
            "url": "https://www.dsp-network.com/progress10secs"
        }],
        "cta": {
            "displayUrl": "dsp-domain.com",
            "text": "Click Here"
        }
    }
}
```

**Remote VAST**

```
{\"instream\":{\"remoteUrl\":\"https:\/\/www.dsp-network.com\/vasturl\"}}
```

Based on the following JSON object:

```json
{
    "instream": {
        "remoteUrl": "https://www.dsp-network.com/vasturl"  
    }
}
```

**Tracking Events**

When using the In-Stream local VAST bid response structure it is allowed to send a list of tracking events. The supported event types are **impression**, **progress** and **complete**.

The tracking events *must* follow the same structures as in the example above.

### Native Ads: JSON <a href="#native-a-ds-json" id="native-a-ds-json"></a>

For native ads the **adm** parameter should contain a JSON encoded string like this:

```
{\"native\":{\"link\":{\"url\":\"https:\/\/www.dsp-network.com\/tracker\/impression\"},\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"url\":\"https:\/\/www.dsp-network.com\/images\/myad.jpg\",\"w\":300,\"h\":300,\"ext\":{\"crop_anchor_point\":1}}},{\"id\":2,\"title\":{\"text\":\"Ad Title\"}},{\"id\":3,\"data\":{\"type\":2,\"value\":\"Ad description\"}},{\"id\":4,\"data\":{\"type\":1,\"value\":\"Ad brand\"}},{\"id\":5,\"ext\":{\"crop_anchor_point\":1}}],\"imptrackers\":[\"https://dsp-network.com/imptrackers?landingpage=1\"],\"eventtrackers\":[{\"event\":1,\"method\":1,\"url\":\"https://dsp-network.com/eventtrackers?landingpage=1\"}]}}
```

* crop\_anchor\_point: MIDDLE\_CENTER = 0, TOP\_LEFT = 1, TOP\_CENTER = 2, TOP\_RIGHT = 3, MIDDLE\_LEFT = 4, MIDDLE\_RIGHT = 5, BOTTOM\_LEFT = 6, BOTTOM\_CENTER = 7, BOTTOM\_RIGHT= 8 (integer) - not mandatory

![crop anchor point](https://docs-advanced.exads.com/docs/assets/hires/crop_anchor_point.png)

Which is based on the following JSON object:

```json
{
    "native": {
          "link": {
              "url": "https://www.dsp-network.com/tracker/impression"
          },
          "assets": [
              {
                  "id": 1,
                  "required": 1,
                  "img": {
                      "url": "https://www.dsp-network.com/images/myad.jpg",
                      "w": 300,
                      "h": 300,
                      "ext": {
                          "crop_anchor_point": 1
                      }
                  }
              },
              {
                  "id": 2,
                  "title": {
                      "text": "Ad Title"
                  }
              },
              {
                  "id": 3,
                  "data": {
                      "type": 2,
                      "value": "Ad description"
                  }
              },
              {
                  "id": 4,
                  "data": {
                      "type": 1,
                      "value": "Ad brand"
                  }
              }
          ],
          "imptrackers": [
              "https://dsp-network.com/imptrackers?landingpage=1",
              "https://dsp-network.com/imptrackers?landingpage=2"
          ],
          "eventtrackers": [
              {
                  "event": 1,
                  "method": 1,
                  "url": "https://dsp-network.com/eventtrackers?landingpage=1"
              }, {
                  "event": 1,
                  "method": 1,
                  "url": "https://dsp-network.com/eventtrackers?landingpage=2"
              }
          ]
    }
}
```

### Push Notification Ads: JSON <a href="#push-notification-a-ds-json" id="push-notification-a-ds-json"></a>

For Push Notification ads the **adm** parameter should contain a JSON encoded string like this (note that we use the 'native' object to implement push notification ads). Width and height depend on the width and height coming from request. Currently supported dimensions are 192x192 and 720x480. One image asset per notification.

```
{\"native\":{\"link\":{\"url\":\"https:\/\/www.dsp-network.com\/tracker\/impression\"},\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"url\":\"https:\/\/www.dsp-network.com\/images\/myad.jpg\",\"w\":720,\"h\":480}},{\"id\":2,\"title\":{\"text\":\"Ad Title\"}},{\"id\":3,\"data\":{\"type\":2,\"value\":\"Ad description\"}}],\"imptrackers\":[\"https://dsp-network.com/imptrackers?landingpage=1\"]}}
```

Which is based on the following JSON object:

```json
{
    "native": {
          "link": {
              "url": "https://www.dsp-network.com/tracker/impression"
          },
          "assets": [
              {
                  "id": 1,
                  "required": 1,
                  "img": {
                      "url": "https://www.dsp-network.com/images/myad.jpg",
                      "w": 720,
                      "h": 480
                  }
              },
              {
                  "id": 2,
                  "title": {
                      "text": "Ad Title"
                  }
              },
              {
                  "id": 3,
                  "data": {
                      "type": 2,
                      "value": "Ad description"
                  }
              }
          ],
          "imptrackers": [
              "https://dsp-network.com/imptrackers?landingpage=1"
          ]
    }
}
```

\* Only one imptracker URL is allowed in the case of Push Notification ads \* We use the 'native' object for push notification ads

## No Bid Response <a href="#no-bid-response" id="no-bid-response"></a>

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

## Win Notification <a href="#win-notification" id="win-notification"></a>

If the parameter **Bid Response Object -> Seat Bid Object -> Bid Object -> nurl** is in the bid response and is a valid URL, EXADS platform will send a GET request to it. This URL can have a few tokens to be replaced by EXADS before doing the GET:

```
${AUCTION_ID} - ID of the bid request; from "Bid Request Object -> id" attribute.
${AUCTION_BID_ID} - ID of the bid; from "Bid Response Object -> bidid" attribute.
${AUCTION_IMP_ID} - ID of the impression just won; from "Bid Request Object -> Impression Object -> id" attribute.
${AUCTION_SEAT_ID} - ID of the bidder seat for whom the bid was made; from "Bid Response Object -> Seat Bid Object -> Bid Object -> id" attribute.
${AUCTION_AD_ID} - ID of the ad markup the bidder wishes to serve; from "Bid Response Object -> Seat Bid Object -> Bid Object -> adid" attribute.
${AUCTION_PRICE} - Settlement price using the same currency and units as the bid; from "Bid Response Object -> Seat Bid Object -> Bid Object -> price" attribute.
${AUCTION_CURRENCY} - The currency used in the bid (explicit or implied); for confirmation only.
```

Example:

```
https://www.dsp-network.com/win_notification_url?id=${AUCTION_ID}&bidid=${AUCTION_BID_ID}&price=${AUCTION_PRICE}&currency=${AUCTION_CURRENCY}
```

## Billing Notification <a href="#billing-notification" id="billing-notification"></a>

If the parameter **Bid Response Object -> Seat Bid Object -> Bid Object -> burl** is in the bid response and is a valid URL, EXADS will send a GET request to it when the impression or click becomes billable (CPM or CPC, per the `btype` field). This allows the event to be counted from the billable server-to-server event rather than from pixel-based tracking.

If both `nurl` and `burl` are present, both will be called.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.exads.com/rtb/advertisers/open-rtb/open-rtb-advertisers-response.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
