Repository navigation
§ 5.2, § 5.6.4 — DOOH: plays, impressions, and what a commitment commits (#92, #96) - #148
Open
KonstantinMirin wants to merge 59 commits into
Open
KonstantinMirin wants to merge 59 commits into
KonstantinMirin wants to merge 59 commits into
Conversation
§ 5.6 defines floor as the seller's offer floor at proposal time, not the downstream auction floor and not a guarantee that bids will clear. Editorial: the meaning of the field is unchanged. Refs IABTechLab#16
A proposal can say its line items must be bought together (linked_execution, § 4.1), and a line item can name the line items or spend that must be in the same commitment (requires, § 5.6.3). A bonus line is a line item with requires and its own price. The § 2 "binding terms" hook now points at a field, and the Summary Representation carries has_requires and linked_execution. Adds a CTV bonus line example (§ 6.5) and linked_execution: none to the proposal example. Refs IABTechLab#23
The seller declares which exclusion types it accepts and how it
enforces each (exclusions_accepted); the buyer supplies its lists
(exclusions). Blocked apps carry their store, { platform, bundle },
so one store id is never applied across stores. Exclusions are
recompute inputs (§ 3.3) and are never disclosed to other parties
(§ 5.8). The display example declares and supplies lists.
Refs IABTechLab#25
A line item whose rate differs by market can declare geo with the selectable structure of § 3.1: available[], included[], pricing deltas and max_select. A geo that declares only allowed[] stays settable, so existing payloads are unchanged. When several priced markets are selected, the highest delta applies. The audio example is priced by market. Refs IABTechLab#14
A commitment names the proposal and version it was priced against (§ 5.6.1). The seller rejects a new attempt on a stale version, or past valid_until or price_valid_until, and returns the current version. An authenticated replay with the same idempotency_key and terms returns the stored result without re-running those checks; the same key with different terms is a conflict. Keys are opaque and scoped to one buyer and seller pair. § 4.1 states that each revision while published increments version. The display, CTV and audio examples carry proposal_id and version. Refs IABTechLab#24
§ 4.1 adds an optional, immutable proposal_template_id linking an issued proposal to the seller's template. Each issued proposal has its own status, version and negotiation_history[], and buyers never need the template id to transact. § 7 adds a non-normative note separating seller-side templates from the issued proposals buyers commit against. Appendix A gains one row; Appendix B counts immutable 6 → 7 and 72 fields. The proposal example carries a proposal_template_id. Refs IABTechLab#26
§ 5.8 adds terms_ref ({ url, sha256, version }), REQUIRED when
terms_acceptance_required is true, hash-pinned and frozen at agreed, so
assent binds to an exact document. § 5.10 adds agreement_ref, an
informative pointer to the master or annual agreement a line item is
priced under, and documents the io and agreement roles on
external_references[]. IO generation is stated to be a connector
concern, and § 7 adds a non-normative note on relationships.
agreement_ref is seller-set; a buyer-held agreement id travels as an
external_references[] entry with role: agreement, so the field keeps
one marker (§ 3).
Appendix A gains two rows; Appendix B counts seller-set 29 → 31 and
73 fields. The display example carries terms_ref.
Refs IABTechLab#27
A new § 2.3 lets a seller publish its public standard line items at /.well-known/openproposal.json: seller_id, generated_at, spec_version and, per proposal, proposal_id, version, the Summary Representation of each line item and a full_url. ETag / Last-Modified are required, only line items with visibility public appear, and entries must match the current version. Buyers discover from the manifest, then fetch the Full Representation of shortlisted line items. Adds examples/manifest.json (§ 6.5) and visibility: public to the CTV and audio examples; the registry_gated display line item is not listed. Refs IABTechLab#29
The specification does not define authentication yet (WS1; see IABTechLab#62), so the replay rule now applies to a replay from the same buyer rather than an authenticated replay. Refs IABTechLab#24
agreement_ref.parties used buyer_id, which the specification does not define. parties[] now names the seller by its seller_id and the buyer by the id it holds in eligible_bidders[] (section 5.8). Refs IABTechLab#27
The rule that a hold on a linked_execution: all proposal uses hold_scope: proposal came from a comment on IABTechLab#23, not the change request as filed. It moves to the PR description as a point for the working group, so this PR carries only the filed change. Refs IABTechLab#23
IABTechLab#25 names the content-category list iab_content_category[], a list of IAB Content Taxonomy ids. The earlier commit renamed it content_category with a version-pinned taxonomy_ref, which nobody proposed. This restores the filed name and shape; which taxonomy version to reference is left to the working group. Refs IABTechLab#25
IABTechLab#14 doesn't say how deltas combine when a buyer selects more than one priced market, and neither did any comment on it. The earlier commit said the highest delta applies; that is a design choice nobody proposed, so it moves to the PR description as a question. Refs IABTechLab#14
Read the media condition from the ad served when an impression accepts several media, name the seller as the party that serves, place linear TV outside the table, and state environments as (distribution channel, device type) pairs. Insert environments.available[] into the summary list without rewrapping it, shorten the changelog entry and drop audio_streaming from OQ-7 in docs/open-questions.md. Refs IABTechLab#90
time_zone is the line item's clock for daypart windows and
frequency_cap.period: an IANA time zone name or viewer_local. A window
is { days[], start, end } in civil time with an exclusive end later
than start, up to 24:00; a window that crosses midnight is two windows.
List the `days[]` values once in the `daypart` row, as `monday` | ... | `sunday`. Write HH:MM, America/New_York, and UTC as plain text, since they're a format and examples, not field names. The meaning is unchanged.
"At least one of" an empty list is never satisfied, so the bonus line would fail a literal check. An absent key sets no condition. Only the examples change; the any_of[] row and the rules stay as filed in IABTechLab#23. Refs IABTechLab#23
The floor row now says it "neither constrains nor describes the downstream auction floor", as IABTechLab#16 asked, and names that floor: the per-impression floor the exchange applies at auction time (OpenRTB 2.6 Imp.bidfloor). Refs IABTechLab#16
From the Postindustria review on IABTechLab#73: - a replay matches on the same body, every value the buyer sent except idempotency_key, and returns the stored result whether an acceptance or a rejection; a retry against a new version uses a new key; - version increments on each revision of the proposal, not only while published, so a counter under review also moves it; - "deterministic" now says what the checks depend on: the stored proposal and the time the seller receives the attempt; - the price check names the pricing[] entry the commitment is priced against. Refs IABTechLab#24
# Conflicts: # examples/proposal.yaml # spec/openproposal-3.0.md
Separate shared and issued proposals, and add issued_from. Define the binding record, record_digest, and assent[] entries, freeze a version's offered terms, and state one staleness rule for asks and holds. Give each act one history action, name the status types, make the line-item transitions exhaustive, define a firm entry per pricing entry, and list the allowed decline grounds once. State agreed once. Remove buyer state from the shared examples, add an issued, partly agreed example, and recompute its record_digest in the checker.
Keep record_digest only on assent entries, and state the exact digest bytes. Cut the record to terms: min_rate, the advisory fields, segments, and the suppression list leave it, and seller_rate and deal_id_issuance go. Give AssentEntry a key table with four roles, so only assent[] decides agreed, and move idempotency_key onto the entry. Name the Commit and its CommitResult. The seller recomputes the digest over the line items as they stand, and rejects in a stated order. A commitment entry stops being live when its commit goes stale or void. Carry entries in messages signed under the OpenProposal profile of Web Bot Auth, as optional evidence. Add HttpsUrl, and replace terms_ref with terms_refs[] of DocumentRef. Add the agreed record example, and teach the checker the assent rules.
Add selected[] as the complete set of options in effect and value as the one buyer key on a settable field, with an explicit default. An envelope's value narrows allowed[], and the bare-value fallbacks go. Every object option has an id, unique in its field. Name BuyerWrites, LineItemWrites, and the availability read. Give agreed_rate one formula, on the committed entry only, rounded once. Rename gross_rate to list_rate, floor to min_rate, a hint, and delta_pct to delta_fraction, a fraction. Make list_rate and commitment_bounds requestable, mark commitment mixed, and give transaction_mechanism max_select 1. Split geo into a settable geo and a selectable markets over GeoCode, type device as AdCOM codes and daypart as ClockWindow, and delete supported_formats. Update the examples, the issued record_digest, the appendices, and the example checker.
Split what a request or response carries from the message envelope in section 1.2, and resolve its placeholders. The wire contract governs only once it is on a standards track. Name the baseline as the VersionRef of the agreed line item at the version of its agreed record. Add change_requests[] in section 4.4 with the OpenDirect 2.1 ChangeRequest fields except webhook, plus baseline, actor, at, and cancellation. Require orderid only when the line item has an order reference. Remove correlation_id, give ExternalReference a key table, rename role to reference_type, and replace io with order and line. Let an entry carry ext outside the record, and ask in section 8 how an entry states a change other than a cancellation. CancellationNotice stays pending until its key table lands. Retitle sections 5.10 and 6.8, and update the agreed example, the appendices, the issue templates, and the checkers. Refs IABTechLab#59, IABTechLab#68
Put one table of transaction_mechanism values in section 5.9. It states
which are deal mechanisms and which delivery_type each allows. Key
section 1.1 on those values, with each one's reference type and change
path. An option is { id, delivery_type }, and sov_basis and sov_share
describe a share of voice. Remove open_auction, because with no deal ID
no bid request can name a line item.
Map a line item agreed under a deal mechanism to a Deals API 1.0 Deal
that deal_origin pushes, with price_type saying how agreed_rate clears.
Map a direct_io line item, and a programmatic guaranteed reservation, to
an OpenDirect 2.1 Order and Line, and state what the record doesn't hold.
Define each creative_delivery.method as a creative path. Remove
buying_route and supported_order_systems, and type serving_platform as a
Domain. Update the examples, digests, manifest, appendices, and checkers.
Refs IABTechLab#132, IABTechLab#133, IABTechLab#93, IABTechLab#109
Replace hold_status with hold_terms, a seller-set offer inside the binding record, and hold, live state outside it, so the removal path has no exception. Rename state and hold_expires_at to status and valid_until, add position, the order in which holds are granted, and leave hold absent until the buyer first asks. Close the hold machine: add declined, re-entry to requested, and the re-offer as listed transitions, and state the cap on valid_until. Give hold a version and two optional keys, requested_terms as LineItemWrites and held_availability as Availability, which stays pending until its key table lands. Remove hold_scope: under linked_execution all, holds move as a unit. Stop the CTV example offering a hold on private_auction, show a full hold in the issued example, and recompute its digest. Drop the checker's handling of exceptions in removal paths, and check the keys of LineItemWrites. Refs IABTechLab#66
Open the cost_method vocabulary, with a unit and a rate per for each core term in section 5.6.5. Make pricing entries alternatives named by pricing_id. Read every Amount in the committed entry's CurrencyCode, remove commitment.currency, and ask in section 8 what basis a money value is on. Replace min_spend and the budget keys with commitment_bounds.spend, and the impression keys with pricing[].unit_bounds. Give Availability, CommitmentBounds, and MinCommitment key tables, and point the section 1.1 totals at the seller total. Define cancellation options, the notice a change request records, and exclusivity options. Teach the example checker the commitment arithmetic, the bounds, and the cancellation checks. Have it check that an array whose row says MUST be non-empty holds an entry. Align the pricing vectors with these names, and update the examples, digests, manifest, and appendices. Replace the PG and PMP floor example in CONTRIBUTING.md and the comment template, since pricing entries can name their mechanisms. Refs IABTechLab#94, IABTechLab#98, IABTechLab#117, IABTechLab#127, IABTechLab#115, IABTechLab#30, IABTechLab#70, IABTechLab#125, IABTechLab#121
Settlement reads the terms in force: the agreed record plus any change the applying system has applied. Section 5.7.1 names what no downstream standard states, and states the shortfall and remedy rules once. controlling_measurement names whose count is invoiced and when it is final. measured_by and counted_by are a Measurer, with a qualifier for a product or method. CommittedMetric gets a key table with level and direction, and basis and seller_reported go. metric gets a core table of rate terms that cite their standards. shortfall_remedy becomes a ShortfallRemedy with RemedyTerms, and section 8 gains question 10. verification[] holds domains, viewability_standard gains mrc, feed_type and delivery_mechanism become report_type and delivery_method, and guaranteed covers a FLAT entry. The examples name the measurement vendors by domain, and the checkers read the metric table and type the new keys.
When channel is dooh, a property is a set of screens of one venue type, with venue_type, allocation, min_screens, screens[], slots_per_loop, and sync_groups[]. frequency_cap.per gains the screen term, and a loop_time share derives from the loop. Section 5.6.4 defines a play and an impression. delivery_counting, REQUIRED on a dooh line item, holds the play tolerance, a keyed proof_of_performance, partial_play_credit, and a nested impression_multiplier that only a line item counting impressions needs. The committed quantity is in the committed entry's unit, and the multiplier's source controls the count of impressions. Add the DOOH example. The example checker reads the new paths and checks the counter against the multiplier's source.
This was referenced Nov 4, 2026
Open
Open
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this changes
Draft 1 sells DOOH, but doesn't say what a screen, a play, or an impression is, or whose multiplier turns plays into impressions. This PR states each.
channelisdooh, a property is a set of screens of one venue type (§ 5.2). It carriesvenue_type,allocation,min_screens,screens[],slots_per_loop, andsync_groups[].frequency_cap.perbecomes aVocabularyTermwith the core termscreen(§ 5.5).delivery_counting, REQUIRED on adoohline item, holds the play tolerance, proof of performance, partial-play credit, and the multiplier. A line item that counts only plays needs no multiplier.PLAYcommits plays andCPMcommits impressions.counted_bynames that source. § 5.7.1 adds the count termimpressions.loop_timeshare derives from the loop and requiresallocation: all. A domination isguaranteedwith sole exclusivity (§ 5.9).venue_typeand the multiplier's type and source (§ 2.1). New § 6.9 shows a DOOH line item.Related issue
Closes #92. Closes #96.
Refs #79 and #134.
Builds on
This PR builds on our settlement PR and, through it, on these PRs of ours:
Through them it carries #18, #70, #71, and #72 by @Sirajmx, #73, #74, #75, and #76 by @Kishore-2572, and #117 and #118 by @aleksUIX. Review the last commit; earlier ones belong to the PRs it builds on.
Type
Checklist
delivery_countingseller-set;scripts/check_appendix.pypassesseller-set43 → 44; 93 → 94 fieldsexamples/is updated and still parses — newline-item-dooh.yaml(§ 6.9):CPMon looped screens, with a vendor multiplier and no count that repeatscommitment.manifest.jsondoesn't change, because the example isn't public.scripts/check_examples.pyreads the new paths, checkscounted_byagainst the multiplier's source, and passes.scripts/check_pricing_fixtures.pypasses 60 of 60delivery_countingsits on the line item, and the DOOH keys on each property optionselectabledeclaresavailable[]andincluded[]; anythingsettabledeclares bounds (§ 3.1, § 3.2) — no newselectableorsettablefields;frequency_capkeeps its boundsKnock-on effects
doohline item built to draft 1 lacksdelivery_counting, and its properties lackvenue_type. A property needsscreens[]unless itsallocationisseller_allocated.partial_play_credittheir follow-up, withpro_ratadivided as they answered. Oneproof_of_performancewith typed evidence follows their #125 proposal.seller_allocateda buyer doesn't pick screens. A domination is modeled as they suggested.loop_timeshare and names its eligible screens. § 5.9 states both.screenas a core term. Their [Impl] DOOH line items have no standardized fields for venue, screens, spot and loop length, share of voice or impressions per play #134 test finds fields here for venue, screens, loop, and impressions per play.impression_multipliernests insidedelivery_counting.sourcetypebecomessource_type,logged_byaMeasurer, andevidence[]aVocabularyTerm. A restatement counts until the count is final, which answers question 2.slotsandsync_groupbecomeslots_per_loopandsync_group_id, andscreenjoinsper, formerlybasis. "The committed quantity follows the product" gives way to the committed entry's unit.propertiesrow.source_typeto its AdCOM list and excludes Unknown (0).Open questions
FLATday count ondooh: plays, or impressions? Does aFLATentry onseller_allocatedneed animpression_multiplier?By opening this pull request I agree my contribution may be published under this
repository's licence, as set out in CONTRIBUTING.md.
Analyzed and generated with the help of Claude, fully reviewed by me.