> 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-request.md).

# Open RTB Bid Request Specifications

## Bid Request Headers

* OpenRTB Version HTTP Header: x-openrtb-version: 2.4
* Keep-Alive HTTP Header: Connection: Keep-Alive
* Content JSON: Content-Type: application/json
* Data Encoding Header: Accept-Encoding

## Bid Request <a href="#bid-request" id="bid-request"></a>

When requesting bids for a specific context, the platform performs an HTTP request with a timeout of **300ms** and sends the following object encoded as JSON in the request body. **HTTP** is recommended due to extra latency when using HTTPS.

| Attribute | Description                                                                                            |
| --------- | ------------------------------------------------------------------------------------------------------ |
| at        | Auction type, first price = 1 (integer)                                                                |
| id        | Unique bid request ID (string)                                                                         |
| imp       | Array of Imp objects representing the impressions offered(object).                                     |
| site      | Details via a Site object about the publisher’s website(object).                                       |
| device    | Details via a Device object about the user’s device to which the impression will be delivered(object). |
| user      | Details via a User object about the human user of the device; the advertising audience(object).        |
| ext       | Placeholder for extensions to OpenRTB.                                                                 |

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

| Attribute   | Description                                                                                                                                                                                                                        |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id          | Unique impression ID within this bid request (string)                                                                                                                                                                              |
| bidfloor    | Minimum bid for this impression expressed in CPM, optional (float)                                                                                                                                                                 |
| bidfloorcur | Currency for minimum bid value specified using ISO-4217 alpha codes, optional (string)                                                                                                                                             |
| native      | A Native object ; required if this impression is offered as a native ad opportunity(object).                                                                                                                                       |
| banner      | A banner object ; required if this impression is offered as a banner ad opportunity(object).                                                                                                                                       |
| instl       | An interstitial object ; required if this impression is offered as an interstitial ad opportunity(object).                                                                                                                         |
| secure      | Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure. If omitted, the secure state is unknown, but non-secure HTTP support can be assumed, optional (integer) |
| el          | Base64 Encoded Email (string)                                                                                                                                                                                                      |

### imp.banner <a href="#impbanner" id="impbanner"></a>

| Attribute | Description                               |
| --------- | ----------------------------------------- |
| w         | Width of the banner in pixels (integer).  |
| h         | Height of the banner in pixels (integer). |

### imp.full-page-interstitial <a href="#impfull-page-interstitial" id="impfull-page-interstitial"></a>

| Attribute | Required? | Description                                                 |
| --------- | --------- | ----------------------------------------------------------- |
| w         | Yes       | Width of the banner (integer)                               |
| h         | Yes       | Height of the banner (integer)                              |
| mimes     | Yes       | Mimes types - image/jpg, image/png, video/mp4 or image/webp |

### imp.instl <a href="#impinstl" id="impinstl"></a>

| Attribute | Description                                                               |
| --------- | ------------------------------------------------------------------------- |
| instl     | Flag specifying if ad is popunder/interstitial (integer): 1=true, 0=false |

### imp.native (Native & Push Notifications) <a href="#impnative-native--push-notifications" id="impnative-native--push-notifications"></a>

| Attribute | Description                                                                                                                                                              |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| request   | Request payload complying with the Native Ad Specification - a **JSON encoded string** of the Native Ads request including its **native** top level object (JSON object) |
| ver       | Version of the Dynamic Native Ads API to which **request** complies (string)                                                                                             |

### imp.native.request <a href="#impnativerequest" id="impnativerequest"></a>

| Attribute | Description                                                                                                                                                                                                                                                                                                                |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ver       | Version of the Native Markup version in use (string)                                                                                                                                                                                                                                                                       |
| context   | The context in which the ad appears. In this case it is **1** (*Content-centric context such as newsfeed, article, image gallery, video gallery, or similar*), optional (integer)                                                                                                                                          |
| plcmttype | The design/format/layout of the ad unit being offered. Currently we support **4** (*Recommendation widget*) and **500** (*Push Notification*) (integer)                                                                                                                                                                    |
| plcmtcnt  | The number of identical placements in this Layout (integer)                                                                                                                                                                                                                                                                |
| assets    | An array of **Asset Objects**. Any bid response must comply with the array of elements expressed in the bid request (array of JSON objects)                                                                                                                                                                                |
| seq       | 0 for the first ad, 1 for the second ad, and so on. Note this would generally NOT be used in combination with plcmtcnt - either you are auctioning multiple identical placements (in which case plcmtcnt>1, seq=0) or you are holding separate auctions for distinct items in the feed (in which case plcmtcnt=1, seq=>=1) |

### imp.native.request.assets <a href="#impnativerequestassets" id="impnativerequestassets"></a>

| Attribute | Description                                                                                                                                                                                                       |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id        | Unique asset ID, assigned by exchange. Typically a counter for the array (integer)                                                                                                                                |
| required  | Set to **1** if asset is required or **0** if asset is optional\*\* (integer)                                                                                                                                     |
| plcmtcnt  | The number of identical placements in this Layout (integer)                                                                                                                                                       |
| img       | Image object for image assets\* (JSON object)                                                                                                                                                                     |
| title     | Title object for title assets\* (JSON object)                                                                                                                                                                     |
| data      | Data object for brand name, description, ratings, prices etc.\* (JSON object)                                                                                                                                     |
| video     | Video object for video assets. See the Video request object definition. Note that in-stream (ie preroll, etc) video ads are not part of Native. Native ads may contain a video as the ad creative itself(object). |

\* Only one of the {img, title, data} objects should be present in each asset object

\*\* Assets are flagged as required according to the configuration of the publisher zone where your ad may be displayed

### imp.native.request.assets.img <a href="#impnativerequestassetsimg" id="impnativerequestassetsimg"></a>

| Attribute | Description                                                                                                                                             |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type      | Type ID of the image element supported by the publisher. We support: **1** (*Icon image*) (integer), **3** (*Large image preview for the ad*) (integer) |
| w         | Width of the image in pixels, optional (integer)                                                                                                        |
| h         | Height of the image in pixels, optional (integer)                                                                                                       |
| wmin      | The minimum requested width of the image in pixels (integer)                                                                                            |
| hmin      | The minimum requested height of the image in pixels (integer)                                                                                           |

### imp.native.request.assets.title <a href="#impnativerequestassetstitle" id="impnativerequestassetstitle"></a>

| Attribute | Description                                                |
| --------- | ---------------------------------------------------------- |
| len       | Maximum length of the text in the title element. (integer) |

### imp.native.request.assets.data <a href="#impnativerequestassetsdata" id="impnativerequestassetsdata"></a>

| Attribute | Description                                                                                                                                                                                                                                                                |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type      | Type ID of the element supported by the publisher (integer). We support: **1** (*sponsored - Sponsored By message where response should contain the brand name of the sponsor*), **2** (*desc - Descriptive text associated with the product or service being advertised*) |
| len       | Maximum length of the text in the element’s response (integer)                                                                                                                                                                                                             |

### imp.native.request.assets.video <a href="#impnativerequestassetsvideo" id="impnativerequestassetsvideo"></a>

| Attribute     | Description                                                                       |
| ------------- | --------------------------------------------------------------------------------- |
| mimes         | List of supported mime types (string array)                                       |
| minduration   | Minimum video ad duration in seconds(integer).                                    |
| maxduration   | Maximum video ad duration in seconds(integer).                                    |
| protocols     | List of supported video bid response protocols (int array)                        |
| linearity     | Indicates if the impression must be linear, nonlinear, etc. (integer)             |
| boxingallowed | Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed (integer) |

### imp.video <a href="#impvideo" id="impvideo"></a>

