Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AttributeTypeDescriptionScope
idStringUnique ID of the bid request, provided by the exchange.Required
imp Object ArrayArray of impression objects representing the impressions offered. At least 1 impression object is required.Required
site Object

Details via a site object about the publisher's website.

Warning
A request containing both site and app object in BidRequest Object will not be considered. Only site OR app should be present in the request; not both in the same request.


Optional
device Object

Details via a device object about the user's device to which the impression will be delivered.

Required
user Object

Details via a user object about the human user of the device; the advertising audience.

Optional
app Object

Details via an App object about the publisher's app (that is, non-browser applications). Only applicable and recommended for apps.

Warning
A request containing both site and app object in BidRequest Object will not be considered. Only site OR app should be present in the request; not both in the same request.


Optional
atInteger

Auction Type

1 = Publisher first price auction

2 = (Default) Publisher second price auction

Optional
bcatString Array

Blocked advertiser categories using the IAB content categories.

The limit of IAB categories the system can support is 20 categories.

Optional
badvString Array

Block list of advertisers by their domains; for example, "ford.com".

The limit of URLs the system can support is 40 URLs.

Optional
regs ObjectA Regs object that specifies any industry, legal, or governmental regulations in force for this request.Optional
source ObjectA Source object that provides data about the inventory source and which entity makes the final decision.Optional
testInteger

Indicator of test mode, in which auctions are not billable.

0=live mode (Default)

1=test mode

Optional
ext ObjectPlaceholder for exchange-specific extensions to OpenRTB.Optional
ext.rewardInteger

Only supported values is 1, which indicates the video is non-skippable-reward-video.

When the value = rewarded, these parameters are ignored in requests:

    •  video.skip
    • video.skipmin
    • video.skipafter

Multi-format requests are supported for video object/request, and will be ignored for banner object/request.

Optional
ext.is_rewarded_inventoryBoolean

Only supported value is true, which indicates the video is non-skippable-reward-video.

When the value = rewarded, these parameters are ignored in requests:

    •  video.skip
    • video.skipmin
    • video.skipafter

Multi-format requests are supported for video object/request, and will be ignored for banner object/request.

Optional

...