Repository navigation
§ 5.6, § 5.6.5 to § 5.6.7 — Pricing: cost methods, currency, cancellation, and exclusivity (#94, #98) - #146
KonstantinMirin wants to merge 63 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
|
Thanks for carrying
On |
Make commitment.advertisers[] REQUIRED, so a commitment says whom the spend is for. Make ground REQUIRED on a decline entry. Require an answer to a commit under a firm entry while the entry holds, so that silence can't work as a decline on no ground. Refs IABTechLab#65, IABTechLab#126, IABTechLab#153
State that held means reserved inventory. Keep a hold live while a commit made during it is open, so a seller can't leave the commit unanswered until the hold lapses and then decline it for lack of availability. Add the seller's hold reference and renewal_right, an offered term for the right to the next cycle. Refs IABTechLab#66
Add seller_domain to a VersionRef outside its proposal, because a proposal_id is unique only within a seller's domain. Let a Deals API push carry the baseline in ext.baseline, so a DSP can join the deal to its record. Refs IABTechLab#31, IABTechLab#132
State the sign of agreed_rate and have the checker flag a spend commitment with no rate. Let a counter of list_rate also change included[], for a counter on a composed rate. Add location to separation, and have a demographic term state how it treats co-viewers and unknown age. Correct the discussion document's unit wording. Refs IABTechLab#38, IABTechLab#98, IABTechLab#117
|
Thanks, @premesh. We'd rather not span line items, though. Postindustria's view is that the line item is the unit, and each stands on its own: a term on one line item shouldn't reach another, and only the proposal binds them. If that isn't enough, the place is a level up, on the proposal. Analyzed and generated with the help of Claude, fully reviewed by me. |
What this changes
Draft 1 doesn't say what two
pricing[]entries mean or which currency applies. Its cancellation and exclusivity options have no keys.pricing[]entries are alternatives, named bypricing_id, and the buyer commits under one (§ 5.6). An entry can name the mechanisms it prices.agreed_rate, and alist_ratecounter can changeincluded[](§ 4.3.1), from @aleksUIX.separationaddslocation, and ademographicterm states co-viewers and unknown age.cost_methodand lists ten core terms with the unit each counts.FLAThas none. It definesderived_units, the seller total, andFLATandTIMEfigures.CurrencyCode, and other amounts in the committed entry's, socommitment.currencyandmin_commitments[].currencygo.Amountshares one basis, which § 8 question 9 leaves open.commitment_bounds.spendreplacesmin_spendand the budget keys, andpricing[].unit_boundsthe impression keys, in the entry's unit.CancellationNotice, and § 5.6.7 the exclusivity option.Related issue
Closes #94. Closes #98. Both are Postindustria (IAB Tech Lab member) change requests.
Refs #115, #30, #127, #125, #121, #117, and #70.
Builds on
This PR builds on our holds PR and our handoff PR, and through them on our post-agreement PR, our signing PR, our buyer writes PR, our lifecycle PR, our parties PR, our errors and extensions PR, and our shared types PR. It carries #18, #70, #71, and #72 by @Sirajmx, #73, #74, #75, and #76 by @Kishore-2572, and #118 by @aleksUIX. Review the last two non-merge commits, the #117 merge by @aleksUIX, and the merge that resolves where our holds and signing PRs overlap.
Type
Checklist
docs/open-questions.mdOQ-9pricing_id,rate_per,unit_label,cost_definition,cost_parameters,transaction_mechanisms[], andunit_boundsadded underpricing[], andmin_spendremoved. Rates areAmount,currencyis aCurrencyCode, andavailability,commitment_bounds, andexclusivityare typed.scripts/check_appendix.pypasses, withAvailability,CancellationOption,ExclusivityTerm,MinCommitment, andCancellationNoticeoff the pending listimmutable9 → 10,seller-set40 → 44,requestable4 → 5; 87 → 93 fieldsexamples/is updated and still parses — the renames throughout, and flight bounds. Display shows USD and EUR alternatives, and audio shows priced exclusivity. Display, CTV, and audio offer cancellation options, and the issued proposal records a partial cancellation. Bothrecord_digestvalues are recomputed, andmanifest.jsonis regenerated.scripts/check_examples.pyrecomputes the commitment arithmetic, the bounds, and the cancellation shares, and passes.scripts/check_pricing_fixtures.pypasses 60 of 60pricing[]entryselectabledeclaresavailable[]andincluded[]; anythingsettabledeclares bounds (§ 3.1, § 3.2) —cancellation_policyandexclusivitykeep both; thecommitmentbounds arecommitment_bounds.spendandunit_boundsKnock-on effects
pricing_id.availabilityrenamestypeandas_of, dropsbasis, and requireswindow.Availabilitytypes our holds PR'sheld_availability, andCancellationNoticeour post-agreement PR'scancellation. Our handoff PR's totals read the seller total, andLine.ratetypemapsCPMVand dailyTIME.ProductionOption.cost. Our settlement PR adds themrcterm and reads shortfalls against these bounds.version'slist_rate, soaccepted_counterandselection_keygo.CONTRIBUTING.mdand the comment template drop the PG and PMP floor scenario.pricing_id.derived_unitsrounds down, the first rule they offered.loopandinstall_dateare core terms, as @premesh asked on #98.unit_periodscounts their [Comment] § 5.2 Static OOH: posting cycles, printed material, install lead time and proof of posting #125 posting cycle.delta_flatcharges, answering @dineshbhat's [Change] § 5.6.1 — State what commitment.amount includes (rate basis, third-party fees, tax) #115 and @aleksUIX on #30.pricing[].unitbecomesunit_label, andcost_definitionaDocumentRef. Only unit bounds move into each entry (question 1).notice_period,fee[],basis,rate,before_start,periods[], andflight_startbecomenotice_duration,fees[],calculation,share,before_reference,dated_shares[], andflight.cattaxbecomestaxonomy, andstartandendbecomewindow.Open questions
list_ratecarries it, with the negotiated options inincluded[], so acountermay change both. Droppingaccepted_counterandselection_keystands.scripts/check_examples.pyflags aspendcommitment with no rate.CancellationNoticename thedated_shares[]entry it cancels under?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.