Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-023 What does a deal's cat mean without cattax, which "defines" the taxonomy?

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

What the schemas do

The descriptions say that cattax names cat's taxonomy; no rule is stated, since no sentence of the text requires cattax with cat.

Options

  • description Chosen

    The descriptions say that cattax names cat's taxonomy; no rule is stated, since no sentence of the text requires cattax with cat.

  • default-1

    cattax defaults to 1, as OpenRTB 2.6 defaults it.

Why

The text says only that the taxonomy "is defined by the cattax field", with no keyword, so the schema states no rule; each description says what the other means. OpenRTB 2.6 defaults cattax to 1, IAB Content Category Taxonomy 1.0, which the Deals API doesn't say.

What we ask the specification to state

Say whether cattax is required with cat, or give it a default, as OpenRTB 2.6 defaults it to 1.

The specification lines it rests on

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

main

  • Object: Inventory, the cat row L131 at 3028ddc
    cat | string array | Array of IAB Tech Lab content categories included in the deal. The taxonomy to be used is defined by the cattax field.
  • Object: Inventory, the cattax row L132 at 3028ddc
    cattax | integer | The taxonomy in use for the cat attribute. Refer to List: Category Taxonomies.

Tag 1.0-202602

  • Object: Inventory, the cat row L131 at 938a5d1
    cat | string array | Array of IAB Tech Lab content categories included in the deal. The taxonomy to be used is defined by the cattax field.
  • Object: Inventory, the cattax row L132 at 938a5d1
    cattax | integer | The taxonomy in use for the cat attribute. Refer to List: Category Taxonomies.

What it shapes

main: Inventory.cat, Inventory.cattax

Tag 1.0-202602: Inventory.cat, Inventory.cattax

The record's YAML file