Documentation

Documentation

  • General
  • Advertisers
  • Publishers
  • RTB
  • API
  • News

›Open RTB

Advertisers

  • Advertisers RTB Overview
  • Ad Exchange Partners
  • Integrating Advertising Demand
  • Open RTB

    • Open RTB Integration
    • Open RTB 2.4 Bid Request
    • Open RTB 2.4 Bid Response
    • Open RTB 2.5 Bid Request
    • Open RTB 2.5 Bid Response
    • Prebid / OpenRTB 2.5 Bid Request
    • Prebid / OpenRTB 2.5 Bid Response

    EXADS RTB

    • EXADS RTB Integration
    • EXADS RTB Bid Request
    • EXADS RTB Bid Response

Publishers

  • Publishers RTB Overview
  • Ad Exchange Partners
  • Integrating Publishing Supply
  • Open RTB

    • Open RTB Integration
    • Open RTB 2.4 Bid Request
    • Open RTB 2.4 Bid Response
    • Open RTB 2.5 Bid Request
    • Open RTB 2.5 Bid Response
    • Prebid / Open RTB 2.5 Bid Request
    • Prebid / Open RTB 2.5 Bid Response

    EXADS RTB

    • EXADS RTB Integration
    • EXADS RTB Bid Request
    • EXADS RTB Bid Response

IP Networks

  • IP Networks

Open RTB 2.5 Bid Request

Suggested Bid Request Headers

  • OpenRTB Version HTTP Header: x-openrtb-version: 2.5
  • Keep-Alive HTTP Header: Connection: Keep-Alive
  • Content JSON: Content-Type: application/json

The following objects should be sent encoded as JSON in the request body:  

Bid Request

AttributeRequired?Description
atYesAuction type, first price = 1 (int)
idYesUnique bid request ID (string)
impYesArray of Imp objects representing the impressions offered(object).
siteYesDetails via a Site object about the publisher’s website(object).
deviceYesDetails via a Device object about the user’s device to which the impression will be delivered(object).
userNoDetails via a User object about the human user of the device; the advertising audience(object).
bcatNoBlocked advertiser categories using the IAB content categories (string array)
extNoPlaceholder for extensions to OpenRTB.

 

imp

AttributeRequired?Description
idYesUnique impression ID within this bid request (string)
bidfloorNoMinimum bid for this impression (CPM) / click (CPC) and account currency, optional (float).
bannerOnly for banner impsA banner object ; required if this impression is offered as a banner ad opportunity(object).
secureNo; Recommended 1Flag 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)

 

imp.banner

AttributeRequired?Description
wYesWidth of the banner (integer)
hYesHeight of the banner (integer)

 

imp.full-page-interstitial

AttributeRequired?Description
wYesWidth of the banner (integer)
hYesHeight of the banner (integer)
mimesYesMimes types - image/jpg, image/png, video/mp4 or image/webp

 

imp.instl

AttributeDescription
instlFlag specifying if ad is popunder/interstitial (integer): 1=true, 0=false

 

imp.native (for Native and Push Notification Ads)

AttributeRequired?Description
requestYesRequest payload complying with the Native Ad Specification - a JSON encoded string of the Native Ads request including its native top level object (JSON object)
verNoVersion of the Dynamic Native Ads API to which request complies (string)

 

imp.native.request

AttributeRequired?Description
nativeYesContainer for a payload complying with the Native Ad Specification - a JSON encoded string of the Native Ads request

 

imp.native.request.native

AttributeRequired?Description
verYesVersion of the Native Markup version in use (string)
contextNoThe 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)
plcmttypeYesThe design/format/layout of the ad unit being offered. Currently we support 4 (Recommendation widget) and 500 (Push Notification) (integer)
plcmtcntNoThe number of identical placements in this Layout (integer)
assetsYesAn array of Asset Objects. Any bid response must comply with the array of elements expressed in the bid request (array of JSON objects)
seqNo0 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.native.assets

AttributeRequired?Description
idYesUnique asset ID, assigned by exchange. Typically a counter for the array (integer)
requiredNoSet to 1 if asset is required or 0 if asset is optional (integer)
plcmtcntNoThe number of identical placements in this Layout (integer)
imgYesImage object for image assets* (JSON object)
titleNoTitle object for title assets* (JSON object)
dataNoData object for brand name, description, ratings, prices etc.* (JSON object)
videoNoVideo 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

 

imp.native.request.native.assets.img

AttributeRequired?Description
typeNoType ID of the image element supported by the publisher. We support: 1 (Icon image) (integer), 3 (Large image preview for the ad) (integer)
wNoWidth of the image in pixels, optional (integer)
hNoHeight of the image in pixels, optional (integer)
wminYesThe minimum requested width of the image in pixels (integer)
hminYesThe minimum requested height of the image in pixels (integer)