| Attribute     | Description                                                                                                                     |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| mimes         | List of supported mime types (string array)                                                                                     |
| protocols     | List of supported video bid response protocols (int array)                                                                      |
| linearity     | Indicates if the impression must be linear, nonlinear, etc. (integer)                                                           |
| boxingallowed | Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed (integer)                                               |
| skip          | Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes                                               |
| skipafter     | Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable (integer)                |
| skipmin       | Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable (integer) |

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

| Attribute | Description                                                                                                                     |
| --------- | ------------------------------------------------------------------------------------------------------------------------------- |
| id        | Unique Site ID (string)                                                                                                         |
| domain    | Domain name of the site (string)                                                                                                |
| cat       | IAB category ID (string array)                                                                                                  |
| page      | Full URL of the page where the ad will be shown (string)                                                                        |
| keywords  | Keywords can be used to ensure ad zones get the right type of advertising. Keywords should be a string of comma-separated words |
| ext       | Placeholder for exchange-specific extensions                                                                                    |

### site.ext <a href="#siteext" id="siteext"></a>

| Attribute   | Description                        |
| ----------- | ---------------------------------- |
| exchangecat | Custom EXADS category ID (integer) |
| idzone      | Custom EXADS Ad Zone ID (integer)  |
| keyword     | Matching keyword if any (string)   |

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

| Attribute | Description                                                                                                  |
| --------- | ------------------------------------------------------------------------------------------------------------ |
| ua        | Browser user agent (string)                                                                                  |
| sua       | Structured user agent information, which can be used when a client supports User-Agent Client Hints (object) |
| geo       | Location of the device assumed to be the user’s current location defined by a Geo object.                    |
| ip        | IPv4 address of the user (string)\*                                                                          |
| ipv6      | IPv6 address of the user (string)\*                                                                          |
| language  | Browser language using ISO-639-1-alpha-2 (string)                                                            |
| os        | Operating System name, without version (string). E.g. "iOS", "Android", "Windows"                            |
| osv       | Operating System version (string). E.g. "18", "14", "11"                                                     |
| js        | Support for JavaScript, where 0 = no, 1 = yes (integer)                                                      |
| ext       | Placeholder for exchange-specific extensions to OpenRTB                                                      |

\*Condition: Exactly one of ip or ipv6 will be present in the bid request.

### device.geo <a href="#devicegeo" id="devicegeo"></a>

| Attribute | Description  |
| --------- | ------------ |
| country   | Country ISO3 |

### device.ext <a href="#deviceext" id="deviceext"></a>

| Attribute         | Description                                                         |
| ----------------- | ------------------------------------------------------------------- |
| 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) |

### device.sua <a href="#devicesua" id="devicesua"></a>

Structured User Agent information. Once provided `device.sua` is considered the more accurate representation of the device attributes.

| Attribute    | Description                                                                                                                                                                                                                    |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| browsers     | Send brands and versions derived from the Sec-CH-UA-Full-Version-List header. (Array of `BrandVersion` objects)                                                                                                                |
| platform     | Send a brand derived from the Sec-CH-UA-Platform header, and version derived from the Sec-CH-UA-Platform-Version header. (`BrandVersion` Object)                                                                               |
| mobile       | Derive this value from the Sec-CH-UA-Mobile header. (integer)                                                                                                                                                                  |
| architecture | Retrieve this value from the Sec-CH-UA-Arch header. (string)                                                                                                                                                                   |
| bitness      | Retrieve this value from the Sec-CH-UA-Bitness header. (string)                                                                                                                                                                |
| model        | Retrieve this value from the Sec-CH-UA-Model header. (string)                                                                                                                                                                  |
| source       | The source of data used to create this object, [List: User-Agent Source](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--user-agent-source-) in AdCOM 1.0 (integer; default 0) |

**device.sua.browsers.BrandVersion | device.sua.platform.BrandVersion**

