Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-017 What do origin, seller, and curator hold, when the table and the guidance define each twice?

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

What the schemas do

A domain name, such as sspdomain.com, the table's definition: "The advertising system domain", "Canonical domain"; each description quotes the table.

Options

  • domain Chosen

    A domain name, such as sspdomain.com, the table's definition: "The advertising system domain", "Canonical domain"; each description quotes the table.

  • entity

    A name of the business entity, as the guidance's "refers to the system with the UI" and "represents the business entity" read.

Why

The table says domain for each, and the guidance's examples write domains, saleshousedomain.com and sspdomain.com, so each holds a domain name, compared as written. The guidance's second definitions describe the party the domain names, and stay informative.

What we ask the specification to state

Define origin, seller, and curator once: the table calls origin the domain of the system that receives bid responses, and the guidance the system with the UI where the deal is first input.

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, the origin row L89 at 3028ddc
    origin | string, required | The advertising system domain of the business entity that will receive bid responses for the deal, typically the SSP hosting the API.
  • Object: Deal, the seller row L90 at 3028ddc
    seller | string, recommended | Canonical domain of the business entity who sold the deal. This may be the same as the origin or curator, but it also could be any intermediate seller. See Implementation Guidance for additional detail
  • Object: Curation, the curator row L143 at 3028ddc
    curator | string | Canonical domain of the business entity that did the packaging of inventory, technology and/or data. Most often, this will be the seller of the deal.
  • Origin, Curator, and Seller, a sentence L258 at 3028ddc
    The origin attribute refers to the system with the UI where the deal is first input.
  • Origin, Curator, and Seller, a sentence L260 at 3028ddc
    The curator attribute names the business entity that did the packaging of inventory, technology and/or data.
  • Origin, Curator, and Seller, a sentence L262 at 3028ddc
    The seller attribute represents the business entity who has sourced the demand (aka contracted with the buyer of the deal).
  • Example 1, a sentence L272 at 3028ddc
    In this case the seller=saleshousedomain.com, the curator=curatordomain.com, and the origin=sspdomain.com
  • Example 2, a sentence L281 at 3028ddc
    In this case the seller=publishercompany.com, the curator=datacompany.com, and the origin=sspdomain.com

Tag 1.0-202602

  • Object: Deal, the origin row L89 at 938a5d1
    origin | string, required | The advertising system domain of the business entity that will receive bid responses for the deal, typically the SSP hosting the API.
  • Object: Deal, the seller row L90 at 938a5d1
    seller | string, recommended | Canonical domain of the business entity who sold the deal. This may be the same as the origin or curator, but it also could be any intermediate seller. See Implementation Guidance for additional detail
  • Object: Curation, the curator row L143 at 938a5d1
    curator | string | Canonical domain of the business entity that did the packaging of inventory, technology and/or data. Most often, this will be the seller of the deal.
  • Origin, Curator, and Seller, a sentence L258 at 938a5d1
    The origin attribute refers to the system with the UI where the deal is first input.
  • Origin, Curator, and Seller, a sentence L260 at 938a5d1
    The curator attribute names the business entity that did the packaging of inventory, technology and/or data.
  • Origin, Curator, and Seller, a sentence L262 at 938a5d1
    The seller attribute represents the business entity who has sourced the demand (aka contracted with the buyer of the deal).
  • Example 1, a sentence L272 at 938a5d1
    In this case the seller=saleshousedomain.com, the curator=curatordomain.com, and the origin=sspdomain.com
  • Example 2, a sentence L281 at 938a5d1
    In this case the seller=publishercompany.com, the curator=datacompany.com, and the origin=sspdomain.com

What it shapes

main: Domain, Curation.curator, Deal.origin, Deal.seller

Tag 1.0-202602: Domain, Curation.curator, Deal.origin, Deal.seller

The record's YAML file