*Push Notification icon dimensions: 192px x 192px

 

imp.native.request.native.assets.title

AttributeRequired?Description
lenYesMaximum length of the text in the title element. (integer)

 

imp.native.request.native.assets.data

AttributeRequired?Description
typeYesType 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)
lenNoMaximum length of the text in the element's response (integer)

 

imp.native.request.native.assets.video

AttributeRequired?Description
mimesYesList of supported mime types (string array)
mindurationYesMinimum video ad duration in seconds(integer).
maxdurationYesMaximum video ad duration in seconds(integer).
protocolsYesList of supported video bid response protocols (int array)
linearityRequired for in-stream ads only.Indicates if the impression must be linear, nonlinear, etc. (integer)
boxingallowedRequired for in-stream ads only.Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed (integer)

 

imp.video

AttributeRequired?Description
mimesYesList of supported mime types (string array)
protocolsYesList of supported video bid response protocols (int array)
skipNoIndicates if the player will allow the video to be skipped, where 0 = no, 1 = yes
skipminNoVideos of total duration greater than this number of seconds can be skippable
skipafterNoNumber of seconds a video must play before skipping is enabled

 

site

AttributeRequired?Description
idRecommendedUnique Site ID (string)
nameNo*Site name (string)
domainRecommendedDomain name of the site (string)
catNoIAB category ID (string array)
pageRecommendedFull URL of the page where the ad will be shown (string)
keywordsNoKeywords can be used to ensure ad zones get the right type of advertising. Keywords should be a string of comma-separated words

* Recommended when RTB Inventory is enabled.


 

site.ext

AttributeRequired?Description
exchangecatNoCustom EXADS category ID (integer)
idzoneNoCustom EXADS Ad Zone ID (integer)

 

app

AttributeRequired?Description
idRecommendedUnique App ID (string)
nameNo*App name (string)
domainRecommendedDomain name of the app (string)
catNoIAB category ID (string array)
pagecatNoIAB category ID (string array)
keywordsNoKeywords can be used to ensure ad zones get the right type of advertising. Keywords should be a string of comma-separated words (string)
publisherNoDetails about the Publisher (object)

Note: Only one of the objects {site, app} should be present in each request.

* Recommended when RTB Inventory is enabled.


 

device

AttributeRequired?Description
uaYesBrowser user agent (string)
suaNoStructured user agent information, which can be used when a client supports User-Agent Client Hints (object)
geoNoLocation of the device assumed to be the user’s current location defined by a Geo object.
ipConditional*IPv4 address of the user (string)
ipv6Conditional*IPv6 address of the user (string)
languageRecommendedBrowser language (string)
osNoOperating System (string)
jsNoSupport for JavaScript, where 0 = no, 1 = yes (integer)
extNoPlaceholder for exchange-specific extensions to OpenRTB

*Condition: Exactly one of ip or ipv6 must be included in the request (not both).

 

device.geo

AttributeRequired?Description
countryNoCountry ISO3

 

device.ext

AttributeRequired?Description
remote_addrNoMain IP address of the user (string)
x_forwarded_forNoX-FORWARDED-FOR IP address of the user or empty if not set (string)

 

device.sua

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

AttributeRequired?Description
browsersRecommendedImplementers should send brands and versions derived from the Sec-CH-UA-Full-Version-List header. (Array of BrandVersion objects)
platformRecommendedImplementers should send a brand derived from the Sec-CH-UA-Platform header, and version derived from the Sec-CH-UA-Platform-Version header. (BrandVersion Object)
mobileRecommendedImplementers should derive this value from the Sec-CH-UA-Mobile header. (integer)
architectureRecommendedImplementers should retrieve this value from the Sec-CH-UA-Arch header. (string)
bitnessRecommendedImplementers should retrieve this value from the Sec-CH-UA-Bitness header. (string)
modelRecommendedImplementers should retrieve this value from the Sec-CH-UA-Model header. (string)
sourceRecommendedThe source of data used to create this object, List: User-Agent Source in AdCOM 1.0 (integer; default 0)

 

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

AttributeRequired?Description
brandRequiredThe 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)
versionRecommendedA sequence of version components, in descending hierarchical order [major, minor, micro, …] (array of string)

 

user

AttributeRequired?Description
idNoUnique user ID (string)

 

user.ext

AttributeDescription
consentuser.ext.consent: This is the consent string required by the IAB standards. Negative consent only for now (string)

 

regs.ext

AttributeDescription
gdprregs.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

AttributeRequired?Description
subNoThe Sub ID. This should be a number between six and ten digits: Do not use zeroes at the beginning of Sub IDs.

Examples

Banner