| Attribute | Description                                                                                                                                                                                                               |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| brand     | The value may be sourced from the User-Agent Client Hints headers, representing either the user agent brand (from the Sec-CH-UA-Full-Version header) or the platform brand (from the Sec-CH-UA-Platform header). (string) |
| version   | A sequence of version components, in descending hierarchical order \[major, minor, micro, …] (array of string)                                                                                                            |

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

| Attribute | Description             |
| --------- | ----------------------- |
| id        | Unique user ID (string) |

### user.ext <a href="#userext" id="userext"></a>

| Attribute | Description                                                                                                            |
| --------- | ---------------------------------------------------------------------------------------------------------------------- |
| consent   | **user.ext.consent**: This is the consent string required by the IAB standards. Negative consent only for now (string) |
| prebid    | Prebid Server specific data (object)                                                                                   |

### regs.ext <a href="#regsext" id="regsext"></a>

| Attribute | Description                                                                                                                                                         |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| gdpr      | **regs.ext.gdpr**: This is 0 if the caller believes that the user is not under GDPR, and 1 if the user is under GDPR. If neither, this parameter will be undefined. |

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

| Attribute | Required? | Description                                                                                              |
| --------- | --------- | -------------------------------------------------------------------------------------------------------- |
| sub       | No        | The sub will be an integer number representing the ID of the zone where the request was originated from. |

## Examples <a href="#examples" id="examples"></a>

### Banner <a href="#banner" id="banner"></a>

```json
{
  "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
  "at": 1,
  "imp": [
    {
      "id": "6145298465",
      "instl": 0,
      "banner": {
        "w": 300,
        "h": 250
      },
      "bidfloor": 0.5,
      "bidfloorcur": "USD",
      "secure": 1
    }
  ],
  "site": {
    "id": "12345",
    "domain": "sitedomain.com",
    "cat": [
      "IAB25-3"
    ],
    "page": "https://sitedomain.com/page",
    "ext": {
      "exchangecat": 508,
      "idzone": 445566
    }
  },
  "device": {
    "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
    "sua": {
      "architecture": "x86",
      "bitness": "64",
      "model": "Windows",
      "mobile": 0,
      "source": 2,
      "platform": {
        "brand": "Windows",
        "version": [
          "10",
          "0",
          "0"
        ]
      },
      "browsers": [
        {
          "brand": "Chromium",
          "version": [
            "136",
            "0",
            "7103",
            "93"
          ]
        },
        {
          "brand": "Microsoft Edge",
          "version": [
            "136",
            "0",
            "3240",
            "64"
          ]
        },
        {
          "brand": "Not.A\/Brand",
          "version": [
            "99",
            "0",
            "0",
            "0"
          ]
        }
      ]
    },
    "ip": "192.0.2.1",
    "geo": {
      "country": "IRL"
    },
    "language": "en",
    "os": "Linux & UNIX",
    "osv": "",
    "js": 0,
    "ext": {
      "remote_addr": "192.0.2.1",
      "x_forwarded_for": "",
      "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
    }
  },
  "user": {
    "id": "5fc94d61a66a37.821612521136907401",
    "ext": {
      "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
    }
  },
  "ext": {
    "sub": 445566
  }
}
```

**Banner Bid Request Structure**

* [imp](#imp)
  * [imp.banner](#impbanner)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

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

**JSON**

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "imp": [
        {
            "id": "974090632",
            "instl": 0,
            "el": "dGVzdGVAZW1haWwuY29t"
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "ext": {
            "exchangecat": 508,
            "idzone": 445566
        }
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "PRT"
        },
        "language": "en",
        "os": "Linux & UNIX",
        "osv": "",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "192.0.2.1"
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
            }
    },
    "ext": {
        "sub": 445566
    }    
}

```

**Direct Links Bid Request Structure**

* [imp](#imp)
  * [imp.instl](#impinstl)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

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

**JSON**

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "imp": [
        {
            "id": "974090632",
            "instl": 0,
            "el": "dGVzdGVAZW1haWwuY29t"
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "ext": {
            "exchangecat": 508,
            "idzone": 445566
        }
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "PRT"
        },
        "language": "en",
        "os": "Linux & UNIX",
        "osv": "",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "192.0.2.1"
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
            }
    },
    "ext": {
        "sub": 445566
    }    
}

```

