Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-022 Is desc at most 250 characters, and each sellerids value at most 64, when the text says "strongly recommended" and "Should be limited"?

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

What the schemas do

Two rules, at the should level: a longer value gets a warning and stays valid.

Options

  • warning-rules Chosen

    Two rules, at the should level: a longer value gets a warning and stays valid.

  • max-length

    The schema rejects a longer value.

Why

Both sentences recommend a limit, so a longer value is still valid, and each rule warns. A schema limit would reject what the text allows.

What we ask the specification to state

Say whether the limits are hard: "at most 250 characters" and "at most 64 characters" would let a receiver reject longer values.

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 L91 at 3028ddc
    It is strongly recommended to keep this field to 250 characters or less.
  • Object: Inventory, a requirement L128 at 3028ddc
    Should be limited to 64 characters in length.
  • Object: Deal, the desc row L91 at 3028ddc
    desc | string | Short description for the deal to help the receiver locate the deal once it has been sent. It is strongly recommended to keep this field to 250 characters or less.
  • Object: Inventory, the sellerids row L128 at 3028ddc
    sellerids | string array | The identifier associated with the seller or reseller account within the advertising system. If used, the values in this attribute must contain the same value used in transactions (i.e. OpenRTB bid requests) in the field specified by the SSP/exchange. An empty list implies the deal may runs across all sellers. Typically, in OpenRTB, this is publisher.id. For OpenDirect it is typically the publisher's organization ID. Should be limited to 64 characters in length.

Tag 1.0-202602

  • Object: Deal, a requirement L91 at 938a5d1
    It is strongly recommended to keep this field to 250 characters or less.
  • Object: Inventory, a requirement L128 at 938a5d1
    Should be limited to 64 characters in length.
  • Object: Deal, the desc row L91 at 938a5d1
    desc | string | Short description for the deal to help the receiver locate the deal once it has been sent. It is strongly recommended to keep this field to 250 characters or less.
  • Object: Inventory, the sellerids row L128 at 938a5d1
    sellerids | string array | The identifier associated with the seller or reseller account within the advertising system. If used, the values in this attribute must contain the same value used in transactions (i.e. OpenRTB bid requests) in the field specified by the SSP/exchange. An empty list implies the deal may runs across all sellers. Typically, in OpenRTB, this is publisher.id. For OpenDirect it is typically the publisher's organization ID. Should be limited to 64 characters in length.

What it shapes

main: Deal.desc, Inventory.sellerids

Tag 1.0-202602: Deal.desc, Inventory.sellerids

The record's YAML file