-
public final class ImpressionThis object describes an ad placement or impression being auctioned. A single bid request can include multiple Imp objects, a use case for which might be an exchange that supports selling all ad positions on a given page. Each Imp object has a required ID so that bids can reference them individually.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classImpression.Extension
-
Field Summary
Fields Modifier and Type Field Description private Array<Metric>metricprivate Bannerbannerprivate Videovideoprivate Audioaudioprivate Nativenativeprivate Pmppmpprivate StringdisplayManagerprivate StringdisplayManagerVersionprivate Integerinterstitialprivate StringtagIdprivate IntegerbidFloorprivate StringbidFloorCurrencyprivate IntegerclickBrowserprivate Integersecureprivate Array<String>iframeBusterprivate Integerexpireprivate Impression.Extensionextensionprivate final Stringid
-
Constructor Summary
Constructors Constructor Description Impression(String id)
-
Method Summary
Modifier and Type Method Description final Array<Metric>getMetric()An array of Metric object. final UnitsetMetric(@SerializedName(value = metric) Array<Metric> metric)An array of Metric object. final BannergetBanner()A Banner object required if this impression is offered as a banner ad opportunity. final UnitsetBanner(@SerializedName(value = banner) Banner banner)A Banner object required if this impression is offered as a banner ad opportunity. final VideogetVideo()A Video object required if this impression is offered as a video ad opportunity. final UnitsetVideo(@SerializedName(value = video) Video video)A Video object required if this impression is offered as a video ad opportunity. final AudiogetAudio()An Audio object required if this impression is offered as an audio ad opportunity. final UnitsetAudio(@SerializedName(value = audio) Audio audio)An Audio object required if this impression is offered as an audio ad opportunity. final NativegetNative()A Native object required if this impression is offered as a native ad opportunity. final UnitsetNative(@SerializedName(value = native) Native native)A Native object required if this impression is offered as a native ad opportunity. final PmpgetPmp()A Pmp object containing any private marketplace deals in effect for this impression. final UnitsetPmp(@SerializedName(value = pmp) Pmp pmp)A Pmp object containing any private marketplace deals in effect for this impression. final StringgetDisplayManager()Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). final UnitsetDisplayManager(@SerializedName(value = displaymanager) String displayManager)Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). final StringgetDisplayManagerVersion()Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). final UnitsetDisplayManagerVersion(@SerializedName(value = displaymanagerver) String displayManagerVersion)Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). final IntegergetInterstitial()1 = the ad is interstitial or full screen, 0 = not interstitial. final UnitsetInterstitial(@SerializedName(value = instl) Integer interstitial)1 = the ad is interstitial or full screen, 0 = not interstitial. final StringgetTagId()Identifier for specific ad placement or ad tag that was used to initiate the auction. final UnitsetTagId(@SerializedName(value = tagid) String tagId)Identifier for specific ad placement or ad tag that was used to initiate the auction. final IntegergetBidFloor()Minimum bid for this impression expressed in CPM. final UnitsetBidFloor(@SerializedName(value = bidfloor) Integer bidFloor)Minimum bid for this impression expressed in CPM. final StringgetBidFloorCurrency()Currency specified using ISO-4217 alpha codes. final UnitsetBidFloorCurrency(@SerializedName(value = bidfloorcur) String bidFloorCurrency)Currency specified using ISO-4217 alpha codes. final IntegergetClickBrowser()Indicates the type of browser opened upon clicking the creative in an app, where 0 = embedded, 1 = native. final UnitsetClickBrowser(@SerializedName(value = clickbrowser) Integer clickBrowser)Indicates the type of browser opened upon clicking the creative in an app, where 0 = embedded, 1 = native. final IntegergetSecure()Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure. final UnitsetSecure(@SerializedName(value = secure) Integer secure)Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure. final Array<String>getIframeBuster()Array of exchange-specific names of supported iframe busters. final UnitsetIframeBuster(@SerializedName(value = iframebuster) Array<String> iframeBuster)Array of exchange-specific names of supported iframe busters. final IntegergetExpire()Advisory as to the number of seconds that may elapse between the auction and the actual impression. final UnitsetExpire(@SerializedName(value = exp) Integer expire)Advisory as to the number of seconds that may elapse between the auction and the actual impression. final Impression.ExtensiongetExtension()Placeholder for exchange-specific extensions to OpenRTB. final UnitsetExtension(@SerializedName(value = ext) Impression.Extension extension)Placeholder for exchange-specific extensions to OpenRTB. final StringgetId()A unique identifier for this impression within the context of the bid request -
-
Constructor Detail
-
Impression
Impression(String id)
-
-
Method Detail
-
setMetric
final Unit setMetric(@SerializedName(value = metric) Array<Metric> metric)
An array of Metric object.
-
getBanner
final Banner getBanner()
A Banner object required if this impression is offered as a banner ad opportunity.
-
setBanner
final Unit setBanner(@SerializedName(value = banner) Banner banner)
A Banner object required if this impression is offered as a banner ad opportunity.
-
getVideo
final Video getVideo()
A Video object required if this impression is offered as a video ad opportunity.
-
setVideo
final Unit setVideo(@SerializedName(value = video) Video video)
A Video object required if this impression is offered as a video ad opportunity.
-
getAudio
final Audio getAudio()
An Audio object required if this impression is offered as an audio ad opportunity.
-
setAudio
final Unit setAudio(@SerializedName(value = audio) Audio audio)
An Audio object required if this impression is offered as an audio ad opportunity.
-
getNative
final Native getNative()
A Native object required if this impression is offered as a native ad opportunity.
-
setNative
final Unit setNative(@SerializedName(value = native) Native native)
A Native object required if this impression is offered as a native ad opportunity.
-
getPmp
final Pmp getPmp()
A Pmp object containing any private marketplace deals in effect for this impression.
-
setPmp
final Unit setPmp(@SerializedName(value = pmp) Pmp pmp)
A Pmp object containing any private marketplace deals in effect for this impression.
-
getDisplayManager
final String getDisplayManager()
Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps.
-
setDisplayManager
final Unit setDisplayManager(@SerializedName(value = displaymanager) String displayManager)
Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps.
-
getDisplayManagerVersion
final String getDisplayManagerVersion()
Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps.
-
setDisplayManagerVersion
final Unit setDisplayManagerVersion(@SerializedName(value = displaymanagerver) String displayManagerVersion)
Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps.
-
getInterstitial
final Integer getInterstitial()
1 = the ad is interstitial or full screen, 0 = not interstitial.
-
setInterstitial
final Unit setInterstitial(@SerializedName(value = instl) Integer interstitial)
1 = the ad is interstitial or full screen, 0 = not interstitial.
-
getTagId
final String getTagId()
Identifier for specific ad placement or ad tag that was used to initiate the auction. This can be useful for debugging of any issues, or for optimization by the buyer.
-
setTagId
final Unit setTagId(@SerializedName(value = tagid) String tagId)
Identifier for specific ad placement or ad tag that was used to initiate the auction. This can be useful for debugging of any issues, or for optimization by the buyer.
-
getBidFloor
final Integer getBidFloor()
Minimum bid for this impression expressed in CPM.
-
setBidFloor
final Unit setBidFloor(@SerializedName(value = bidfloor) Integer bidFloor)
Minimum bid for this impression expressed in CPM.
-
getBidFloorCurrency
final String getBidFloorCurrency()
Currency specified using ISO-4217 alpha codes. This may be different from bid currency returned by bidder if this is allowed by the exchange.
-
setBidFloorCurrency
final Unit setBidFloorCurrency(@SerializedName(value = bidfloorcur) String bidFloorCurrency)
Currency specified using ISO-4217 alpha codes. This may be different from bid currency returned by bidder if this is allowed by the exchange.
-
getClickBrowser
final Integer getClickBrowser()
Indicates the type of browser opened upon clicking the creative in an app, where 0 = embedded, 1 = native.
-
setClickBrowser
final Unit setClickBrowser(@SerializedName(value = clickbrowser) Integer clickBrowser)
Indicates the type of browser opened upon clicking the creative in an app, where 0 = embedded, 1 = native.
-
getSecure
final Integer getSecure()
Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure. If omitted, the secure state is unknown, but non-secure HTTP support can be assumed.
-
setSecure
final Unit setSecure(@SerializedName(value = secure) Integer secure)
Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure. If omitted, the secure state is unknown, but non-secure HTTP support can be assumed.
-
getIframeBuster
final Array<String> getIframeBuster()
Array of exchange-specific names of supported iframe busters.
-
setIframeBuster
final Unit setIframeBuster(@SerializedName(value = iframebuster) Array<String> iframeBuster)
Array of exchange-specific names of supported iframe busters.
-
getExpire
final Integer getExpire()
Advisory as to the number of seconds that may elapse between the auction and the actual impression.
-
setExpire
final Unit setExpire(@SerializedName(value = exp) Integer expire)
Advisory as to the number of seconds that may elapse between the auction and the actual impression.
-
getExtension
final Impression.Extension getExtension()
Placeholder for exchange-specific extensions to OpenRTB.
-
setExtension
final Unit setExtension(@SerializedName(value = ext) Impression.Extension extension)
Placeholder for exchange-specific extensions to OpenRTB.
-
-
-
-