**Email Clicks Bid Request Structure**

* [imp](#imp)
  * [imp.instl](#impinstl)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

### Fullpage Interstitial Desktop <a href="#fullpage-interstitial-desktop" id="fullpage-interstitial-desktop"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "at":1,
    "imp": [
        {
            "id": "974090632",
            "instl": 1,
             "banner": {
                "w": 1600,
                "h": 900,
                "mimes": [
                  "image/jpg",
                  "image/png",
                  "video/mp4",
                  "image/webp"
                ]
            }
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "name": "site domain",  
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "keywords": "lifestyle, humour"
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "PRT"
        },
        "language": "en",
        "os": "Linux & UNIX",
        "osv": "",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "192.0.2.1"
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
            }
    },
    "ext": {
        "sub": 1221
    }
}
```

### Fullpage Interstitial Mobile <a href="#fullpage-interstitial-mobile" id="fullpage-interstitial-mobile"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "at":1,
    "imp": [
        {
            "id": "974090632",
            "instl": 1,
             "banner": {
                "w": 900,
                "h": 1600,
                "mimes": [
                  "image/jpg",
                  "image/png",
                  "video/mp4",
                  "image/webp"
                ]
            }
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "name": "site domain",  
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "keywords": "lifestyle, humour"
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "PRT"
        },
        "language": "en",
        "os": "MacOS",
        "osv": "10.15.7",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "192.0.2.1"
        }
    },
    "user": {
        "id": "57592f333f8983.043587162282415065"
    },
    "ext": {
        "sub": 1221
    }
}
```

**Fullpage Interstitial (Mobile and Desktop) Bid Request Structure**

