Skip to main content
Categories
< All Topics
Print

Prebid / OpenRTB 2.5 Bid Request

Posted
Updated
ByParadox

Prebid Server / OpenRTB 2.5

This implementation supports both the regular OpenRTB 2.5 implementation and the Prebid Server implementation. In order to use the Prebid Server implementation, the campaign needs to be created with the Prebid Server template.

The Prebid Server implementation has an ext.prebid.storedrequest field where the id of the StoredRequest is provided. An example can be found in the specs below.

You can find more examples here.

Additional Privacy Fields

We have added additional fields regarding privacy, regs.ext.gdpr and user.ext.consent , which are compliant with the IAB privacy specifications (in the Advised Extensions section). There is more information about this here.

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
  • Data Encoding Header: Accept-Encoding

Bid Request 2.5

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

AttributeDescription
idUnique bid request ID (string)
siteDetails via a Site object about the publisher’s website(object).
deviceDetails via a Device object about the user’s device to which the impression will be delivered(object).
userDetails via a User object about the human user of the device; the advertising audience(object).
extPlaceholder for extensions to OpenRTB.

site

AttributeDescription
idUnique Site ID (string)
domainDomain name of the site (string)
catIAB category ID (string array)
pageFull URL of the page where the ad will be shown (string)
keywordsKeywords can be used to ensure ad zones get the right type of advertising. Keywords should be a string of comma-separated words
extPlaceholder for exchange-specific extensions

site.ext

AttributeDescription
exchangecatCustom Paradox category ID (integer)
idzoneCustom Paradox Ad Zone ID (integer)
keywordMatching keyword if any (string)

device

AttributeDescription
uaBrowser user agent (string)
geoLocation of the device assumed to be the user’s current location defined by a Geo object.
ipIP address of the user (string)*
ipv6IPv6 address of the user (string)*
languageBrowser language (string)
osOperating System (string)
jsSupport for JavaScript, where 0 = no, 1 = yes (integer)
extPlaceholder for exchange-specific extensions to OpenRTB

device.geo

AttributeDescription
countryCountry ISO3

device.ext

AttributeDescription
remote_addrMain IP address of the user (string)
x_forwarded_forX-FORWARDED-FOR IP address of the user or empty if not set (string)

user

AttributeDescription
idUnique 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)
prebidPrebid Server specific data (object)

user.ext.prebid

AttributeDescription
buyeruidsList of buyer uids (array)

ext.prebid.storedrequest

AttributeDescription
idUsed for stored request matching on partners servers format: sr_odadsrv_ (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.

Examples

Banner (Stored Request)

{
    "id": "c1218af9-65fc-4d55-9ad6-8795c2daad25",
    "site": {
        "domain": "bbakire.com",
        "page": "https:\/\/bbakire.com",
        "id": "776186",
        "cat": ["IAB25-3"],
        "ext": {
            "exchangecat": 508,
            "idzone": 4068539
        }
    },
    "device": {
        "ua": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/88.0.4324.96 Safari\/537.36",
        "ip": "10.42.0.1",
        "ipv6": "10.42.0.1",
        "geo": {
            "country": "XXX"
        },
        "language": "en",
        "os": "MacOS",
        "js": 1,
        "ext": {
            "remote_addr": "10.42.0.1",
            "x_forwarded_for": ""
        }
    },
    "regs": {
        "ext": {
            "gdpr": 0
        }
    },
    "user": {
        "id": "5fc94d61a66a37.821612521136907401",
        "ext": {
            "consent": "CO9A8QHPAbnHWBcADBENBJCoAAAAAAAAAAqIHKJU9VybLh0Dq4A170B0OAEYN_r_v40zigeds-8Myd-X3DsX50M7vFy6pr4AuR4km3CBIQFkHOmcTUmw6IkVrRPsak2Mr7NKJ7PEinsbe2dYEHtfn9VTuZKZr97s___zf_-___3_75f__-3_3_vp9UAAAABA5QAkgkDYAKAQRAAJIwKhQAhAuJDoBAAUUIwtE1hASuCmYVAR-ggYAIDUBGAECDEEGIIIAAAAAkgiAkAPBAAgCIBAACAFSAhAARoAgsAJAwCAAUA0LACKAIQJCDI4KjlICAiRaKCeSMASi72MMIQSigAAAAAAAA",
            "prebid": {
                "buyeruids": {
                    "platform1": "C9446DA7-BB76-44B9-B260-77E16530AA03",
                    "platform2": "6372709574547581900",
                    "platform3": "456621142600017315",
                    "platform4": "3952063610783032691",
                    "platform5": "KX3KMRTI-11-ZMP",
                    "platform6": "402e4b19ff476fb23de2c97ebe62a47b",
                    "platform7": "bu7zD7LkVT2huSwTSvou"
                }
            }
        }
    },
    "tmax": 3000,
    "ext": {
        "prebid": {
            "storedrequest": {
                "id": "sr_odadsrv_zone_<idzone>"
            }
        }
    }
}

Banner Bid Request Structure

  • site
    • site.ext
  • device
    • device.geo
    • device.ext
  • regs.ext
  • user
Table of Contents
Translate »