Bid Request v5.3¶

This is the top level object that is sent to the Buyer. Each bid request sent from BidSwitch to a Buyer will contain the following fields.

Note

Fields marked with asterisk (*) are optional.

Bid Request Object Properties¶
Value	Type	Description
id	string	Unique ID of the bid request, provided by BidSwitch, for example, `"b5ba5ed2-547e-4e86-8a84-34a440dad6db"`
imp	array of objects	Array of objects representing the impressions offered, for more information, see the Impression Object section.
device	object	Device object with details about the device to which the impression will be delivered, for more information, see the Device Object section.
user	object	User Object which describes the user, for more information, see the User Object section. Note: In the even that a user has opted-out under the GDPR or CCPA, this will be passed as an empty object, e.g. `"user":{}`
tmax	integer	Maximum time in milliseconds the exchange allows for bids to be received to avoid timeout, including internet latency, for example, `120`.
cur	array of strings	Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes, for example, `["USD", "EUR"]`
ext	object	Ext Object used for Supplier specific properties, for more information, see the Ext Object section.
at*	integer	Auction type, the default value is `2`. `1`: the first price auction. `2`: the second price auction.
source*	object	Indicates the entity responsible for the final impression sale decision, see the Source Object.
site*	object	The Site Object describing the site. One of these objects should be present in the request: `site`, `app`, `ext.tv`, or `ext.dooh`.
app*	object	The App Object describing the mobile application. One of these objects should be present in the request: `site`, `app`, `ext.tv`, or `ext.dooh`.
bcat*	array of strings	Blocked Advertiser Categories, using the IAB taxonomy, and extended with additional sensitive categories listed in the Sensitive Categories and Rich Media section. Creatives belonging to at least one of the listed categories are not permitted for bidding in the current bid request, for example `["IAB10-1", "IAB25", "BSW3"]`
badv*	array of strings	Array of strings of blocked top-level domains of advertisers, for example, `["mysite.com", "mysite2.com"]`
bapp*	array of strings	A list of applications blocked from being advertised, specified using their their platform-specific identifiers, i.e. the app bundle ID. On Android, these should be app bundle and on iOS numeric IDs e.g. `["com.app.example", "012987652"]`
wseat*	array of strings	An array of Buyer seats allowed to bid on this auction, for example `["58", "61", "99"]`. If this field is present, the specified seat IDs may be supplied using BidSwitch or Supplier taxonomy. A bid request may contain multiple seat IDs using the Supplier taxonomy. The bid response should contain the appropriate seat value corresponding to one of the values of the `wseat` field, for more details see the Seat Bid Object section.
bseat*	array of strings	An array of Buyer seats disallowed to bid on this auction, for example `["58", "61", "99"]`. If this field is present, it can be assumed that the Seat IDs refer to agency buyers, because if the BidSwitch Buyer ID is set in the original Supplier request, it is not sent to the DSP. The `wseat` field takes precedence, so if the same value is in both fields the request is sent to the Buyer.
allimps*	integer	A flag to indicate if the Supplier 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.
regs*	object	A regulations object that specifies any industry, legal, or governmental regulations in force for this request, for more information, see the Regs Object section.