Package com.google.openrtb

Interface OpenRtb.BidRequest.Imp.Pmp.DealOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.
      String getId()
      A unique identifier for the direct deal.
      com.google.protobuf.ByteString getIdBytes()
      A unique identifier for the direct deal.
      String getWadomain​(int index)
      Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal.
      com.google.protobuf.ByteString getWadomainBytes​(int index)
      Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal.
      int getWadomainCount()
      Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal.
      List<String> getWadomainList()
      Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal.
      String getWseat​(int index)
      Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this deal.
      com.google.protobuf.ByteString getWseatBytes​(int index)
      Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this deal.
      int getWseatCount()
      Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this deal.
      List<String> getWseatList()
      Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this deal.
      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.
      boolean hasBidfloor()
      Minimum bid for this impression expressed in CPM.
      boolean hasBidfloorcur()
      Currency specified using ISO-4217 alpha codes.
      boolean hasId()
      A unique identifier for the direct deal.

      • 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 the direct deal.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Returns:
        Whether the id field is set.

      • getId

        String getId()
         A unique identifier for the direct deal.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         A unique identifier for the direct deal.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Returns:
        The bytes for id.

      • hasBidfloor

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

      • getBidfloor

        double getBidfloor()
         Minimum bid for this impression expressed in CPM.
        optional double bidfloor = 2 [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 = 3 [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 = 3 [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 = 3 [default = "USD"];
        Returns:
        The bytes for bidfloorcur.

      • getWseatList

        List<String> 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;
        Returns:
        A list containing the wseat.

      • getWseatCount

        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;
        Returns:
        The count of wseat.

      • getWseat

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The wseat at the given index.

      • getWseatBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the wseat at the given index.

      • getWadomainList

        List<String> getWadomainList()
         Array of advertiser domains (e.g., advertiser.com) allowed to
 bid on this deal. Omission implies no advertiser restrictions.
        repeated string wadomain = 5;
        Returns:
        A list containing the wadomain.

      • getWadomainCount

        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;
        Returns:
        The count of wadomain.

      • getWadomain

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The wadomain at the given index.

      • getWadomainBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the wadomain at the given index.

      • hasAt

        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;
        Returns:
        Whether the at field is set.

      • getAt

        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;
        Returns:
        The at.