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.
Value |
Type |
Description |
---|---|---|
id |
string |
(Required) Unique ID of the bid request, provided by BidSwitch, for example,
|
tmax |
integer |
Maximum time in milliseconds the exchange allows for bids to be received to
avoid timeout, including internet latency, for example, |
at |
integer |
Auction type, the default value is
|
cur |
array of strings |
Array of allowed currencies for bids on this bid request using ISO-4217
alpha codes, for example, |
seat* |
array of strings |
An array of Buyer seats allowed to bid on this auction, for example
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* |
int |
Indicates whether the
|
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 |
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 |
All Request Fields
- Source Object
- Request Extension
- Ads.txt Object
- Item Object
- Deal Object
- Item Metric
- Item Spec
- Item Placement
- Display Placement
- Display Event
- Native Display
- Video Placement
- Audio Placement
- Companion Ad
- Context Object
- Regulations Context
- Restrictions Context
- Site Context
- App Context
- DOOH Context
- Publisher Object
- User Context
- Device Context
- Geo Context
- User Data Context
- Bid Request JSON Examples