OpenRTB bid request requirements

Xandr supply partners must provide sufficient auction metadata on incoming bid requests to ensure that buyers have the information they need to bid intelligently. This page documents the OpenRTB fields required and the corresponding volume thresholds that need to be met. For example, a 95% threshold for the banner height field indicates that 95% of randomly sampled requests must contain information about the banner height. Traffic samples must meet the thresholds for all relevant fields. Inventory that does not meet the requirements outlined below will be eligible for selling through deals, but will not be made available on the open exchange.

Currently, we determine eligibility for the following formats:

• Web Banner
• Web Video
• Web Audio
• Web Native
• App Banner
• App Video
• App Audio
• App Native

The "web" designation includes both desktop web and mobile web;  "app" is defined as in-app inventory. Additional thresholds may be added in the future for other media types such as native or audio.

Bid request criteria and thresholds

The sections below outline the OpenRTB bid request fields that are required for each format. The "Required OpenRTB Field" column represents the IAB OpenRTB fields that correspond to the "Auction Attribute" in the first column. In cases where multiple OpenRTB fields are listed for a given auction attribute, only one of those fields is required. For example, in order for a request to pass the "Tag ID" criterion for "Web Banner Criteria", either site.id or imp.tagid needs to be passed.

Web banner criteria

Web video criteria

The following field values in bid requests must be internally consistent.

Web audio criteria

Web native criteria

App banner criteria

App video criteria

The following field values in bid requests must be internally consistent.

App audio criteria

App native criteria

Example bid requests

Web banner request

{
    "site": {
        "publisher": {
            "id": "534561625"
        },
        "domain": "publishersite.com",
        "id": "537123178",
        "page": "https://page.publishersite.com/path/to/page"
    },
    "imp": [
        {
            "banner": {
                "h": 250,
                "w": 300
            },
            "id": "7bbab3f3-83db-4b00-a82d-faa69fcbb5c5"
        }
    ],
    "device": {
        "os": "Windows",
        "make": "desktop",
        "dnt": 0,
        "ua": "Mozilla/5.0 (Windows NT 6.0; rv:50.0) Gecko/20100101 Firefox/50.0",
        "devicetype": 2,
        "model": "browser",
        "user": {
            "buyeruid": "8320715123477372344"
        },
        "id": "7bbab3f3-83db-4b00-a82d-faa69fcbb5c5"
    }
}

App banner requests

{
    "app": {
        "publisher": {
            "id": "537133097"
        },
        "bundle": "com.publisher.app",
                "domain": "publisher.com",
                "id": "537252150"
    },
    "imp": [
        {
            "banner": {
                "h": 250,
                "w": 300
            },
            "id": "a4d94cdc-3999-4708-9a6d-6ac01f6c07d4"
        }
    ],
    "device": {
        "os": "Android",
        "language": "en",
        "make": "generic",
        "dnt": 0,
        "ua": "Mozilla/5.0 (Linux; Android 4.4.2; GT-I9301I Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/30.0.0.0 Mobile Safari/537.36",
        "devicetype": 4,
        "ifa": "ffab2dd1-c6eb-4be9-b88b-1c24e431766d",
        "ip": "5.90.222.251",
        "model": "android phone"
    },
    "id": "a4d94cdc-3999-4708-9a6d-6ac01f6c07d4"
}

Web video requests

 {
    "site": {
        "publisher": {
            "id": "74964"
        },
        "domain": "publishersite.com",
        "id": "123456",
        "page": "page.publishersite.com/path"
    },
    "imp": [
        {
            "video": {
                "mimes": [
                    "video/x-flv",
                    "video/mp4",
                    "application/x-shockwave-flash"
                ],
                "api": [
                    1
                ],
                                "minbitrate": 1,
                                "maxbitrate": 2000,
                                "playbackmethod": [2],
                                "maxduration": 30,
                                "startdelay":0,
                                "protocols": [2, 5],
                "h": 360,
                "w": 480
            },
            "id": "1"
        }
    ],
    "device": {
        "language": "en",
        "os": "Windows 10",
        "make": "Google",
        "devicetype": 2,
        "ip": "24.171.153.60",
        "model": "Chrome - Windows",
        "ua": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.99 Safari/537.36"
    },
    "id": "32683827af9b11e6b43212a6e39f0001",
    "user": {
        "buyeruid": "6415517486677292084"
    }
}

App video requests

 {
    "app": {
        "publisher": {
            "id": "1100001685"
        },
        "bundle": "com.publisher.app",
        "domain": "publishersite.com",
        "id": "123456",
        "page": "page.publishersite.com/path"
    },
    "imp": [
        {
            "tagid": "130200094",
            "video": {
                                "mimes": [
                    "video/x-flv",
                    "video/mp4",
                    "application/x-shockwave-flash"
                ],
                "api": [
                    1
                ],
                                "minbitrate": 1,
                                "maxbitrate": 2000,
                                "playbackmethod": [2],
                                "maxduration": 30,
                                "startdelay":0,
                                "protocols": [2, 5],
                "h": 480,
                "w": 320
            }
        }
    ],
    "device": {
        "os": "Android",
        "ua": "Mozilla/5.0 (Linux; Android 6.0.1; SM-N920V Build/MMB29K; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/54.0.2840.85 Mobile Safari/537.36",
        "make": "Samsung",
        "devicetype": 1,
        "ifa": "C8A53AB8-D371-4955-BFDA-7805FA931E44",
        "model": "SM-N920V"
    },
    "id": "Nr4EZZiP5z"
}