Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-031 What is each of the Deals API's own code lists called?

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

What the schemas do

After what its codes are, as the text names them: a seller's deal status, an ad type, auxiliary data, a publisher count, dynamic inventory, a price type, included inventory, a curation fee type, and a buyer's deal status.

Options

  • by-meaning Chosen

    After what its codes are, as the text names them: a seller's deal status, an ad type, auxiliary data, a publisher count, dynamic inventory, a price type, included inventory, a curation fee type, and a buyer's deal status.

  • by-field

    After the field's name as written, such as sellerstatus and curfeetype.

Why

A list is named for what its values are (type rules § 6), and the text names most of them in its headings and labels: Auxiliary Data, Publisher Count, Dynamic Inventory, Included Inventory, "Deal Price Type", the curation fee type. So the vocabularies are SellerDealStatus, AdType, AuxiliaryData, PublisherCount, DynamicInventory, PriceType, IncludedInventory, CurationFeeType, and BuyerDealStatus, the two statuses told apart by the system they are kept in.

What we ask the specification to state

Name each code list in the text, so that every implementation uses the same names for them.

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 sellerstatus row's description: the value list L88 at 3028ddc
    0 (deal is active) | 1 (deal is paused) | 2 (deal is pending) | 3 (deal is complete (ie. selling scomplete (ie. selling system shows deal has completed)) | 4 (deal is archived (cannot be active again))
  • Object: Deal, the adtypes row's description: the value list L94 at 3028ddc
    1 (Banner) | 2 (Video) | 3 (Audio) | 4 (Native)
  • Object: Deal, the auxdata row's description: the value list L95 at 3028ddc
    0 (undisclosed) | 1 (yes, at start of deal and will not be modified) | 2 (yes and subject to change after start of deal) | 3 (no and will not be modified) | 4 (no and subject to change after start of deal)
  • Object: Deal, the pubcount row's description: the value list L96 at 3028ddc
    0 (undisclosed) | 1 (single publisher) | 2 (multi-publisher)
  • Object: Deal, the dinventory row's description: the value list L97 at 3028ddc
    0 (undisclosed) | 1 (inventory will NOT update once the deal goes live) | 2 (inventory where this deal may run is updated dynamically.)
  • Object: Terms, the pricetype row's description: the value list L114 at 3028ddc
    0 (Dynamic (ie. auction type will be provided by request.at attribute in OpenRTB Bid Request)) | 1 (First Price) | 2 (Second Price Plus) | 3 (Fixed Price)
  • Object: Inventory, the inclinventory row's description: the value list L126 at 3028ddc
    1 (site) | 2 (app) | 3 (dooh) | 4 (audio) | 5 (endemic) | 6 (other)
  • 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)
  • Object: BuyerStatus, the status row's description: the value list L174 at 3028ddc
    0 (pending approval) | 1 (buyer has approved (ie. non PG deal is ready for bid requests)) | 2 (buyer has rejected) | 3 (ready to serve (ie. deal is in a campaign - ready to receive bid requests, relevant especially for PG deals)) | 4 (active (i.e. deal is actively serving impressions)) | 5 (paused) | 6 (complete (ie. buying system shows deal has completed))

Tag 1.0-202602

  • Object: Deal, the sellerstatus row's description: the value list L88 at 938a5d1
    0 (deal is active) | 1 (deal is paused) | 2 (deal is pending) | 4 (deal is complete (ie. selling scomplete (ie. selling system shows deal has completed)) | 4 (deal is archived (cannot be active again))
  • Object: Deal, the adtypes row's description: the value list L94 at 938a5d1
    1 (Banner) | 2 (Video) | 3 (Audio) | 4 (Native)
  • Object: Deal, the auxdata row's description: the value list L95 at 938a5d1
    0 (undisclosed) | 1 (yes, at start of deal and will not be modified) | 2 (yes and subject to change after start of deal) | 3 (no and will not be modified) | 4 (no and subject to change after start of deal)
  • Object: Deal, the pubcount row's description: the value list L96 at 938a5d1
    0 (undisclosed) | 1 (single publisher) | 2 (multi-publisher)
  • Object: Deal, the dinventory row's description: the value list L97 at 938a5d1
    0 (undisclosed) | 1 (inventory will NOT update once the deal goes live) | 2 (inventory where this deal may run is updated dynamically.)
  • Object: Terms, the pricetype row's description: the value list L114 at 938a5d1
    0 (Dynamic (ie. auction type will be provided by request.at attribute in OpenRTB Bid Request)) | 1 (First Price) | 2 (Second Price Plus) | 3 (Fixed Price)
  • Object: Inventory, the inclinventory row's description: the value list L126 at 938a5d1
    1 (site) | 2 (app) | 3 (dooh) | 4 (audio) | 5 (endemic) | 6 (other)
  • 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)
  • Object: BuyerStatus, the status row's description: the value list L174 at 938a5d1
    0 (pending approval) | 1 (buyer has approved (ie. non PG deal is ready for bid requests)) | 2 (buyer has rejected) | 3 (ready to serve (ie. deal is in a campaign - ready to receive bid requests, relevant especially for PG deals)) | 4 (active (i.e. deal is actively serving impressions)) | 5 (paused) | 6 (complete (ie. buying system shows deal has completed))

What it shapes

main: AdType, AuxiliaryData, BuyerDealStatus, CurationFeeType, DynamicInventory, IncludedInventory, PriceType, PublisherCount, SellerDealStatus

Tag 1.0-202602: AdType, AuxiliaryData, BuyerDealStatus, CurationFeeType, DynamicInventory, IncludedInventory, PriceType, PublisherCount, SellerDealStatus

The record's YAML file