{
   "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
   "at": 1,
   "imp": [
      {
         "id": "974090632",
         "banner": {
            "w": 300,
            "h": 250
         }
      }
   ],
   "site": {
      "id": "12345",
      "domain": "sitedomain.com",
      "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",
      "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",
      "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": "57592f333f8983.043587162282415065",
      "ext": {
         "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA"
      }
   },
   "ext": {
      "sub": 1221
   }
}

 

Banner Bid Request Structure

  • imp
    • imp.banner
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
  • user

 

Desktop Full Page Interstitial

{
    "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",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "192.0.2.1"
        }
    },
    "user": {
        "id": "57592f333f8983.043587162282415065"
    },
    "ext": {
        "sub": 1221
    }
}

 

Full Page Interstitial

  • imp
    • imp.full-page-interstitial
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
  • user

 

Mobile Full Page Interstitial

{
    "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": "Linux & UNIX",
        "js": 0,
        "ext": {
            "remote_addr": "192.0.2.1",
            "x_forwarded_for": "192.0.2.1"
        }
    },
    "user": {
        "id": "57592f333f8983.043587162282415065"
    },
    "ext": {
        "sub": 1221
    }
}

 

Full Page Interstitial

  • imp
    • imp.full-page-interstitial
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
  • user

 

Email Clicks

{
   "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
   "at": 1,
   "imp": [
      {
         "id": "974090632",
         "instl": 0,
         "el": "dGVzdGVAZW1haWwuY29t",
         "bidfloor": 0.035
      }
   ],
   "site": {
      "id": "12345",
      "domain": "sitedomain.com",
      "name": "site domain",
      "cat": ["IAB25-3"],
      "page": "https://sitedomain.com/page",
      "keywords": "lifestyle, humour",
      "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": "PRT"
      },
      "language": "en",
      "os": "Linux & UNIX",
      "js": 0,
      "ext": {
         "remote_addr": "192.0.2.1",
         "x_forwarded_for": "192.0.2.1"
      }
   },
   "user": {
      "id": "57592f333f8983.043587162282415065"
   },
   "ext": {
      "sub": 1221
   }
}

 

Email Clicks Bid Request Structure

  • imp
    • imp.instl
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
    • device.sua
  • user
  • ext

 

Popunder

{
   "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
   "at": 1,
   "imp": [
      {
         "id": "974090632",
         "instl": 1
      }
   ],
   "site": {
      "id": "12345",
      "domain": "sitedomain.com",
      "cat": ["IAB25-3"],
      "page": "https://sitedomain.com/page",
      "keywords": "lifestyle, humour",
      "pagecat": ["IAB25-3"]
   },
   "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",
      "js": 0,
      "ext": {
         "remote_addr": "192.0.2.1",
         "x_forwarded_for": "192.0.2.1"
      }
   },
   "user": {
      "id": "57592f333f8983.043587162282415065"
   },
   "ext": {
      "sub": 1221
   }
}

 

Popunder Bid Request Structure

  • imp
    • imp.instl
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
    • device.sua
  • user
  • ext

 

Direct Links

{
   "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
   "at": 1,
   "imp": [
      {
         "id": "974090632",
         "instl": 0,
         "el": "dGVzdGVAZW1haWwuY29t",
         "bidfloor": 0.035,
         "bidfloorcur": "EUR"
      }
   ],
   "site": {
      "id": "12345",
      "domain": "sitedomain.com",
      "cat": ["IAB25-3"],
      "page": "https://sitedomain.com/page",
      "keywords": "lifestyle, humour",
      "pagecat": ["IAB25-3"],
      "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": "PRT"
      },
      "language": "en",
      "os": "Linux & UNIX",
      "js": 0,
      "ext": {
         "remote_addr": "192.0.2.1",
         "x_forwarded_for": "192.0.2.1"
      }
   },
   "user": {
      "id": "57592f333f8983.043587162282415065"
   },
   "ext": {
      "sub": 1221
   }
}

 

Direct Links Bid Request Structure

  • imp
    • imp.instl
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
    • device.sua
  • user
  • ext

 

Native

