Package com.google.openrtb

Class OpenRtb.BidRequest.Imp

  • All Implemented Interfaces:
    OpenRtb.BidRequest.ImpOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    OpenRtb.BidRequest
    public static final class OpenRtb.BidRequest.Imp
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.Imp>
implements OpenRtb.BidRequest.ImpOrBuilder
     OpenRTB 2.0: 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.
 The presence of Banner (Section 3.2.3), Video (Section 3.2.4),
 and/or Native (Section 3.2.5) objects 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.
 Any given bid for the impression must conform to one of the offered types.
    Protobuf type com.google.openrtb.BidRequest.Imp
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasId

        public 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;
        Specified by:
        hasId in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public 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;
        Specified by:
        getId in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The id.

      • getIdBytes

        public 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;
        Specified by:
        getIdBytes in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The bytes for id.

      • hasBanner

        public 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;
        Specified by:
        hasBanner in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the banner field is set.

      • hasVideo

        public 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;
        Specified by:
        hasVideo in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the video field is set.

      • hasAudio

        public 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;
        Specified by:
        hasAudio in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the audio field is set.

      • hasDisplaymanager

        public 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;
        Specified by:
        hasDisplaymanager in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the displaymanager field is set.

      • getDisplaymanager

        public 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;
        Specified by:
        getDisplaymanager in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The displaymanager.

      • getDisplaymanagerBytes

        public 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;
        Specified by:
        getDisplaymanagerBytes in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The bytes for displaymanager.

      • hasDisplaymanagerver

        public 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;
        Specified by:
        hasDisplaymanagerver in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the displaymanagerver field is set.

      • getDisplaymanagerver

        public 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;
        Specified by:
        getDisplaymanagerver in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The displaymanagerver.

      • getDisplaymanagerverBytes

        public 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;
        Specified by:
        getDisplaymanagerverBytes in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The bytes for displaymanagerver.

      • hasInstl

        public boolean hasInstl()
         true = the ad is interstitial or full screen, false = not interstitial.
        optional bool instl = 6;
        Specified by:
        hasInstl in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the instl field is set.

      • getInstl

        public boolean getInstl()
         true = the ad is interstitial or full screen, false = not interstitial.
        optional bool instl = 6;
        Specified by:
        getInstl in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The instl.

      • hasTagid

        public 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;
        Specified by:
        hasTagid in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the tagid field is set.

      • getTagid

        public 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;
        Specified by:
        getTagid in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The tagid.

      • getTagidBytes

        public 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;
        Specified by:
        getTagidBytes in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The bytes for tagid.

      • hasBidfloor

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

      • getBidfloor

        public double getBidfloor()
         Minimum bid for this impression expressed in CPM.
        optional double bidfloor = 8 [default = 0];
        Specified by:
        getBidfloor in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The bidfloor.

      • hasBidfloorcur

        public 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"];
        Specified by:
        hasBidfloorcur in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the bidfloorcur field is set.

      • getBidfloorcur

        public 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"];
        Specified by:
        getBidfloorcur in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The bidfloorcur.

      • getBidfloorcurBytes

        public 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"];
        Specified by:
        getBidfloorcurBytes in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The bytes for bidfloorcur.

      • hasClickbrowser

        public 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;
        Specified by:
        hasClickbrowser in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the clickbrowser field is set.

      • getClickbrowser

        public 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;
        Specified by:
        getClickbrowser in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The clickbrowser.

      • hasSecure

        public 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;
        Specified by:
        hasSecure in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the secure field is set.

      • getSecure

        public 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;
        Specified by:
        getSecure in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The secure.

      • getIframebusterList

        public com.google.protobuf.ProtocolStringList getIframebusterList()
         Array of exchange-specific names of supported iframe busters.
        repeated string iframebuster = 10;
        Specified by:
        getIframebusterList in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        A list containing the iframebuster.

      • getIframebusterCount

        public int getIframebusterCount()
         Array of exchange-specific names of supported iframe busters.
        repeated string iframebuster = 10;
        Specified by:
        getIframebusterCount in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The count of iframebuster.

      • getIframebuster

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

      • getIframebusterBytes

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

      • hasPmp

        public 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;
        Specified by:
        hasPmp in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the pmp field is set.

      • hasNative

        public 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;
        Specified by:
        hasNative in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        Whether the native field is set.

      • hasExp

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

      • getExp

        public int getExp()
         Advisory as to the number of seconds that may elapse
 between the auction and the actual impression.
        optional int32 exp = 14;
        Specified by:
        getExp in interface OpenRtb.BidRequest.ImpOrBuilder
        Returns:
        The exp.

      • getMetricCount

        public int getMetricCount()
         An array of Metric object (Section 3.2.5).
        repeated .com.google.openrtb.BidRequest.Imp.Metric metric = 17;
        Specified by:
        getMetricCount in interface OpenRtb.BidRequest.ImpOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.Imp>

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static OpenRtb.BidRequest.Imp parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp parseFrom​(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public OpenRtb.BidRequest.Imp.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public OpenRtb.BidRequest.Imp.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected OpenRtb.BidRequest.Imp.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<OpenRtb.BidRequest.Imp> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public OpenRtb.BidRequest.Imp getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder