Impression Object¶

Note

Fields marked with asterisk (*) are optional.

Parameter	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.
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.
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
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”].
displaymanager*	string	Bid floor currency specified using ISO-4217 alpha codes, for example, “USD”.
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*	string	Indicates whether the user receives a reward for viewing the ad, where 0 = no, 1 = yes.
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.
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.
refresh*	object	Details about ad slots being refreshed automatically.
qty*	object	A means of passing a multiplier in the bid request, representing the total quantity of impressions for adverts that display to more than one person.
dt*	float	Timestamp when the item is estimated to be fulfilled (e.g. when a DOOH impression will be displayed) in Unix format (i.e., milliseconds since the epoch).
metric*	array of objects	The object that is associated with an impression as an array of metrics, see the Metric Object section.
ext*	object	Impression Extension Properties.

Impression Ext¶

Parameter	Type	Description
skadn*	object	Apple Ad Network Object, this will be used to pass app data from iOS 14 and newer releases. See SkAdNetwork Extension

Impression Refresh¶

Parameter	Type	Description
refsettings*	array of objects	describes the mechanics of how an ad placement automatically refreshes.
count*	integer	the number of times this ad slot had been refreshed since last page load.

RefSettings Object¶

Parameter	Type	Description
reftype*	integer	the type of declared auto-refresh.
minint*	integer	the minimum refresh interval in seconds. This applies to all refresh types. This is the (uninterrupted) time the ad creative will be rendered before refreshing to the next creative. If the field is absent, the exposure time is unknown.

SkAdNetwork Extension¶

Parameter	Type	Description
version	string	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
versions*	array of strings	An array of strings containing the supported skadnetwork versions. Always “2.0” or higher. Dependent on both the OS version and the SDK version.
sourceapp*	string	ID of publisher app in Apple’s App Store. Should match “app.bundle”.
skadnetids*	array of strings	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.

Impression Qty Object¶

Parameter	Type	Description
multiplier	float	The quantity of billable events which will be deemed to have occurred if this item is purchased. For example, a DOOH opportunity may be considered to be 14.2 impressions.
sourcetype*	integer	The source type of the quantity measurement, ie. publisher.
vendor*	string	The top level business domain name of the measurement vendor providing the quantity measurement. Note: Required if sourcetype is present and = 1.

Impression Object Example¶

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