Package com.google.openrtb

Class OpenRtb.BidRequest.Imp.Pmp.Deal

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OpenRtb.BidRequest.Imp.Pmp.Deal.Builder
      OpenRTB 2.2: This object constitutes a specific deal that was struck a priori between a buyer and a seller.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3.ExtendableMessage

        com.google.protobuf.GeneratedMessageV3.ExtendableMessage.ExtensionWriter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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 the direct deal.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Specified by:
        hasId in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        Whether the id field is set.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         A unique identifier for the direct deal.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Specified by:
        getIdBytes in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        The bytes for id.

      • hasBidfloor

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

      • 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 = 3 [default = "USD"];
        Specified by:
        hasBidfloorcur in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        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 = 3 [default = "USD"];
        Specified by:
        getBidfloorcur in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        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 = 3 [default = "USD"];
        Specified by:
        getBidfloorcurBytes in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        The bytes for bidfloorcur.

      • getWseatList

        public com.google.protobuf.ProtocolStringList getWseatList()
         Allowlist of buyer seats (e.g., advertisers, agencies) that can bid
 on this deal. IDs of seats and knowledge of the buyer's customers to
 which they refer must be coordinated between bidders and the exchange
 a priori. Omission implies no seat restrictions.
        repeated string wseat = 4;
        Specified by:
        getWseatList in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        A list containing the wseat.

      • getWseatCount

        public int getWseatCount()
         Allowlist of buyer seats (e.g., advertisers, agencies) that can bid
 on this deal. IDs of seats and knowledge of the buyer's customers to
 which they refer must be coordinated between bidders and the exchange
 a priori. Omission implies no seat restrictions.
        repeated string wseat = 4;
        Specified by:
        getWseatCount in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        The count of wseat.

      • getWseat

        public String getWseat​(int index)
         Allowlist of buyer seats (e.g., advertisers, agencies) that can bid
 on this deal. IDs of seats and knowledge of the buyer's customers to
 which they refer must be coordinated between bidders and the exchange
 a priori. Omission implies no seat restrictions.
        repeated string wseat = 4;
        Specified by:
        getWseat in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The wseat at the given index.

      • getWseatBytes

        public com.google.protobuf.ByteString getWseatBytes​(int index)
         Allowlist of buyer seats (e.g., advertisers, agencies) that can bid
 on this deal. IDs of seats and knowledge of the buyer's customers to
 which they refer must be coordinated between bidders and the exchange
 a priori. Omission implies no seat restrictions.
        repeated string wseat = 4;
        Specified by:
        getWseatBytes in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the wseat at the given index.

      • getWadomainList

        public com.google.protobuf.ProtocolStringList getWadomainList()
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Specified by:
        getWadomainList in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        A list containing the wadomain.

      • getWadomainCount

        public int getWadomainCount()
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Specified by:
        getWadomainCount in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        The count of wadomain.

      • getWadomain

        public String getWadomain​(int index)
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Specified by:
        getWadomain in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The wadomain at the given index.

      • getWadomainBytes

        public com.google.protobuf.ByteString getWadomainBytes​(int index)
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Specified by:
        getWadomainBytes in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the wadomain at the given index.

      • hasAt

        public boolean hasAt()
         Optional override of the overall auction type of the bid request,
 where 1 = First Price, 2 = Second Price Plus, 3 = the value passed
 in bidfloor is the agreed upon deal price. Additional auction types
 can be defined by the exchange.
        optional .com.google.openrtb.AuctionType at = 6;
        Specified by:
        hasAt in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        Whether the at field is set.

      • getAt

        public OpenRtb.AuctionType getAt()
         Optional override of the overall auction type of the bid request,
 where 1 = First Price, 2 = Second Price Plus, 3 = the value passed
 in bidfloor is the agreed upon deal price. Additional auction types
 can be defined by the exchange.
        optional .com.google.openrtb.AuctionType at = 6;
        Specified by:
        getAt in interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder
        Returns:
        The at.

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

      • 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.Pmp.Deal parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static OpenRtb.BidRequest.Imp.Pmp.Deal 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.Pmp.Deal parseFrom​(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

        public OpenRtb.BidRequest.Imp.Pmp.Deal.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.Pmp.Deal.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.Pmp.Deal.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.Pmp.Deal> 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.Pmp.Deal getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Pmp.Deal>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder