Package com.google.openrtb

Class OpenRtb.BidRequest.Imp.Pmp.Deal.Builder

    • Method Detail

      • 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.Builder<OpenRtb.BidRequest.Imp.Pmp.Deal.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OpenRtb.BidRequest.Imp.Pmp.Deal.Builder>

      • 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

      • build

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

      • buildPartial

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

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

      • setId

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder setId​(String value)
         A unique identifier for the direct deal.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder clearId()
         A unique identifier for the direct deal.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Returns:
        This builder for chaining.

      • setIdBytes

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder setIdBytes​(com.google.protobuf.ByteString value)
         A unique identifier for the direct deal.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.

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

      • setBidfloor

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder setBidfloor​(double value)
         Minimum bid for this impression expressed in CPM.
        optional double bidfloor = 2 [default = 0];
        Parameters:
        value - The bidfloor to set.
        Returns:
        This builder for chaining.

      • clearBidfloor

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder clearBidfloor()
         Minimum bid for this impression expressed in CPM.
        optional double bidfloor = 2 [default = 0];
        Returns:
        This builder for chaining.

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

      • setBidfloorcur

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder setBidfloorcur​(String value)
         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"];
        Parameters:
        value - The bidfloorcur to set.
        Returns:
        This builder for chaining.

      • clearBidfloorcur

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder clearBidfloorcur()
         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"];
        Returns:
        This builder for chaining.

      • setBidfloorcurBytes

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder setBidfloorcurBytes​(com.google.protobuf.ByteString value)
         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"];
        Parameters:
        value - The bytes for bidfloorcur to set.
        Returns:
        This builder for chaining.

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

      • setWseat

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder setWseat​(int index,
                                                        String value)
         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;
        Parameters:
        index - The index to set the value at.
        value - The wseat to set.
        Returns:
        This builder for chaining.

      • addWseat

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder addWseat​(String value)
         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;
        Parameters:
        value - The wseat to add.
        Returns:
        This builder for chaining.

      • addAllWseat

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder addAllWseat​(Iterable<String> values)
         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;
        Parameters:
        values - The wseat to add.
        Returns:
        This builder for chaining.

      • clearWseat

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder clearWseat()
         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;
        Returns:
        This builder for chaining.

      • addWseatBytes

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder addWseatBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes of the wseat to add.
        Returns:
        This builder for chaining.

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

      • setWadomain

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder setWadomain​(int index,
                                                           String value)
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Parameters:
        index - The index to set the value at.
        value - The wadomain to set.
        Returns:
        This builder for chaining.

      • addWadomain

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder addWadomain​(String value)
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Parameters:
        value - The wadomain to add.
        Returns:
        This builder for chaining.

      • addAllWadomain

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder addAllWadomain​(Iterable<String> values)
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Parameters:
        values - The wadomain to add.
        Returns:
        This builder for chaining.

      • clearWadomain

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder clearWadomain()
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Returns:
        This builder for chaining.

      • addWadomainBytes

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder addWadomainBytes​(com.google.protobuf.ByteString value)
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Parameters:
        value - The bytes of the wadomain to add.
        Returns:
        This builder for chaining.

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

      • setAt

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder setAt​(OpenRtb.AuctionType value)
         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;
        Parameters:
        value - The at to set.
        Returns:
        This builder for chaining.

      • clearAt

        public OpenRtb.BidRequest.Imp.Pmp.Deal.Builder clearAt()
         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;
        Returns:
        This builder for chaining.