Versions Compared

Key

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

...


Object Name

Supported?

Recommended
parameters that
are not supported

Optional parameters
that are supported

Bid Request Object

Y



Impression Object

Y



Banner Object

Y



Video Object

Y



Site Object

Y



App Object

Y



Content Object




Native ObjectY

Device Object

Y



User Object

Y



Publisher Object

Y



Producer Object




Geo Object

Y



Data Object




Segment Object


PMPY

Deal

Y




Changes from Open RTB 2.2 to 2.4


  • Introduction of encryptions by supporting both HTTP and HTTPS
  • Increased location support allowing buyers to know which IP source was used to derive a given geo-location and when the latitude/longitude was last fetched using the device location service
  • Video skippability support for in-stream advertisements
  • In the user object, the buyer ID attribute has been corrected to “buyeruid.”
  • The ${AUCTION_BID_ID} macro has been corrected to be substituted with the “BidResponse.bidid” attribute.
  • Native ad placements must be included directly into the impression object in order to be passed through the bidstream.
  • Allows for the inclusion of metadata (title, urls, data, img files) in the native request. The buy side now has the ability to describe the unit that’s being bid on and the supply side is able to define which fields are available and required in order to assemble the native ad.



Bid Request


Info
titlePlease note

All fields will be populated in the request if available. There will not be a provision of passing the null value

...


Object Name     

Type

Description

Bid request

Required

Top level object

Impression object

Required

At least one impression object is required in a bid request object.

Site object

Recommended for websites

Either a site or app object may be included – not both. Neither is required.

Banner objectRecommended for bannerA banner object may be included in case the ad is shown in banner.

Apps object

Recommended for native apps

Either a site or app object may be included – not both. Neither is required.

Device object

Recommended

This object describes the device the ad impression will be delivered to (e.g., mobile phone, computer, set top box, etc.) and its capabilities (e.g., flash support).


Publisher objectRecommendedEntity that controls the content of and distributes the site or app.

User object

Recommended

This object describes the user, and may include unique identifiers for the user.


PMP objectOptionalCollection of private marketplace (PMP) deals applicable to this impression.
Deal objectOptionalDeal terms pertaining to this impression between a seller and buyer.

Geo object

Optional

Depending on the parent object, this object describes the current geographic location of the device (e.g., based on IP address or GPS), or it may describe the home geo of the user (e.g., based on registration data).


Impression object

"id" Object

...

RequiredDetails of a Video object


"Bid Request" Object


Object NameTypeDefault ValueDescription
idRequired
Unique ID of the bid request, provided by the exchange

...

...

imp

...

The “imp” field tells about the impression being auctioned. A single bid request may include multiple numbers of “imp” fields. Each “imp” has a required ID so that bids can reference them individually. An exchange can also do private auctions as part of their policy.

...

Field

...

Scope

...

Default

...

Description

...

id

...

Required

...

-

...

Id is a unique identifier for this impression within the context of the bid request.

...

Instl

...

Optional

...

0

...

Signifies whether the ad is an interstitial or full screen.

...

banner

...

Needed for banner impressions

...

-

...

