Deals Object

Note

Fields marked with an asterisk (*) are optional.

Deal Object Properties

Value	Type	Description
id	string	Deal ID, for example, "AA-1234" Note: Do not use any of the following symbols in the Deal ID, as doing so will result in request invalidation: , # % $ @ * & ? ! ` ~ " ' / \ | ( ) { } [ ]+ = ^ :
wseat*	array of strings	Array of Buyer seats allowed to bid on this Direct Deal, for example, ["58", "99"]. If present, the allowed seat IDs may be supplied using the BidSwitch or Supplier taxonomy. The BidSwitch taxonomy uses the Buyer ID as the single seat ID value. The seat in the Supplier taxonomy may represent the whole Buyer or some entity on the Buyer side (e.g. agency) A bid request may contain multiple seat IDs in the Supplier taxonomy. The bid response should contain the appropriate seat value corresponding to one of values of the wseat field, see the Seat Bid Object section.
bidfloor*	float	Deal price in CPM. If it’s a fixed price deal as set using deals.at = 3 then this field sets the the exact price of the deal, otherwise this is the bid floor of the deal, for example, 1.3
bidfloorcur*	string	Bid floor currency specified using ISO-4217 alpha codes, for example, "USD"
at*	integer	Auction type. 1 for first price auction. 2 for second price auction. 3 for fixed price deal.

Deal Extension Object

Deal Ext Object Properties

Value	Type	Description
buyer_wseat*	array of strings	Specifies the Advertisers/Agencies that should have access to this deal in the Buyer’s system. You should use their seat ID with the Buyer, e.g. ["agency-123", "advertiser-456"]. Note: To obtain the correct Seat ID for an agency at a particular Buyer you will need to contact the agency. You may also find more information about this in the buyers field description of the Deals Sync API for Suppliers section.
deal_type*	int	Indicates additional details about the type of deal, the default is 0 0 Unknown deal type 1 Preferred deal 2 Private auction 3 Programmatic guaranteed 4 Auction package

Deals Object Example

{
  "pmp":{
    "private_auction":1,
    "deals":[
      {
        "id":"deal-1",
        "wseat":[
          "58"
        ],
        "bidfloor":2.5,
        "at":1,
        "ext":{
          "deal_type":3,
          "buyer_wseat":[
            "abc-123"
          ]
        }
      },
      {
        "id":"deal-2",
        "bidfloor":2,
        "at":2
      }
    ]
  }
}