Deal Object

Note

Fields marked with an asterisk (*) are optional.

Deal Object Properties

Value

Type

Description

id

string

Deal ID, for example, "AA-1234"

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 is a fixed price deal (deal.at = 3) then this is 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.

ext*

object

See the Deal Extension Object section.

Deal Extension Object

Deal Ext Object Properties

Value

Type

Description

data_src*

string

The ID of the data provider from which the the deal originates, e.g. "data vendor 1"

If this field is missing, then the deal is coming from inventory source (SSP or publisher)

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

Deal Object Example

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