Required
Array of Imp objects representing the impressions offered. At least 1 Imp object is required.
siteRequired for sites
Details via a Site object about the publisher’s website. Only applicable and recommended for websites.
appRequired for apps
Details via an App object about the publisher’s app (i.e., non-browser ap
deviceRecommended
Details via a Device object about the user’s device to which the impression will be delivered.
userRecommended
Details via a User object about the human user of the device; the advertising audience.
atRequired
Auction type, where 1 = First Price, 2 = Second Price Plus.  
tmaxRecommended
Maximum time in milliseconds to submit a bid to avoid timeout
allimpsOptional0Flag to indicate if Exchange can verify that the impressions offered represent all of the impressions available in context (e.g., all on the web page, all video spots such as pre/mid/post roll) to support road-blocking. 0 = no or unknown, 1 = yes, the impressions offered represent all that are available. 
bcatOptional
Blocked advertiser categories using the IAB content categories.
badvOptional
Block list of advertisers by their domains
regsOptional
A Regs object that specifies any industry, legal, or governmental regulations in force for this request.



"id" Object

This field denotes the unique ID of the bid request, provided by the exchange. This is mandatory.

"imp" Object

The “imp” field tells about the impression being auctioned. A single bid request may include multiple numbers of “imp” fields. Each “imp” has a required ID so that bids can reference them individually. An exchange can also do private auctions as part of their policy.


Field

Scope

Default

Description

id

Required

-

Id is a unique identifier for this impression within the context of the bid request.

Instl

Optional

0

Signifies whether the ad is an interstitial or full screen.

banner

Needed for banner impressions

-

Sets a reference to a banner object. Either a banner or video object.

displaymanagerOptional-Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps.
displaymanagerverOptional-Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps.
secureOptional0Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure. If omitted, the secure state is unknown, but non-secure HTTP support can be assumed.
expOptional-Advisory as to the number of seconds that may elapse between the auction and the actual impression.

video

Needed for video impressions

-

Sets a reference to a video object. Either a banner or video object.

Bidfloor

Optional

0

Bid floor for this impression (in CPM of bidfloorcur). This is a float value

Bidfloorcur

Optional

USD

If multiple currencies supported per bid request, then currency should be specified here using ISO-4217 alphabetic codes.


...


Field

Scope

Default

Description

linearity

Optional


Indicates whether the ad impression is linear or non-linear.

1 - Linear/In-stream

2 - Non-Linear/Overlay

This field is optional. The following should be the interpretation of the bidder based upon the presence or absence of the field in the bid request:

• If no value is set, any ad (linear or not) can be present in the response.

• If a value is set, only ads of the corresponding type can be present in the response.

startdelayOptional

Indicates the start delay in seconds for preroll, midroll, postroll ad placement.

Generic values if not present:

0 - preroll

-1 - Generic mid-roll

-2 Generic post-roll

mimes

Required


Content MIME types supported.

Popular MIME types include, but are not limited to, “video/x-ms- wmv” for Windows Media and "application/javascript" for VPAID

minduration

Required

15

Minimum video ad duration in seconds

maxduration

Required

30

Maximum video ad duration in seconds

protocol

Required

5

Video bid response protocols.

wRecommended
Width of the player in pixels.
hRecommended
Height of the player in pixels.

sequence

Recommended

1

If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creative.

boxingallowed

Recommended

1

If exchange publisher has rules preventing letter boxing of 4x3 content to play in a 16x9 window; then this should be set to false. Default setting is true, which assumes that boxing of content to fit into a window is allowed. “1” indicates boxing is allowed. “0” indicates it is not allowedof multiple creative.

playbackmethodOptional

List of allowed playback methods. If blank, assume that all are allowed.

1 - Auto-play sound on

2 - Auto-play sound off

3 - Click-to-play

4 - Mouse-over (Not applicable for mobile)

apiRequired for api supported inventory
List of supported API frameworks for this impression
posRecommended-Ad position on

2 - Auto-play sound off

3 - Click-to-play

4 - Mouse-over (Not applicable for mobile)screen
minbitrateOptional200Minimum bit rate in Kbps.
maxbitrateOptional1500Maximum bit rate in Kbps


"video.ext" Object

FieldScopeDefaultDescription
skippabilityOptional

1 - Skippable

2 - Non-Skippable

incentivizedOptional

1 - Incentivized

2 - Non-Incentivized

clickabilityOptional

1 - Clickable

2 - Non-Clickable

instreamOptional

1 - In-Stream

2 - Non-In-Stream


"banner" Object

The “banner” object is included directly in the impression object if the impression offered for auction is a MRAID opportunity.

Field

Scope

Default

Description

battroptional6
Blocked creative attributes.
1 - Audio Ad
2 - Audio Ad (User Initiated)
3 - Expandable (Automatic)
4 - Expandable (User Initiated - Click)
5 - Expandable (User Initiated - Rollover)
6 - In-Banner Video Ad (Auto Play)
7 - In-Banner Video Ad (User Initiated)
8 - Pop (e.g., Over, Under, or upon Exit)
9 - Provocative or Suggestive Imagery
10 - Shaky, Flashing, Flickering, Extreme Animation, Smileys
11 - Surveys
12 - Text Only
13 - User Interactive (e.g.,Embedded Games)
14 - Windows Dialog or Alert Style
15 - Has audio on/off button
16 - Ad can be skipped (e.g., skip button on preroll video)
topframeoptional0
Specify if the banner is delivered in the top frame or in an iframe.
“0” - means it is not in the top frame,
“1”  - means that it is
wrecommended
Width of the impression in pixels.
hrecommended
Height of the impression in pixels
idrecommended
Unique identifier for this banner object.
apioptional
List of supported API frameworks for this banner.
1 - VPAID 1.0
2 - VPAID 2.0
3 - MRAID - 1
4 - ORMMA
5 - MRAID - 2


...


Field

Scope

Default

Description

domain

Optional


Domain of the site, used for advertiser side blocking.

nameOptional
Site name

page

Recommended


URL of the page where the impression will be shown e.g. www.basketball-shoes.com/shoe-model-001.html

publisher

Optional


The publisher object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknownvalues are not provided. If an optional parameter is not specified, it should be considered unknown.

idRequired
Exchange-specific site ID.
catOptional
Array of IAB content categories of the site.
refOptional
Referrer URL that caused navigation to the current page.
contentOptional
Details about the Content within the site.


"app" Object

An “app” object is included if the ad content is part of a mobile application (as opposed to a mobile website). A bid request must not contain both an “app” object and a “site” object.


Field

Scope

Default

Description

domain

Optional


Domain of the application (e.g., “mygame.foo.com).

publisher

Optional

See Publisher Object

id

Recommended

Application ID on the exchange.).

