RTBlintAlpha
Menu

BidRequest object

BidRequest is the top-level object an exchange sends to bidders for each auction. It carries the request ID, one or more impressions in BidRequest.imp, the site, app, or DOOH context, device and user data, and rules that apply to every impression, such as auction type, timeout, currencies, and block lists.

24 fieldsOpenRTB 2.0 to 2.6-202606

How it is used

Only BidRequest.id and BidRequest.imp are required. The rest either describes the inventory, which bidders need in order to price it, or sets restrictions for the whole request. Exactly one of BidRequest.site, BidRequest.app, and BidRequest.dooh should describe the medium. The allow and block pairs (BidRequest.wseat with BidRequest.bseat, BidRequest.wlang with BidRequest.wlangb, BidRequest.acat with BidRequest.bcat) are meant to be used one side at a time.

The Bid request anatomy page covers it in more depth.

Fields

FieldTypeRequirementSinceStatus
acatstring arrayOptional2.6-202309Current
allimpsinteger, default 0Optional2.0Current
appobjectRecommended2.0Current
atinteger, default 2Optional2.0Current
badvstring arrayOptional2.0Current
bappstring arrayOptional2.4Current
bcatstring arrayOptional2.0Current
bseatstring arrayOptional2.5Current
cattaxinteger, default 1Optional2.6-202204Current
curstring arrayOptional2.0Current
deviceobjectRecommended2.0Current
doohobjectOptional2.6-202211Current
extobjectOptional2.0Current
idstringRequired2.0Current
impobject arrayRequired2.0Current
regsobjectOptional2.2Current
siteobjectRecommended2.0Current
sourceobjectOptional2.5Current
testinteger, default 0Optional2.3Current
tmaxintegerOptional2.0Current
userobjectRecommended2.0Current
wlangstring arrayOptional2.5Current
wlangbstring arrayOptional2.6-202204Current
wseatstring arrayOptional2.0Current

Where it sits

Contains: App, Device, DOOH, Imp, Regs, Site, Source, User.

All objects

The field reference index lists every OpenRTB 2.x object.