Deal Object

This request.item.deal object array contains the details of a deal struck between both parties prior to delivering it through BidSwitch.

Deal Object Properties
Value Type Description
id string (Required) The Deal ID, for example, "AA-1234"
wseat* array of strings

Array of Buyer seats allowed to bid on this 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.
flr* 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
flrcur* 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 JSON Example

An example of how an array of item.deal objects that might appear in a request.

{
    "deal":[
        {
            "id":"video-vmax-124476-hagg",
            "flr":10.23,
            "wseat":[
                "355",
                "128"
            ],
            "at":1
        },
        {
            "id":"yol-geo-277639-ott",
            "flr":5.36,
            "wseat":[
                "340",
                "123"
            ],
            "at":3
        }
    ]
}

Table Of Contents