Impression Object

Note

Fields marked with asterisk (*) are optional.

Impression Object Properties

Value

Type

Description

id

string

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

banner*

object

The Banner Object describes the ad properties. Required for banner impressions. One of these objects should be present in the request: banner, video, audio, or native.

video*

object

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

audio*

object

The Audio Object describes the ad properties. Required for audio impressions. One of these objects should be present in the request: banner, video, audio, or native.

native*

object

The Native Object describes the ad properties. Required for native impressions. One of these objects should be present in the request: banner, video, audio, or native.

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, the default is, "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.

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"

metric*

array of objects

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

exp*

integer

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

ext*

object

Impression extensiton object, see Impression Ext

Impression Ext

Impression Object Properties

Value

Type

Description

wopv

str

Passes the WhiteOps MediaGuard Prediction ID, e.g. “abc-123”

skadn*

object

Apple Ad Network Object, this will be used to pass app data from iOS 14 and newer releases. See SkAdNetwork Extension

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.

SkAdNetwork Extension

skadn Extension Properties

Value

Type

Description

version*

str

Version of skadnetwork supported. Always "2.0" or higher. Dependent on both the OS version and the SDK version., e.g. "2.0" https://developer.apple.com/documentation/storekit/skadnetwork

sourceapp*

str

ID of publisher app in Apple’s App Store. Should match “app.bundle”

skadnetids*

array of string

A subset of SKAdNetworkItem entries in the publisher app’s info.plist that are relevant to the DSP, e.g. ["cDkw7geQsH.skadnetwork", "qyJfv329m4.skadnetwork"] https://developer.apple.com/documentation/bundleresources/information_property_list

skadnhsh

string

A hash of the full list of skadnetids entries. A Hash table will be provided outside the bidstream for DSPs to query.

Example Impression Object JSON

{
   "imp":[
      {
         "id":"1",
         "metric":[
            {
              "type":"viewability",
              "value":0.85
            }
         ],
         "bidfloor":0.426,
         "banner":{
            "w":300,
            "h":250,
            "pos":1,
            "topframe":0,
            "expdir":[
               1,
               3
            ]
         }
      }
   ]
}