Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-018 How is guar written, and what does a missing guar mean?

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

What the schemas do

The integer 0 or 1, as the row writes "where 0 = not a guaranteed deal, 1 = guaranteed deal", each code named, with no default: a missing guar states nothing.

Options

  • integer-flag Chosen

    The integer 0 or 1, as the row writes "where 0 = not a guaranteed deal, 1 = guaranteed deal", each code named, with no default: a missing guar states nothing.

  • default-0

    The integer 0 or 1, with 0 as the default, since a deal that says nothing isn't guaranteed.

Why

The row types guar int and gives its two codes, so it is the integer flag AdCOM and OpenRTB write, 0 or 1, and every other value fails. It is the same kind of flag as an OpenRTB key such as instl, so the schema shares one type, whose two codes are named No and Yes; the row's own words, not a guaranteed deal and guaranteed deal, stay in its description. The text gives no default, so none is assumed. The row's "the bidder must bid on the deal" binds the buyer, an obligation.

What we ask the specification to state

Give guar a default, or say what a missing guar means.

The specification lines it rests on

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

main

  • Object: Terms, the guar row L113 at 3028ddc
    guar | int | Indicates that the deal is of type guaranteed and the bidder must bid on the deal, where 0 = not a guaranteed deal, 1 = guaranteed deal.
  • Object: Terms, a requirement L113 at 3028ddc
    Indicates that the deal is of type guaranteed and the bidder must bid on the deal, where 0 = not a guaranteed deal, 1 = guaranteed deal.

Tag 1.0-202602

  • Object: Terms, the guar row L113 at 938a5d1
    guar | int | Indicates that the deal is of type guaranteed and the bidder must bid on the deal, where 0 = not a guaranteed deal, 1 = guaranteed deal.
  • Object: Terms, a requirement L113 at 938a5d1
    Indicates that the deal is of type guaranteed and the bidder must bid on the deal, where 0 = not a guaranteed deal, 1 = guaranteed deal.

What it shapes

main: IntegerFlag, Terms.guar

Tag 1.0-202602: IntegerFlag, Terms.guar

The record's YAML file