Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-012 Which field does the guidance's curationfee name, when the Curation table names the fee type curfeetype?

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

What the schemas do

curfeetype, the table's name: the guidance and the example scenarios describe its codes by another name.

Options

  • curfeetype Chosen

    curfeetype, the table's name: the guidance and the example scenarios describe its codes by another name.

  • curationfee

    A second field, curationfee, which no table defines.

Why

The guidance's codes, 3 for a CPM and 2 for a flat fee, are curfeetype's, and no table defines a curationfee, so the guidance names curfeetype by another name. The table is the definition, so its name wins. The lint reports curationfee as a name that resolves to nothing.

What we ask the specification to state

Rename curationfee in the Curation Fee guidance and in the Example Scenarios header to curfeetype, the table's name.

The specification lines it rests on

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

main

  • Curation Fee, a sentence L289 at 3028ddc
    curationfee provides information about the type of fee being applied in the bidstream, but not what that fee is.
  • Curation Fee, a sentence L289 at 3028ddc
    For example, if a curator is charging a CPM of $5, the curationfee will equal 3 because it is a CPM.
  • Curation Fee, a sentence L289 at 3028ddc
    If a curator is charging a flat fee of $100, the value sent in the curationfee attribute will be 2, because it is a flat fee.
  • Object: Curation, the curfeetype row L145 at 3028ddc
    curfeetype | int | Fee type being applied for curation of the deal: 0 = undisclosed 1 = percentage of spend 2 = flat fee 3 = CPM 4 = no fee is paid for curation services See Implementation Guidance for additional detail
  • Object: Curation, the curfeetype row's description: the value list L145 at 3028ddc
    0 (undisclosed) | 1 (percentage of spend) | 2 (flat fee) | 3 (CPM) | 4 (no fee is paid for curation services)

Tag 1.0-202602

  • Curation Fee, a sentence L289 at 938a5d1
    curationfee provides information about the type of fee being applied in the bidstream, but not what that fee is.
  • Curation Fee, a sentence L289 at 938a5d1
    For example, if a curator is charging a CPM of $5, the curationfee will equal 3 because it is a CPM.
  • Curation Fee, a sentence L289 at 938a5d1
    If a curator is charging a flat fee of $100, the value sent in the curationfee attribute will be 2, because it is a flat fee.
  • Object: Curation, the curfeetype row L145 at 938a5d1
    curfeetype | int | Fee type being applied for curation of the deal: 0 = undisclosed 1 = percentage of spend 2 = flat fee 3 = CPM 4 = no fee is paid for curation services See Implementation Guidance for additional detail
  • Object: Curation, the curfeetype row's description: the value list L145 at 938a5d1
    0 (undisclosed) | 1 (percentage of spend) | 2 (flat fee) | 3 (CPM) | 4 (no fee is paid for curation services)

What it shapes

main: CurationFeeType, Curation.curfeetype

Tag 1.0-202602: CurationFeeType, Curation.curfeetype

The record's YAML file