Prebid Server Bid Request

This is the top level object that is sent by the SSP. Each bid request should contain the following fields.

Note

  • Fields marked with an asterisk (*) are optional.

Bid Request Object Properties

Value

Type

Description

id

string

Unique ID of the bid request, for example, "b5ba5ed2-547e-4e86-8a84-34a440dad6db"

imp

array of objects

Array of objects representing the impressions offered.

device

object

Device object with details about the device to which the impression will be delivered.

user*

object

User Object which describes the 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"]. The default is ["USD"].

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.

site*

object

The object describing the site. Either Site or App must be present.

app*

object

The object describing the mobile application. Either Site or App must be present.

publisher*

object

The object describing the publisher.

badv*

array of strings

Array of strings of blocked top-level domains of advertisers, for example, ["mysite.com", "mysite2.com"]

bcat*

array of strings

Blocked Advertiser Categories, using the IAB taxonomy. 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"]

wseat*

array of strings

An array of buyer seats allowed to bid on this auction, for example [58, 61, 99].

regs*

object

A regulations object that specifies any industry, legal, or governmental regulations in force for this request.

ext*

object

Ext Object used for Supplier specific properties.