BidRequest§3.2.1 · Bid Request
The top-level bid request object contains a globally unique bid request or auction ID. This id attribute is required as is at least one impression object (Section 3.2.4). Other attributes in this top-level object establish rules and restrictions that apply to all impressions being offered. There are also several subordinate objects that provide detailed data to potential buyers. Among these are the Site and App objects, which describe the type of published media in which the impression(s) appear. These objects are highly recommended, but only one applies to a given bid request depending on whether the media is browser-based web content or a non-browser application, respectively.
| Attribute | Type | Description |
|---|---|---|
| id required | string | Unique ID of the bid request, provided by the exchange. |
| imp required | object[] | Array of Imp objects (Section 3.2.4) representing the impressions offered. At least 1 Imp object is required. |
| site | object | Details via a Site object (Section 3.2.13) about the publisher's website. Only applicable and recommended for websites. |
| app | object | Details via an App object (Section 3.2.14) about the publisher's app (i.e., non-browser applications). Only applicable and recommended for apps. |
| device | object | Details via a Device object (Section 3.2.18) about the user's device to which the impression will be delivered. |
| user | object | Details via a User object (Section 3.2.20) about the human user of the device; the advertising audience. |
| test default 0 | integer | Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test mode. |
| at default 2 | integer | Auction type, where 1 = First Price, 2 = Second Price Plus. Exchange-specific auction types can be defined using values greater than 500. |
| tmax | integer | Maximum time in milliseconds the exchange allows for bids to be received including Internet latency to avoid timeout. This value supersedes any a priori guidance from the exchange. |
| wseat | string[] | White list of buyer seats (e.g., advertisers, agencies) allowed to bid on this impression. IDs of seats and knowledge of the buyer's customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions. |
| bseat | string[] | Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression. IDs of seats and knowledge of the buyer's customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions. |
| allimps default 0 | integer | Flag to indicate if Exchange can verify that the impressions offered represent all of the impressions available in context (e.g., all on the web page, all video spots such as pre/mid/post roll) to support road-blocking. 0 = no or unknown, 1 = yes, the impressions offered represent all that are available. |
| cur | string[] | Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes. Recommended only if the exchange accepts multiple currencies. |
| wlang | string[] | White list of languages for creatives using ISO-639-1-alpha-2. Omission implies no specific restrictions, but buyers would be advised to consider language attribute in the Device and/or Content objects if available. |
| bcat | string[] | Blocked advertiser categories using the IAB content categories. Refer to List 5.1. |
| badv | string[] | Block list of advertisers by their domains (e.g., "ford.com"). |
| bapp | string[] | Block list of applications by their platform-specific exchange independent application identifiers. On Android, these should be bundle or package names (e.g., com.foo.mygame). On iOS, these are numeric IDs. |
| source | object | A Source object (Section 3.2.2) that provides data about the inventory source and which entity makes the final decision. |
| regs | object | A Regs object (Section 3.2.3) that specifies any industry, legal, or governmental regulations in force for this request. |
| ext | object | Placeholder for exchange-specific extensions to OpenRTB. |
Field descriptions reconciled against the official 2.6 draft; 2.5-specific fields come from a third-party Go implementation source (Apache 2.0), proofread against the official PDF · first-draft proofreading