OpenRTB Objects

This is a list of the objects (and their attributes) that AdButler includes in OpenRTB bid requests.

There's also a sample bid request at the bottom of the page.

For more information on OpenRTB objects, read IAB's OpenRTB API Specification (PDF).

App
Banner
BidRequest
Content
Deal
Device
Geo
Imp
Metric
Pmp
Publisher
Regs
Site
Source
SupplyChain
SupplyChainNode
User
Video


App
id Endpoint parameter App ID
name included when using mobile SDK
bundle included when using mobile SDK
domain included when using mobile SDK
storeurl included when using mobile SDK
cat zone programmatic settings (IAB categories), plus categories specified by request parameter taxonomy
ver included when using mobile SDK
publisher included
content included

Back to top


format a list of the demand endpoint sizes for a dynamic zone, or the zone size for a fixed-size standard zone
w the ad item width specified by the zone, or width request parameter
h the ad item height specified by the zone, or height request parameter
btype [1] (XHTML Text Ad)
api API frameworks from zone programmatic settings, or the apiFrameworks request parameter
video included in VAST requests
secure 1 if requested with https, 0 if requested with http
pmp included

Back to top


BidRequest
id included
at 1 (First Price)
tmax included
imp included
app included when using mobile API
site included when not using mobile API
device included
user included
source included
Regs included

Back to top


Content
cat request parameter taxonomy
language request parameter lang (default: en)
keywords if endpoint parameter include keywords is enabled, then included with request param kw plus page keywords

Back to top


Deal
id included
bidfloor PMP deal settings
wseat PMP deal settings

Back to top


Device
ua included
geo included
dnt request parameter dnt
lmt request parameter dnt
ip included
devicetype request parameter rtbDeviceType, or populated from user agent
make included when using mobile SDK
model included when using mobile SDK
os included when using mobile SDK
osv included when using mobile SDK
w request parameter sw
h request parameter sh
pxratio request parameter spr (default: 1)
language request parameter lang (default: en)
carrier included when using mobile SDK
mccmnc included when using mobile SDK
ifa included when using mobile SDK

Back to top


Geo
lat included
lon included
type included
city included
region included
country included

Back to top


Imp
id included
instl 0
bidfloor populated by endpoint parameter (bid floor)
metric included
banner included on standard zone requests
video included on VAST requests
secure 1 if requested with https, 0 if requested with http
pmp included

Back to top


Metric
No fields included

Back to top


Pmp
private_auction PMP deal settings
deals included

Back to top


Publisher
id included

Back to top


Regs
coppa Request parameter: coppa (default: 0)
ext
- gpdr Request parameter: gdpr_applies (default: not sent unless specified)

Back to top


Site
id included
name sitename request parameter
domain included
cat zone programmatic settings (IAB categories), plus categories specified by request parameter taxonomy
pagecat request parameter ortb_page_cat
sectioncat request parameter ortb_section_cat
publisher included
content included
keywords included if endpoint parameter include keywords is disabled

Back to top


SupplyChain
complete
nodes
ver
ext
You need to set a seller domain (Settings > Features & Organization Preferences > RTB Seller Domain) to include this object to OpenRTB requests. If you already have a supply chain, you can pass it as a JSON encoded object in this parameter.

Back to top


SupplyChainNode
asi
sid
hp
ext
rid
name
domain
You need to set a seller domain (Settings > Features & Organization Preferences > RTB Seller Domain) to include this object to OpenRTB requests.

Back to top


Source
fd 0 (Exchange)

Back to top


User
yob included when using mobile SDK
gender included when using mobile SDK

Back to top


Video
mimes VAST zone programmatic settings (default: ['video/mp4'])
skip VAST zone programmatic settings
boxingallowed VAST zone programmatic settings
protocols [2, 3, 5, 6] VAST 2, 3, 4 and VAST 2, 3, 4 wrappers
minduration VAST zone programmatic settings
maxduration VAST zone programmatic settings
w VAST zone programmatic settings (player width)
h VAST zone programmatic settings (player height)
startdelay VAST zone programmatic settings
linearity VAST zone programmatic settings
skip VAST zone programmatic settings
skipmin VAST zone programmatic settings
skipafter VAST zone programmatic settings
minbitrate VAST zone programmatic settings
maxbitrate VAST zone programmatic settings
apiFrameworks VAST zone programmatic settings
placement VAST zone programmatic settings

Back to top


Sample OpenRTB bid request

{
    "id": "10011_104369_0_1634241004",
    "at": 1,
    "tmax": 800,
    "imp": [
        {
            "id": "1",
            "instl": 0,
            "ext": {
                "s2s_nurl": 1
            },
            "bidfloor": 0.5,
            "metric": [],
            "banner": {
                "w": 300,
                "h": 250,
                "btype": [
                    1
                ],
                "format": [
                    {
                        "w": 300,
                        "h": 250
                    }
                ],
                "api": [
                    3,
                    5,
                    6,
                    4
                ]
            },
            "secure": 1,
            "pmp": {}
        }
    ],
    "site": {
        "id": "example_bundle_id",
        "cat": [
            "IAB1",
            "IAB4",
            "IAB22"
        ],
        "sectioncat": [
            "IAB1",
            "IAB2"
        ],
        "pagecat": [
            "IAB3",
            "IAB4"
        ],
        "publisher": {
            "id": "4841"
        },
        "content": {
            "keywords": "keyword1,keyword2,keyword",
            "language": "en"
        }
    },
    "device": {
        "js": 1,
        "ua": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:94.0) Gecko\/20100101 Firefox\/94.0",
        "geo": {},
        "dnt": 0,
        "lmt": 0,
        "ip": "1.1.1.1",
        "devicetype": 2,
        "pxratio": 1,
        "language": "en"
    },
    "user": {
        "ext": {
            "consented_providers_settings": {
                "consented_providers": []
            }
        }
    },
    "source": {
        "fd": 0,
        "ext": {
            "schain": {
                "ver": "1.0",
                "complete": 0,
                "nodes": [
                    {
                        "asi": "domain.com",
                        "sid": "1234",
                        "rid": "63_85820_1571331626",
                        "hp": 1
                    }
                ]
            }
        }
    },
    "regs": {
        "coppa": 0
    },
    "ext": {
        "zone_list": [
            104369
        ]
    }
}

Back to top


Can't find what you're looking for?

Send us an email

hello@adbutler.com

Visit the blog

For more ad serving tips, industry news and AdButler insights.