Bid Request Specification

❗️

Note

BidMachine Ad Exchange currently works with openRTB 2.3 and 2.5. This documentation is only valid for openRTB 2.3.

Bid Request Object Properties

Attribute

Type

Description

Example

id

string

Unique ID of the bid request, provided by the exchange.

d5260eec-75d9-4f7d-86bc-22b01b4c779e

imp

object array

Array of Imp objects representing the impressions offered.

At least 1 Imp object is required.

app

object

Details about the publisher’s app (i.e., non-browser applications).

Only applicable and recommended for apps.

device

object

Details about the user’s device to which the impression will be delivered.

user

object

Details about the human user of the device; the advertising audience.

test

integer; default 0

Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test mode

0

at

integer; default 2

Auction type, where 1 = First Price, 2 = Second Price Plus. BidMachine currently supports only type 2

2

tmax

integer

Maximum time in milliseconds to submit a bid to avoid timeout.

This value is commonly communicated offline.

250

cur

string array

Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes.

Recommended only if the exchange accepts multiple currencies.

["USD"]

bcat

string array

Blocked advertiser categories using the IAB content categories.

["IAB2-1"]

badv

string array

Block list of advertisers by their domains.

["blocked.domain.com"]

reg

object

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

source

object

This object describes the nature and behavior of the entity that is the source of the bid request
upstream from the exchange.

ext

object

Placeholder for exchange-specific extensions to OpenRTB