publisher

Optional


See Publisher Object

id

Recommended


Application ID on the exchange.

nameOptional
App name
bundleOptional
A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name
catOptional
Array of IAB content categories of the app
publisherOptional
Details about the Publisher of the app

storeurl

Optional


For QAG 1.5 compliance, an app store URL for an installed app should be passed in the bid request.

contentOptional
Details about the Content within the app


"publisher" Object


Field

Scope

Default

Description

id

Recommended


Site ID on the exchange.

nameRecommended
Publisher name
catRecommended
Array of IAB content categories that describe the publisher


"device" Object

The “device” object provides details related to the device in question. Information includes platform, hardware, location, and carrier.

...


Object Name     

Type

Description

iurl

Optional

Sample image URL (without cache busting) for content checking

adomain

Optional

Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.

crid

OptionalRequired

Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.

impid

Required

ID of the impression object to which this bid applies.

Price

Required

Bid price in CPM. WARNING/Best Practice Note: Although this value is a float, OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.

adid

Optional

ID that references the ad to be served if the bid wins

nurl

Optional

Win notice URL. Please note that Chocolate marketplace does NOT support serving of ad markup via nurl.

adm

Optional

Actual ad markup. XHTML if responses to a banner object, or VAST XML if a response to a video object.

Id

Required

ID for the bid object chosen by the bidder for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.

cid

Optional

Campaign ID or similar that appears within the ad markup

dealidOptional
A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is required in the response object.


...

IAB Specification document

...

https://www.iab.

...

com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-4-FINAL.pdf

General Questions

  • How do you identify InView inventory?
    • You can use the following parameters and values:
      • video w == 300
      • video h == 250
      • viewabilitymeasurability == 1

     
  • How do you respond to a deal id
    • The response should contain the deal id in the bid object. Without deal id bids will not be prioritized over open market

...