Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-013 Which field does inclinventory.adtype=1,2 name, when inclinventory has no member adtype?

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

What the schemas do

adtypes, whose codes 1 and 2 are banner and video, as the sentence describes.

Options

  • adtypes Chosen

    adtypes, whose codes 1 and 2 are banner and video, as the sentence describes.

  • inclinventory

    inclinventory, whose codes 1 and 2 are site and app.

Why

The sentence says the expression "means the deal is inclusive of both banner and video ads", which are adtypes' codes 1 and 2; inclinventory's 1 and 2 are site and app. So the example names adtypes. The lint reports inclinventory.adtype as a name that resolves to nothing. The following sentence, which tells implementers what bid requests to expect, is informative.

What we ask the specification to state

Write the example as adtypes=1,2: inclinventory has no member adtype, and its codes 1 and 2 are site and app.

The specification lines it rests on

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

main

  • Included Inventory, a sentence L248 at 3028ddc
    For example, inclinventory.adtype=1,2 means the deal is inclusive of both banner and video ads.
  • Included Inventory, a requirement L248 at 3028ddc
    Implementers should expect to see ORTB bid requests using either imp.banner or imp.video once the deal is in flight.
  • Object: Deal, the adtypes row L94 at 3028ddc
    adtypes | int array | The format of the ad creative(s) supported by the inventory in the deal: 1 = Banner 2 = Video 3 = Audio 4 = Native If this is empty or missing, the deal is assumed to apply to all types of ad creative.

Tag 1.0-202602

  • Included Inventory, a sentence L248 at 938a5d1
    For example, inclinventory.adtype=1,2 means the deal is inclusive of both banner and video ads.
  • Included Inventory, a requirement L248 at 938a5d1
    Implementers should expect to see ORTB bid requests using either imp.banner or imp.video once the deal is in flight.
  • Object: Deal, the adtypes row L94 at 938a5d1
    adtypes | int array | The format of the ad creative(s) supported by the inventory in the deal: 1 = Banner 2 = Video 3 = Audio 4 = Native If this is empty or missing, the deal is assumed to apply to all types of ad creative.

What it shapes

main: Deal.adtypes

Tag 1.0-202602: Deal.adtypes

The record's YAML file