{
   "id": "7a452540-c8c9-43ca-9d30-ab9d8bfd17a4",
   "at": 1,
   "imp": [
      {
         "id": "2d099176-9feb-44e9-85f9-f385b34123a1",
         "native": {
         "request": "{\"native\":{\"ver\":\"1.2\"\n,\"context\":1\n,\"contextsubtype\":10\n,\"plcmttype\":4\n,\"plcmtcnt\":4\n,\"assets\":[{\"id\":1,\"required\":1,\"title\":{\"len\":124}},{\"id\":2,\"data\":{\"type\":1,\"len\":50}},{\"id\":3,\"required\":1,\"img\":{\"type\":3,\"wmin\":150,\"hmin\":150}}]\n}}",
         "ver": "1.2"
         },
         "tagid": "2812",
         "bidfloor": 0.035,
         "secure": 1
      }
   ],
   "site": {
      "id": "2812",
      "domain": "example.com",
      "keywords": "lifestyle, humour",
      "page": "https://example.com/",
      "mobile": 1
   },
   "device": {
      "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 11_4_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15G77 Version/11.4.1 Safari/604.1 AlohaBrowser/2.10.0b17",
      "sua": {
         "architecture": "arm",
         "bitness": "64",
         "model": "iPhone",
         "mobile": 1,
         "source": 2,
         "platform": {
         "brand": "iOS",
         "version": [
            "11",
            "4",
            "1"
         ]
         },
         "browsers": [
         {
            "brand": "Mobile Safari",
            "version": [
               "11",
               "4",
               "1"
            ]
         }
         ]
      },
      "ip": "192.0.2.1",
      "js": 1,
      "language": "en"
   },
   "user": {
      "id": "37d1951a-7184-4b7f-b227-5571a1ea7467"
   },
   "ext": {
      "sub": 1221
   }
}

Native Bid Request Structure

  • imp
    • imp.native
      • imp.native.request
        • imp.native.request.native
          • imp.native.request.native.assets
            • imp.native.request.native.assets.img
            • imp.native.request.native.assets.title
            • imp.native.request.native.assets.data
            • imp.native.request.native.assets.video
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
    • device.sua
  • user
  • ext

 

Push Notifications - 192 x 192

{
   "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",
      "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",
      "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": "57592f333f8983.043587162282415065"
   },
   "ext": {
      "sub": 1221
   }
}

 

Push Notifications - 192 x 192 Bid Request Structure

  • imp
    • imp.native
      • imp.native.request
        • imp.native.request.native
          • imp.native.request.native.assets
            • imp.native.request.native.assets.img
            • imp.native.request.native.assets.title
            • imp.native.request.native.assets.data
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
    • device.sua
  • user
  • ext

 

Push Notifications - 720 x 480

{
   "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",
      "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",
      "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": "57592f333f8983.043587162282415065"
   },
   "ext": {
      "sub": 1221
   }
}

 

Push Notifications - 720 x 480 Bid Request Structure

  • imp
    • imp.native
      • imp.native.request
        • imp.native.request.native
          • imp.native.request.native.assets
            • imp.native.request.native.assets.img
            • imp.native.request.native.assets.title
            • imp.native.request.native.assets.data
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
    • device.sua
  • user
  • ext

 

In-Stream Video, Outstream Video, Video Slider

{
   "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
   "at": 1,
   "imp": [
      {
         "id": "974090632",
         "video": {
               "mimes": ["video/mp4"],
               "protocols": [
                  3,
                  6
               ]
         },
         "ext": {
               "video_cta": 0
         }
      }
   ],
   "site": {
      "id": "12345",
      "domain": "sitedomain.com",
      "cat": ["IAB25-3"],
      "page": "https://sitedomain.com/page",
      "keywords": "lifestyle, humour",
      "pagecat": ["IAB25-3"],
      "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": "PRT"
      },
      "language": "en",
      "os": "Linux & UNIX",
      "js": 0,
      "ext": {
         "remote_addr": "192.0.2.1",
         "x_forwarded_for": "192.0.2.1"
      }
   },
   "user": {
      "id": "57592f333f8983.043587162282415065"
   },
   "ext": {
      "sub": 1221
   }
}

 

In-Stream Video, Outstream Video, Video Slider Bid Request Structure

  • imp
    • imp.video
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
    • device.sua
  • user
  • ext

 

← Open RTB 2.4 Bid ResponseOpen RTB 2.5 Bid Response →
  • Suggested Bid Request Headers
  • Bid Request
  • imp
    • imp.banner
    • imp.full-page-interstitial
    • imp.instl
    • imp.native (for Native and Push Notification Ads)
    • imp.native.request
    • imp.native.request.native
    • imp.native.request.native.assets
    • imp.native.request.native.assets.img
    • imp.native.request.native.assets.title
    • imp.native.request.native.assets.data
    • imp.native.request.native.assets.video
    • imp.video
  • site
    • site.ext
  • app
  • device
    • device.geo
    • device.ext
    • device.sua
  • user
    • user.ext
    • regs.ext
  • ext
  • Examples
    • Banner
    • Desktop Full Page Interstitial
    • Mobile Full Page Interstitial
    • Email Clicks
    • Popunder
    • Direct Links
    • Native
    • Push Notifications - 192 x 192
    • Push Notifications - 720 x 480
    • In-Stream Video, Outstream Video, Video Slider
Documentation
Community
Github
Useful Links
EXADS
Copyright © 2026 EXADS