nimbus-android/com.adsbynimbus.openrtb.request/Impression

Impression

@Serializable

class Impression(var banner: Banner? = null, var video: Video? = null, var native: Native? = null, var instl: Byte = 0, var secure: Byte = 1, var ext: Impression.Extension)

This object describes an ad placement or impression being auctioned.

A single BidRequest can include multiple Impression objects, a use case for which might be an exchange that supports selling all ad positions on a given page. Each Impression object has a required ID so that bids can reference them individually. The presence of Banner, Video, or Native, subordinate to the Imp object indicates the type of impression being offered. The publisher can choose one such type which is the typical case or mix them at their discretion. However, any given bid for the impression must conform to one of the offered types.

OpenRTB Section 3.2.4

Constructors

Impression

constructor(banner: Banner? = null, video: Video? = null, native: Native? = null, instl: Byte = 0, secure: Byte = 1, ext: Impression.Extension)

Types

Extension

@Serializable

class Extension(var position: String, var aps: Set<Map<String, List<String>>> = emptySet(), var adUnitType: Byte = UNKNOWN, var facebook_app_id: String? = null, var facebook_test_ad_type: String? = null)

Impression extension unique to Nimbus

Properties

banner

@JvmField

var banner: Banner?

A banner object; required if this impression is offered as a banner ad opportunity or is used in the Nimbus hybrid auction.

ext

@JvmField

var ext: Impression.Extension

Placeholder for exchange-specific extensions to OpenRTB

instl

@JvmField

var instl: Byte

An integer flag marking this impression object as an interstitial. 1 = the ad is interstitial or full screen, 0 = not interstitial.

native

@JvmField

var native: Native?

A native object; required if this impression is offered as a native ad opportunity or is used in a Nimbus hybrid auction.

secure

@JvmField

var secure: Byte

Flag to indicate if the impression requires secure HTTPS URL creative assets and markup. 0 = non-secure 1 = secure

video

@JvmField

var video: Video?

A video object; required if this impression is offered as a video ad opportunity or is used in Nimbus hybrid auction.