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” |
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. |
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
|
---|---|---|
reward* |
integer |
Indicates whether the ad is being rendered as part of a rewarded / incentivised user experience, where: 0 = non-rewarded 1 = rewarded If omitted, non-rewarded can be assumed. |
ssai* |
integer |
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. |
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
]
}
}
]
}