Bid Request v3.0

This is the top level object that is sent to the Buyer. Each bid request sent from BidSwitch to a Buyer will contain all of the fields marked with (Required). Many optional and (Recommended) fields will also be included depending in the situation.

Bid Request Object Properties
Value Type Description
id string (Required) Unique ID of the bid request, provided by BidSwitch, for example, "b5ba5ed2-547e-4e86-8a84-34a440dad6db"
tmax integer Maximum time in milliseconds the exchange allows for bids to be received to avoid timeout, including internet latency, for example, 120.
at integer

Auction type, the default value is 2.

  • 1: the first price auction
  • 2: the second price auction
  • Note: There is an additional auction type field, item.ext.at, used to pass other values and signals, see the Item Object section for more details
cur array of strings Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes, for example, ["USD", "EUR"]
seat* 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 seat field, for more details see the Seat Bid Object section.

wseat* int

Indicates whether the seat field is a black or white list of Buyer IDs.

  • 0 means black List
  • 1 means a white list, and is the default
  • Hint: Also please take note of how a wseat field is used differently in the item.deal object.
source* object Indicates the entity responsible for the final impression sale decision, see the Source Object.
item Array of Objects (Required) An array of objects containing the details of the items for auction, see the Item Object section. For BidSwitch, there is a maximum of 5 items within this array per request.
package* int Flag to indicate if the Exchange can verify that the items offered represent all of the items available in context (e.g., all impressions on a web page, all video spots such as pre/mid/post roll) to support road-blocking, where 0 = no, 1 = yes.
context* object (Required) Contains the context of the inventory up for auction, i.e. the site, app, or dooh object along with the user, device, regs, restrictions and others, see Context Object