* [imp](#imp)
  * [imp.full-page-interstitial](#impfull-page-interstitial)
  * [imp.instl](#impinstl)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

### In-Stream <a href="#in-stream" id="in-stream"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "at":1,
    "imp": [
        {
            "id": "43389012",
            "video": {
                "skip": 1,
                "skipafter": 5,
                "skipmin": 25,
                "mimes": [
                    "video/mp4"
                ],
                "protocols": [
                    3,
                    6
                ],
                "linearity": 1,
                "boxingallowed": 1
            },
            "bidfloor": 0.5,
            "bidfloorcur": "USD",
            "secure": 1
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "ext": {
            "exchangecat": 508,
            "idzone": 445566
        }
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "IRL"
        },
        "language": "en",
        "os": "Linux & UNIX",
        "osv": "",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "",
            "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
            }
    },
    "ext": {
        "sub": 445566
    }
}
```

**In-Stream Bid Request Structure**

* [imp](#imp)
  * [imp.video](#impvideo)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

### Native <a href="#native" id="native"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "at":1,
    "imp": [
        {
            "id": "90180978",
            "native": {
                "request":"{\"native\":{\"ver\":\"1.2\",\"context\":1,\"plcmttype\":4,\"plcmtcnt\":5,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":3,\"wmin\":100,\"hmin\":100}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}},{\"id\":4,\"required\":1,\"data\":{\"type\":1,\"len\":110}}]}}",
                "ver": "1.2"
            },
            "secure": 1
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "ext": {
            "exchangecat": 508,
            "idzone": 445566
        }
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "IRL"
        },
        "language": "en",
        "os": "Linux & UNIX",
        "osv": "",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "",
            "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
            }
    },
    "ext": {
        "sub": 445566
    }
}
```

**Native Bid Request Structure**

* [imp](#imp)
  * [imp.native](#impnative-native--push-notifications)
    * [imp.native.request](#impnativerequest)
      * [imp.native.request.assets](#impnativerequestassets)
        * [imp.native.request.assets.img](#impnativerequestassetsimg)
        * [imp.native.request.assets.title](#impnativerequestassetstitle)
        * [imp.native.request.assets.data](#impnativerequestassetsdata)
        * [imp.native.request.assets.video](#impnativerequestassetsvideo)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

### Popunder <a href="#popunder" id="popunder"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "at":1,
    "imp": [
        {
            "id": "974090632",
            "instl": 1,
            "bidfloor": 0.5,
            "bidfloorcur": "USD",
            "secure": 1
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "ext": {
            "exchangecat": 508,
            "idzone": 445566
        }
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "IRL"
        },
        "language": "en",
        "os": "Linux & UNIX",
        "osv": "",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "192.0.2.1",
            "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
            }
    },
    "ext": {
        "sub": 445566
    }
}
```

**Popunder Bid Request Structure**

* [imp](#imp)
  * [imp.instl](#impinstl)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

### Push Notifications - 720 x 480 <a href="#push-notifications---720-x-480" id="push-notifications---720-x-480"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "at":1,
    "imp": [
        {
            "id": "90180978",
            "native": {
                "request":"{\"native\":{\"ver\":\"1.2\",\"plcmttype\":500,\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":1,\"w\":720,\"h\":480,\"wmin\":720,\"hmin\":480}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}}]}}",
                "ver": "1.2"
            },
            "secure": 1
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "ext": {
            "exchangecat": 508,
            "idzone": 445566
        }
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "IRL"
        },
        "language": "en",
        "os": "Linux & UNIX",
        "osv": "",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "",
            "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
            }
    },
    "ext": {
        "sub": 445566
    }
}
```

**Push Notifications 720x480 Bid Request Structure**

* [imp](#imp)
  * [imp.native](#impnative-native--push-notifications)
    * [imp.native.request](#impnativerequest)
      * [imp.native.request.assets](#impnativerequestassets)
        * [imp.native.request.assets.img](#impnativerequestassetsimg)
        * [imp.native.request.assets.title](#impnativerequestassetstitle)
        * [imp.native.request.assets.data](#impnativerequestassetsdata)
        * [imp.native.request.assets.video](#impnativerequestassetsvideo)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

### Push Notifications - 192 x 192 <a href="#push-notifications---192-x-192" id="push-notifications---192-x-192"></a>

```json
{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "at":1,
    "imp": [
        {
            "id": "90180978",
            "native": {
                "request":"{\"native\":{\"ver\":\"1.2\",\"plcmttype\":500,\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":1,\"w\":192,\"h\":192,\"wmin\":192,\"hmin\":192}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}}]}}",
                "ver": "1.2"
            },
            "secure": 1
        }
    ],
    "site": {
        "id": "12345",
        "domain": "sitedomain.com",
        "cat": ["IAB25-3"],
        "page": "https://sitedomain.com/page",
        "ext": {
            "exchangecat": 508,
            "idzone": 445566
        }
    },
    "device": {
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "ip": "192.0.2.1",
        "geo": {
            "country": "IRL"
        },
        "language": "en",
        "os": "Linux & UNIX",
        "osv": "",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "",
            "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2"
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
            }
    },
    "ext": {
        "sub": 445566
    }
}
```

**Push Notifications - 192 x 192 Bid Request Structure**

* [imp](#imp)
  * [imp.native](#impnative-native--push-notifications)
    * [imp.native.request](#impnativerequest)
      * [imp.native.request.assets](#impnativerequestassets)
        * [imp.native.request.assets.img](#impnativerequestassetsimg)
        * [imp.native.request.assets.title](#impnativerequestassetstitle)
        * [imp.native.request.assets.data](#impnativerequestassetsdata)
        * [imp.native.request.assets.video](#impnativerequestassetsvideo)
* [site](#site)
  * [site.ext](#siteext)
* [device](#device)
  * [device.geo](#devicegeo)
  * [device.ext](#deviceext)
* [user](#user)

<br>


---

# 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-request.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.
