BidRequest§3.2.1 · Bid Request
The top-level bid request object contains an exchange 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, App and DOOHobjects, 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, a non-browser application, or Digital Out of Home inventory respectively.
| Attribute | Type | Description |
|---|---|---|
| id required | string | ID of the bid request, assigned by the exchange, and unique for the exchange’s subsequent tracking of the responses. The exchange may use different values for different recipients. |
| 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. |
| dooh | object | This object should be included if the ad supported content is a Digital Out-Of-Home screen. A bid request with a DOOH object must not contain a site or app object. |
| 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 500 and greater. |
| 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[] | Allowed 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[] | Allowed 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. Only one of wlang or wlangb should be present. |
| wlangb | string[] | Allowed list of languages for creatives using IETF BCP 47I. Omission implies no specific restrictions, but buyers would be advised to consider language attribute in the Device and/or Content objects if available. Only one of wlang or wlangb should be present. |
| acat | string[] | Allowed advertiser categories using the specified category taxonomy. The taxonomy to be used is defined by the cattax field. If no cattax field is supplied IAB Content Taxonomy 1.0 is assumed. Only one of acat or bcat should be present. |
| bcat | string[] | Blocked advertiser categories using the specified category taxonomy. The taxonomy to be used is defined by the cattax field. If no cattax field is supplied IAB Content Taxonomy 1.0 is assumed. Only one of acat or bcat should be present. |
| cattax default 1 | integer | The taxonomy in use for bcat. Refer to the AdCOM 1.0 list List: Category Taxonomies for values.Enum Category Taxonomies · 10 values1IAB Tech Lab Content Category Taxonomy 1.0: Deprecated, and recommend NOT be used since it does not have SCD flags. 2IAB Tech Lab Content Category Taxonomy 2.0: Deprecated, and recommend NOT be used since it does not have SCD flags. 3IAB Tech Lab Ad Product Taxonomy 1.0. 4IAB Tech Lab Audience Taxonomy 1.1 5IAB Tech Lab Content Taxonomy 2.1 6IAB Tech Lab Content Taxonomy 2.2 7IAB Tech Lab Content Taxonomy 3.0 8IAB Tech Lab Ad Product Taxonomy 2.0 9IAB Tech Lab Content Taxonomy 3.1 500+Vendor-specific codes. |
| badv | string[] | Block list of advertisers by their domains (e.g., “ford.com”). |
| bapp | string[] | Block list of applications by their app store IDs. See OTT/CTV Store Assigned App Identification Guidelines for more details about expected strings for CTV app stores. For mobile apps in Google Play Store, these should be bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID. |
| 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 are published in the official IAB Tech Lab OpenRTB 2.6 spec (CC-BY 3.0) · enumeration values sourced from AdCOM 1.0 · first-draft proofreading