Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-030 What is the Example Scenarios table, the text's only example in a table?

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

What the schemas do

Each row is part of a deal: its curationfee column is curation.curfeetype, and its auxdata, pubcount, and dinventory columns are the deal's own. A row holds no id, origin, or terms, so it is no whole deal, and each value it holds is checked against its field's schema.

Options

  • partial-deals Chosen

    Each row is part of a deal: its curationfee column is curation.curfeetype, and its auxdata, pubcount, and dinventory columns are the deal's own. A row holds no id, origin, or terms, so it is no whole deal, and each value it holds is checked against its field's schema.

  • informative

    The table is prose: it names no payload.

Why

The columns name fields and the cells hold their codes, so each row writes four values of one deal, which the examples check field by field. The header curationfee names no field; it is curfeetype, the Curation table's name. The scenario's description is the row's first cell. Examples 1 and 2 of the guidance are prose that says which domain each party's attribute names, seller, curator, and origin, so they show roles, not a payload, and are informative.

What we ask the specification to state

Add a complete example deal, and a status response, in JSON, so implementers can check their payloads against the text.

The specification lines it rests on

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

main

  • Example Scenarios, concept row 1 L296 at 3028ddc
    Publisher packages their O&O inventory and data, and sells a deal to a buyer. No other party is or will be involved in the deal and the inventory will remain static throughout the term of the deal. | 4 | 3 | 1 | 1
  • Example Scenarios, concept row 2 L297 at 3028ddc
    Data company packages their data across multiple publishers, but does not charge a fee for the specific curation service. Data providers will not be changed, but inventory may be updated after the start of the deal. | 4 | 1 | 2 | 2
  • Example Scenarios, concept row 3 L298 at 3028ddc
    Curation company charges a CPM fee to aggregate inventory across multiple publishers that they will add and remove as the deal is in flight to optimize deal performance. They have an optimization service, and work with additional data providers to increase addressability, and expect to add additional data partners throughout the flight. | 3 | 2 | 2 | 2
  • Example Scenarios, concept row 4 L299 at 3028ddc
    Curation company works with inventory aggregation company that regularly adds new websites and charges a % of spend to optimize deals. They do not currently work with other data providers, but may layer them in based on deal performance. | 1 | 4 | 1 | 2
  • Example Scenarios, concept row 5 L300 at 3028ddc
    SSP pays a Curator a CPM to decorate inventory across the SSP universe that they do not pass on to the publishers. All inventory and data is subject to change. | 3 | 2 | 2 | 2

Tag 1.0-202602

  • Example Scenarios, concept row 1 L296 at 938a5d1
    Publisher packages their O&O inventory and data, and sells a deal to a buyer. No other party is or will be involved in the deal and the inventory will remain static throughout the term of the deal. | 4 | 3 | 1 | 1
  • Example Scenarios, concept row 2 L297 at 938a5d1
    Data company packages their data across multiple publishers, but does not charge a fee for the specific curation service. Data providers will not be changed, but inventory may be updated after the start of the deal. | 4 | 1 | 2 | 2
  • Example Scenarios, concept row 3 L298 at 938a5d1
    Curation company charges a CPM fee to aggregate inventory across multiple publishers that they will add and remove as the deal is in flight to optimize deal performance. They have an optimization service, and work with additional data providers to increase addressability, and expect to add additional data partners throughout the flight. | 3 | 2 | 2 | 2
  • Example Scenarios, concept row 4 L299 at 938a5d1
    Curation company works with inventory aggregation company that regularly adds new websites and charges a % of spend to optimize deals. They do not currently work with other data providers, but may layer them in based on deal performance. | 1 | 4 | 1 | 2
  • Example Scenarios, concept row 5 L300 at 938a5d1
    SSP pays a Curator a CPM to decorate inventory across the SSP universe that they do not pass on to the publishers. All inventory and data is subject to change. | 3 | 2 | 2 | 2

The record's YAML file