Package 

Class Impression


  • 
    public final class Impression
    
                        

    This 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 class Impression.Extension
    • Method Summary

      Modifier and Type Method Description
      final Array<Metric> getMetric() An array of Metric object.
      final Unit setMetric(@SerializedName(value = metric) Array<Metric> metric) An array of Metric object.
      final Banner getBanner() A Banner object required if this impression is offered as a banner ad opportunity.
      final Unit setBanner(@SerializedName(value = banner) Banner banner) A Banner object required if this impression is offered as a banner ad opportunity.
      final Video getVideo() A Video object required if this impression is offered as a video ad opportunity.
      final Unit setVideo(@SerializedName(value = video) Video video) A Video object required if this impression is offered as a video ad opportunity.
      final Audio getAudio() An Audio object required if this impression is offered as an audio ad opportunity.
      final Unit setAudio(@SerializedName(value = audio) Audio audio) An Audio object required if this impression is offered as an audio ad opportunity.
      final Native getNative() A Native object required if this impression is offered as a native ad opportunity.
      final Unit setNative(@SerializedName(value = native) Native native) A Native object required if this impression is offered as a native ad opportunity.
      final Pmp getPmp() A Pmp object containing any private marketplace deals in effect for this impression.
      final Unit setPmp(@SerializedName(value = pmp) Pmp pmp) A Pmp object containing any private marketplace deals in effect for this impression.
      final String getDisplayManager() Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
      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).
      final String getDisplayManagerVersion() Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
      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).
      final Integer getInterstitial() 1 = the ad is interstitial or full screen, 0 = not interstitial.
      final Unit setInterstitial(@SerializedName(value = instl) Integer interstitial) 1 = the ad is interstitial or full screen, 0 = not interstitial.
      final String getTagId() Identifier for specific ad placement or ad tag that was used to initiate the auction.
      final Unit setTagId(@SerializedName(value = tagid) String tagId) Identifier for specific ad placement or ad tag that was used to initiate the auction.
      final Integer getBidFloor() Minimum bid for this impression expressed in CPM.
      final Unit setBidFloor(@SerializedName(value = bidfloor) Integer bidFloor) Minimum bid for this impression expressed in CPM.
      final String getBidFloorCurrency() Currency specified using ISO-4217 alpha codes.
      final Unit setBidFloorCurrency(@SerializedName(value = bidfloorcur) String bidFloorCurrency) Currency specified using ISO-4217 alpha codes.
      final Integer getClickBrowser() Indicates the type of browser opened upon clicking the creative in an app, where 0 = embedded, 1 = native.
      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.
      final Integer getSecure() Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure.
      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.
      final Array<String> getIframeBuster() Array of exchange-specific names of supported iframe busters.
      final Unit setIframeBuster(@SerializedName(value = iframebuster) Array<String> iframeBuster) Array of exchange-specific names of supported iframe busters.
      final Integer getExpire() Advisory as to the number of seconds that may elapse between the auction and the actual impression.
      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.
      final Impression.Extension getExtension() Placeholder for exchange-specific extensions to OpenRTB.
      final Unit setExtension(@SerializedName(value = ext) Impression.Extension extension) Placeholder for exchange-specific extensions to OpenRTB.
      final String getId() A unique identifier for this impression within the context of the bid request
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Impression

        Impression(String id)
    • Method Detail

      • 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.

      • 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.

      • getId

         final String getId()

        A unique identifier for this impression within the context of the bid request