Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-016 May a deal send both wseat and bseat, when "At most, only one of wseat and bseat should be used in the same request"?

Gap Cited on main and at the tag 1.0-202602.

What the schemas do

A rule, at the should level: a deal that sends both gets a warning; "the same request" reads as the same deal.

Options

  • warning-rule Chosen

    A rule, at the should level: a deal that sends both gets a warning; "the same request" reads as the same deal.

  • schema

    The schema rejects a deal that sends both.

Why

The sentence, copied from OpenRTB's BidRequest, speaks of a request; in the Deals API the push is the deal, so it reads as one deal. It says should, so the rule warns. It is written twice, in each row; wseat's carries the rule, and bseat's restates it.

What we ask the specification to state

Say "in the same deal" for the Deals API, since the push carries one deal, and write the level in capitals.

The specification lines it rests on

Each line is quoted as the record pins it. Expand an item to read the quote.

main

  • Object: Deal, a requirement L92 at 3028ddc
    At most, only one of wseat and bseat should be used in the same request.
  • Object: Deal, a requirement L93 at 3028ddc
    At most, only one of wseat and bseat should be used in the same request.
  • Object: Deal, the wseat row L92 at 3028ddc
    wseat | string array, recommended | Allowed list of buyer seats (e.g., advertisers, agencies) allowed to bid on this impression. IDs of seats and knowledge of the buyer's customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.
  • Object: Deal, the bseat row L93 at 3028ddc
    bseat | string array | Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression. IDs of seats and knowledge of the buyer's customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.

Tag 1.0-202602

  • Object: Deal, a requirement L92 at 938a5d1
    At most, only one of wseat and bseat should be used in the same request.
  • Object: Deal, a requirement L93 at 938a5d1
    At most, only one of wseat and bseat should be used in the same request.
  • Object: Deal, the wseat row L92 at 938a5d1
    wseat | string array, recommended | Allowed list of buyer seats (e.g., advertisers, agencies) allowed to bid on this impression. IDs of seats and knowledge of the buyer's customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.
  • Object: Deal, the bseat row L93 at 938a5d1
    bseat | string array | Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression. IDs of seats and knowledge of the buyer's customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.

What it shapes

main: Deal.bseat, Deal.wseat

Tag 1.0-202602: Deal.bseat, Deal.wseat

The record's YAML file