Package 

Class Deal

  • 
public final class Deal

    This object constitutes a specific deal that was struck a priori between a buyer and a seller. Its presence with the Pmp collection indicates that this impression is available under the terms of that deal.

    • Constructor Summary

      Constructors 
      Constructor Description
      Deal(String id)

    • Method Summary

      Modifier and Type Method Description
      final Integer getBidFloor() Minimum bid for this impression expressed in CPM.
      final Unit setBidFloor(@SerializedName(value = bidfloor) Integer bidFloor) Minimum bid for this impression expressed in CPM.
      final String getBidFloorCurrency() Currency specified using ISO-4217 alpha codes.
      final Unit setBidFloorCurrency(@SerializedName(value = bidfloorcur) String bidFloorCurrency) Currency specified using ISO-4217 alpha codes.
      final Integer 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.
      final Unit setAt(@SerializedName(value = at) Integer at) 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.
      final Array<String> getWhiteListSeatIDs() Whitelist of buyer seats (e.g., advertisers, agencies) allowed to bid on this deal.
      final Unit setWhiteListSeatIDs(@SerializedName(value = wseat) Array<String> whiteListSeatIDs) Whitelist of buyer seats (e.g., advertisers, agencies) allowed to bid on this deal.
      final Array<String> getAdvertiserDomains() Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal.
      final Unit setAdvertiserDomains(@SerializedName(value = wadomain) Array<String> advertiserDomains) Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal.
      final Object getExtension() Placeholder for exchange-specific extensions to OpenRTB.
      final Unit setExtension(@SerializedName(value = ext) Object extension) Placeholder for exchange-specific extensions to OpenRTB.
      final String getId() A unique identifier for the direct deal.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getBidFloor

         final Integer getBidFloor()

        Minimum bid for this impression expressed in CPM.

      • setBidFloor

         final Unit setBidFloor(@SerializedName(value = bidfloor) Integer bidFloor)

        Minimum bid for this impression expressed in CPM.

      • getBidFloorCurrency

         final String getBidFloorCurrency()

        Currency specified using ISO-4217 alpha codes. This may be different from bid currency returned by bidder if this is allowed by the exchange.

      • setBidFloorCurrency

         final Unit setBidFloorCurrency(@SerializedName(value = bidfloorcur) String bidFloorCurrency)

        Currency specified using ISO-4217 alpha codes. This may be different from bid currency returned by bidder if this is allowed by the exchange.

      • getAt

         final Integer 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.

      • setAt

         final Unit setAt(@SerializedName(value = at) Integer at)

        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.

      • getWhiteListSeatIDs

         final Array<String> getWhiteListSeatIDs()

        Whitelist of buyer seats (e.g., advertisers, agencies) allowed to bid on this deal. IDs of seats and the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. Omission implies no seat restrictions.

      • setWhiteListSeatIDs

         final Unit setWhiteListSeatIDs(@SerializedName(value = wseat) Array<String> whiteListSeatIDs)

        Whitelist of buyer seats (e.g., advertisers, agencies) allowed to bid on this deal. IDs of seats and the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. Omission implies no seat restrictions.

      • getAdvertiserDomains

         final Array<String> getAdvertiserDomains()

        Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal. Omission implies no advertiser restrictions.

      • setAdvertiserDomains

         final Unit setAdvertiserDomains(@SerializedName(value = wadomain) Array<String> advertiserDomains)

        Array of advertiser domains (e.g., advertiser.com) allowed to bid on this deal. Omission implies no advertiser restrictions.

      • getExtension

         final Object getExtension()

        Placeholder for exchange-specific extensions to OpenRTB.

      • setExtension

         final Unit setExtension(@SerializedName(value = ext) Object extension)

        Placeholder for exchange-specific extensions to OpenRTB.

      • getId

         final String getId()

        A unique identifier for the direct deal.