Package com.google.openrtb

Interface OpenRtb.BidRequest.ImpOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      OpenRtb.BidRequest.Imp.Audio getAudio()
      An Audio object; required if this impression is offered as an audio ad opportunity.
      OpenRtb.BidRequest.Imp.AudioOrBuilder getAudioOrBuilder()
      An Audio object; required if this impression is offered as an audio ad opportunity.
      OpenRtb.BidRequest.Imp.Banner getBanner()
      A Banner object (Section 3.2.3); required if this impression is offered as a banner ad opportunity.
      OpenRtb.BidRequest.Imp.BannerOrBuilder getBannerOrBuilder()
      A Banner object (Section 3.2.3); required if this impression is offered as a banner ad opportunity.
      double getBidfloor()
      Minimum bid for this impression expressed in CPM.
      String getBidfloorcur()
      Currency specified using ISO-4217 alpha codes.
      com.google.protobuf.ByteString getBidfloorcurBytes()
      Currency specified using ISO-4217 alpha codes.
      boolean getClickbrowser()
      Indicates the type of browser opened upon clicking the creative in an app, where false = embedded, true = native.
      String getDisplaymanager()
      Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
      com.google.protobuf.ByteString getDisplaymanagerBytes()
      Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
      String getDisplaymanagerver()
      Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
      com.google.protobuf.ByteString getDisplaymanagerverBytes()
      Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
      int getExp()
      Advisory as to the number of seconds that may elapse between the auction and the actual impression.
      String getId()
      A unique identifier for this impression within the context of the bid request (typically, value starts with 1, and increments up to n for n impressions).
      com.google.protobuf.ByteString getIdBytes()
      A unique identifier for this impression within the context of the bid request (typically, value starts with 1, and increments up to n for n impressions).
      String getIframebuster​(int index)
      Array of exchange-specific names of supported iframe busters.
      com.google.protobuf.ByteString getIframebusterBytes​(int index)
      Array of exchange-specific names of supported iframe busters.
      int getIframebusterCount()
      Array of exchange-specific names of supported iframe busters.
      List<String> getIframebusterList()
      Array of exchange-specific names of supported iframe busters.
      boolean getInstl()
      true = the ad is interstitial or full screen, false = not interstitial.
      OpenRtb.BidRequest.Imp.Metric getMetric​(int index)
      An array of Metric object (Section 3.2.5).
      int getMetricCount()
      An array of Metric object (Section 3.2.5).
      List<OpenRtb.BidRequest.Imp.Metric> getMetricList()
      An array of Metric object (Section 3.2.5).
      OpenRtb.BidRequest.Imp.MetricOrBuilder getMetricOrBuilder​(int index)
      An array of Metric object (Section 3.2.5).
      List<? extends OpenRtb.BidRequest.Imp.MetricOrBuilder> getMetricOrBuilderList()
      An array of Metric object (Section 3.2.5).
      OpenRtb.BidRequest.Imp.Native getNative()
      A Native object (Section 3.2.5); required if this impression is offered as a native ad opportunity.
      OpenRtb.BidRequest.Imp.NativeOrBuilder getNativeOrBuilder()
      A Native object (Section 3.2.5); required if this impression is offered as a native ad opportunity.
      OpenRtb.BidRequest.Imp.Pmp getPmp()
      A Pmp object (Section 3.2.17) containing any private marketplace deals in effect for this impression.
      OpenRtb.BidRequest.Imp.PmpOrBuilder getPmpOrBuilder()
      A Pmp object (Section 3.2.17) containing any private marketplace deals in effect for this impression.
      boolean getSecure()
      Flag to indicate if the impression requires secure HTTPS URL creative assets and markup.
      String getTagid()
      Identifier for specific ad placement or ad tag that was used to initiate the auction.
      com.google.protobuf.ByteString getTagidBytes()
      Identifier for specific ad placement or ad tag that was used to initiate the auction.
      OpenRtb.BidRequest.Imp.Video getVideo()
      A Video object (Section 3.2.4); required if this impression is offered as a video ad opportunity.
      OpenRtb.BidRequest.Imp.VideoOrBuilder getVideoOrBuilder()
      A Video object (Section 3.2.4); required if this impression is offered as a video ad opportunity.
      boolean hasAudio()
      An Audio object; required if this impression is offered as an audio ad opportunity.
      boolean hasBanner()
      A Banner object (Section 3.2.3); required if this impression is offered as a banner ad opportunity.
      boolean hasBidfloor()
      Minimum bid for this impression expressed in CPM.
      boolean hasBidfloorcur()
      Currency specified using ISO-4217 alpha codes.
      boolean hasClickbrowser()
      Indicates the type of browser opened upon clicking the creative in an app, where false = embedded, true = native.
      boolean hasDisplaymanager()
      Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
      boolean hasDisplaymanagerver()
      Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).
      boolean hasExp()
      Advisory as to the number of seconds that may elapse between the auction and the actual impression.
      boolean hasId()
      A unique identifier for this impression within the context of the bid request (typically, value starts with 1, and increments up to n for n impressions).
      boolean hasInstl()
      true = the ad is interstitial or full screen, false = not interstitial.
      boolean hasNative()
      A Native object (Section 3.2.5); required if this impression is offered as a native ad opportunity.
      boolean hasPmp()
      A Pmp object (Section 3.2.17) containing any private marketplace deals in effect for this impression.
      boolean hasSecure()
      Flag to indicate if the impression requires secure HTTPS URL creative assets and markup.
      boolean hasTagid()
      Identifier for specific ad placement or ad tag that was used to initiate the auction.
      boolean hasVideo()
      A Video object (Section 3.2.4); required if this impression is offered as a video ad opportunity.

      • Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder

        getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasId

        boolean hasId()
         A unique identifier for this impression within the context of the bid
 request (typically, value starts with 1, and increments up to n
 for n impressions).
        required string id = 1;
        Returns:
        Whether the id field is set.

      • getId

        String getId()
         A unique identifier for this impression within the context of the bid
 request (typically, value starts with 1, and increments up to n
 for n impressions).
        required string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         A unique identifier for this impression within the context of the bid
 request (typically, value starts with 1, and increments up to n
 for n impressions).
        required string id = 1;
        Returns:
        The bytes for id.

      • hasBanner

        boolean hasBanner()
         A Banner object (Section 3.2.3); required if this impression is
 offered as a banner ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Banner banner = 2;
        Returns:
        Whether the banner field is set.

      • getBanner

        OpenRtb.BidRequest.Imp.Banner getBanner()
         A Banner object (Section 3.2.3); required if this impression is
 offered as a banner ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Banner banner = 2;
        Returns:
        The banner.

      • getBannerOrBuilder

        OpenRtb.BidRequest.Imp.BannerOrBuilder getBannerOrBuilder()
         A Banner object (Section 3.2.3); required if this impression is
 offered as a banner ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Banner banner = 2;

      • hasVideo

        boolean hasVideo()
         A Video object (Section 3.2.4); required if this impression is
 offered as a video ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Video video = 3;
        Returns:
        Whether the video field is set.

      • getVideo

        OpenRtb.BidRequest.Imp.Video getVideo()
         A Video object (Section 3.2.4); required if this impression is
 offered as a video ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Video video = 3;
        Returns:
        The video.

      • getVideoOrBuilder

        OpenRtb.BidRequest.Imp.VideoOrBuilder getVideoOrBuilder()
         A Video object (Section 3.2.4); required if this impression is
 offered as a video ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Video video = 3;

      • hasAudio

        boolean hasAudio()
         An Audio object; required if this impression is offered
 as an audio ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Audio audio = 15;
        Returns:
        Whether the audio field is set.

      • getAudio

        OpenRtb.BidRequest.Imp.Audio getAudio()
         An Audio object; required if this impression is offered
 as an audio ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Audio audio = 15;
        Returns:
        The audio.

      • getAudioOrBuilder

        OpenRtb.BidRequest.Imp.AudioOrBuilder getAudioOrBuilder()
         An Audio object; required if this impression is offered
 as an audio ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Audio audio = 15;

      • hasDisplaymanager

        boolean hasDisplaymanager()
         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.
        optional string displaymanager = 4;
        Returns:
        Whether the displaymanager field is set.

      • getDisplaymanager

        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.
        optional string displaymanager = 4;
        Returns:
        The displaymanager.

      • getDisplaymanagerBytes

        com.google.protobuf.ByteString getDisplaymanagerBytes()
         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.
        optional string displaymanager = 4;
        Returns:
        The bytes for displaymanager.

      • hasDisplaymanagerver

        boolean hasDisplaymanagerver()
         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.
        optional string displaymanagerver = 5;
        Returns:
        Whether the displaymanagerver field is set.

      • getDisplaymanagerver

        String getDisplaymanagerver()
         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.
        optional string displaymanagerver = 5;
        Returns:
        The displaymanagerver.

      • getDisplaymanagerverBytes

        com.google.protobuf.ByteString getDisplaymanagerverBytes()
         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.
        optional string displaymanagerver = 5;
        Returns:
        The bytes for displaymanagerver.

      • hasInstl

        boolean hasInstl()
         true = the ad is interstitial or full screen, false = not interstitial.
        optional bool instl = 6;
        Returns:
        Whether the instl field is set.

      • getInstl

        boolean getInstl()
         true = the ad is interstitial or full screen, false = not interstitial.
        optional bool instl = 6;
        Returns:
        The instl.

      • hasTagid

        boolean hasTagid()
         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.
        optional string tagid = 7;
        Returns:
        Whether the tagid field is set.

      • getTagid

        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.
        optional string tagid = 7;
        Returns:
        The tagid.

      • getTagidBytes

        com.google.protobuf.ByteString getTagidBytes()
         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.
        optional string tagid = 7;
        Returns:
        The bytes for tagid.

      • hasBidfloor

        boolean hasBidfloor()
         Minimum bid for this impression expressed in CPM.
        optional double bidfloor = 8 [default = 0];
        Returns:
        Whether the bidfloor field is set.

      • getBidfloor

        double getBidfloor()
         Minimum bid for this impression expressed in CPM.
        optional double bidfloor = 8 [default = 0];
        Returns:
        The bidfloor.

      • hasBidfloorcur

        boolean hasBidfloorcur()
         Currency specified using ISO-4217 alpha codes. This may be different
 from bid currency returned by bidder if this is allowed by the exchange.
        optional string bidfloorcur = 9 [default = "USD"];
        Returns:
        Whether the bidfloorcur field is set.

      • getBidfloorcur

        String getBidfloorcur()
         Currency specified using ISO-4217 alpha codes. This may be different
 from bid currency returned by bidder if this is allowed by the exchange.
        optional string bidfloorcur = 9 [default = "USD"];
        Returns:
        The bidfloorcur.

      • getBidfloorcurBytes

        com.google.protobuf.ByteString getBidfloorcurBytes()
         Currency specified using ISO-4217 alpha codes. This may be different
 from bid currency returned by bidder if this is allowed by the exchange.
        optional string bidfloorcur = 9 [default = "USD"];
        Returns:
        The bytes for bidfloorcur.

      • hasClickbrowser

        boolean hasClickbrowser()
         Indicates the type of browser opened upon clicking the
 creative in an app, where false = embedded, true = native.
 Note that the Safari View Controller in iOS 9.x devices is considered
 a native browser for purposes of this attribute.
        optional bool clickbrowser = 16;
        Returns:
        Whether the clickbrowser field is set.

      • getClickbrowser

        boolean getClickbrowser()
         Indicates the type of browser opened upon clicking the
 creative in an app, where false = embedded, true = native.
 Note that the Safari View Controller in iOS 9.x devices is considered
 a native browser for purposes of this attribute.
        optional bool clickbrowser = 16;
        Returns:
        The clickbrowser.

      • hasSecure

        boolean hasSecure()
         Flag to indicate if the impression requires secure HTTPS URL creative
 assets and markup.  If omitted, the secure state is unknown, but
 non-secure HTTP support can be assumed.
        optional bool secure = 12;
        Returns:
        Whether the secure field is set.

      • getSecure

        boolean getSecure()
         Flag to indicate if the impression requires secure HTTPS URL creative
 assets and markup.  If omitted, the secure state is unknown, but
 non-secure HTTP support can be assumed.
        optional bool secure = 12;
        Returns:
        The secure.

      • getIframebusterList

        List<String> getIframebusterList()
         Array of exchange-specific names of supported iframe busters.
        repeated string iframebuster = 10;
        Returns:
        A list containing the iframebuster.

      • getIframebusterCount

        int getIframebusterCount()
         Array of exchange-specific names of supported iframe busters.
        repeated string iframebuster = 10;
        Returns:
        The count of iframebuster.

      • getIframebuster

        String getIframebuster​(int index)
         Array of exchange-specific names of supported iframe busters.
        repeated string iframebuster = 10;
        Parameters:
        index - The index of the element to return.
        Returns:
        The iframebuster at the given index.

      • getIframebusterBytes

        com.google.protobuf.ByteString getIframebusterBytes​(int index)
         Array of exchange-specific names of supported iframe busters.
        repeated string iframebuster = 10;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the iframebuster at the given index.

      • hasPmp

        boolean hasPmp()
         A Pmp object (Section 3.2.17) containing any private marketplace deals
 in effect for this impression.
        optional .com.google.openrtb.BidRequest.Imp.Pmp pmp = 11;
        Returns:
        Whether the pmp field is set.

      • getPmp

        OpenRtb.BidRequest.Imp.Pmp getPmp()
         A Pmp object (Section 3.2.17) containing any private marketplace deals
 in effect for this impression.
        optional .com.google.openrtb.BidRequest.Imp.Pmp pmp = 11;
        Returns:
        The pmp.

      • getPmpOrBuilder

        OpenRtb.BidRequest.Imp.PmpOrBuilder getPmpOrBuilder()
         A Pmp object (Section 3.2.17) containing any private marketplace deals
 in effect for this impression.
        optional .com.google.openrtb.BidRequest.Imp.Pmp pmp = 11;

      • hasNative

        boolean hasNative()
         A Native object (Section 3.2.5); required if this impression is
 offered as a native ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Native native = 13;
        Returns:
        Whether the native field is set.

      • getNative

        OpenRtb.BidRequest.Imp.Native getNative()
         A Native object (Section 3.2.5); required if this impression is
 offered as a native ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Native native = 13;
        Returns:
        The native.

      • getNativeOrBuilder

        OpenRtb.BidRequest.Imp.NativeOrBuilder getNativeOrBuilder()
         A Native object (Section 3.2.5); required if this impression is
 offered as a native ad opportunity.
        optional .com.google.openrtb.BidRequest.Imp.Native native = 13;

      • hasExp

        boolean hasExp()
         Advisory as to the number of seconds that may elapse
 between the auction and the actual impression.
        optional int32 exp = 14;
        Returns:
        Whether the exp field is set.

      • getExp

        int getExp()
         Advisory as to the number of seconds that may elapse
 between the auction and the actual impression.
        optional int32 exp = 14;
        Returns:
        The exp.

      • getMetricList

        List<OpenRtb.BidRequest.Imp.Metric> getMetricList()
         An array of Metric object (Section 3.2.5).
        repeated .com.google.openrtb.BidRequest.Imp.Metric metric = 17;

      • getMetric

        OpenRtb.BidRequest.Imp.Metric getMetric​(int index)
         An array of Metric object (Section 3.2.5).
        repeated .com.google.openrtb.BidRequest.Imp.Metric metric = 17;

      • getMetricCount

        int getMetricCount()
         An array of Metric object (Section 3.2.5).
        repeated .com.google.openrtb.BidRequest.Imp.Metric metric = 17;

      • getMetricOrBuilderList

        List<? extends OpenRtb.BidRequest.Imp.MetricOrBuilder> getMetricOrBuilderList()
         An array of Metric object (Section 3.2.5).
        repeated .com.google.openrtb.BidRequest.Imp.Metric metric = 17;

      • getMetricOrBuilder

        OpenRtb.BidRequest.Imp.MetricOrBuilder getMetricOrBuilder​(int index)
         An array of Metric object (Section 3.2.5).
        repeated .com.google.openrtb.BidRequest.Imp.Metric metric = 17;