Bid Request

id

string

ID of the impression being shown, unique within the bid request, for example "1"

metric*

array of objects

The object that is associated with an impression as an array of metrics, see the Metric Object section.

banner*

object

The Banner Object describes the ad properties. Required for banner impressions.

video*

object

The Video Object describes the ad properties. Required for video impressions.

native*

object

The Native Object describes the ad properties. Required for native impressions.

bidfloor*

float

Bid floor in CPM as set by the Supplier, for example, 0.01080

bidfloorcur*

string

Bid floor currency specified using ISO-4217 alpha codes, for example, "USD".

instl*

integer

Specifies if the ad is an interstitial.

• 0 = not interstitial, the default value.

• 1 = the ad is interstitial or full screen

tagid*

string

Identifier for specific ad placement or ad tag that was used to initiate the auction.

clickbrowser*

integer

Indicates the type of browser opened upon clicking the creative in an app, where 0 = embedded, 1 = native. Note that the Safari View Controller in iOS 9.x devices is considered a native browser for purposes of this attribute.

secure*

integer

Specifies if the page is SSL compliant:

• 0: for insecure pages, the default value.

• 1: for secure pages. Creative assets for secure pages should be SSL-compliant.

iframebuster*

array of strings

Array of names of supported iframe busters, for example, ["dc", "rb"], for more information, see the Supported Rich Media Frameworks section.

pmp*

object

The Private Marketplace Object, used for direct deals between Buyers and Suppliers.

displaymanager*

string

Name of the ad mediation partner, SDK technology, or native player responsible for rendering the ad (typically video or mobile), for example, "SOMA"

displaymanagerver*

string

Version of the ad mediation partner, SDK technology, or native player responsible for rendering the ad (typically video or mobile), for example, "1.1"

rwdd*

integer

Indicates whether the user receives a reward for viewing the ad, where 0 = no, 1 = yes. Typically video ad implementations allow users to read an additional news article for free, receive an extra life in a game, or get a sponsored ad-free music session. The reward is typically distributed after the video ad is completed.

ssai*

int

Indicates if server-side ad insertion (e.g., stitching an ad into an audio or video stream) is in use and the impact of this on asset and tracker retrieval. It can take the following values:

• 0 = status unknown

• 1 = all client-side (i.e., not server-side)

• 2 = assets stitched server-side but tracking pixels fired client-side

• 3 = all server-side.

exp*

integer

Impression expiry timeout, in seconds, for example, "300". An impression will be considered expired if it is registered later than imp.exp seconds after the auction.

ext*

object

See the Impression Ext section.