Skip to content

§ 2, § 4.1.4, § 5.6.3 — Packages: line items sold only together, in place of requires and linked_execution - #154

Open
KonstantinMirin wants to merge 97 commits into
IABTechLab:mainfrom
KonstantinMirin:op30-packages
Open

KonstantinMirin wants to merge 97 commits into
IABTechLab:mainfrom
KonstantinMirin:op30-packages

Conversation

@KonstantinMirin

Copy link
Copy Markdown

What this changes

The draft links line items in two ways, and neither keeps a line item about itself. linked_execution on the proposal has one value, all, so it works as a Boolean and covers only the whole proposal. requires lets a line item name others, so their state reaches it:

  • A line item can become non-committable because a line item it names sells out.
  • Its visibility follows theirs: the bonus example is registry_gated because the display line item it names is.
  • After agreed, cancelling a named line item invokes the dependent line item's cancellation_policy.
  • If A requires B and B requires C, buying A requires C, though A never names C.

This PR puts what spans line items one level up, on a package that holds them.

  • § 4.1: a proposal holds line_items[] or packages[], not both.
  • § 4.1.4: a Package holds line_items[], sold only together, and add_ons[], sold only with all of them once its min_commitments[] are met. A line item sold alone is a package of one, and a proposal sold only whole is one package.
  • § 4.1.4: a commit that names part of a package, or an add-on without its package, returns not_committable.
  • § 5.6.3: a bonus line item is an add-on, priced on its own.
  • § 5.6.2: the holds on a package's line items move as a unit.
  • § 2.1 and § 2.3: ProposalSummary lists packages in place of has_requires.
  • § 4.1.1 and § 5.8: the binding record and a response keep a line item's package.
  • requires and linked_execution are removed.

Related issue

Refs #23 and #6 (OQ-5). Refs #50, #86, #103, and #106.

Builds on

This PR builds on our formats PR, the last of our stack, so applying all 17 in order gives the final text. It replaces the requires and linked_execution of #70 by @Sirajmx, which our PRs carry; our comment on #70 says why. Review the last non-merge commit.

Type

  • Editorial — no normative effect
  • Normative — changes what the spec requires
  • Breaking — would break an implementation already built to this draft
  • Examples / schema / docs only

Checklist

  • The body section is updated — § 2, § 2.1, § 2.3, § 2.4, § 4.1, § 4.1.1 to § 4.1.4, § 5.6, § 5.6.2, § 5.6.3, § 5.8, § 6.1, § 6.5, § 6.6, and § 8 question 5, with OQ-5 in docs/open-questions.md
  • Appendix A (field index) matches the body. linked_execution and requires go, and packages[] comes. scripts/check_appendix.py passes: 95 field names, 97 rows
  • Appendix B (fields by marker, and the counts) matches the body — seller-set 46 → 45; 98 → 97 fields; 26 touched by the buyer
  • Any affected example in examples/ is updated and still parses. examples/proposal-package.yaml holds the CTV and audio line items of proposal.yaml as a package, with the CTV bonus as its add-on, and the bonus leaves proposal.yaml. manifest.json is regenerated, and neither record_digest changes. scripts/check_examples.py checks one shape per proposal, unique ids, the Package keys, thresholds on the package's own line items, and that a line item in both proposals is the same. All three checks pass
  • RFC 2119 keywords used deliberately — MUST / SHOULD / MAY are not synonyms
  • The no-inheritance rule (§ 2) still holds — no line item names another, and a package holds only its line items and thresholds
  • Anything selectable declares available[] and included[]; anything settable declares bounds (§ 3.1, § 3.2) — no new selectable or settable fields
  • No confidential or commercially sensitive content

Knock-on effects

Open questions

  1. What does cancelling one line item of an agreed package do to the rest? § 8 question 5 asks.
  2. Should a package carry terms its line items share, such as one exclusivity term for a domination, as @premesh asks on [Change] § 5.9, § 5.6, § 2.1 — Add delivery_type: guaranteed, share_of_voice, non_guaranteed #93? This PR adds none.

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.

Sirajmx and others added 30 commits October 6, 2026 16:28
§ 5.2 properties can carry apps[] (platform, bundle, storeurl, domain),
keyed as the OpenRTB 2.6 app object where one exists. Each property
must carry domains, apps or both. The CTV example carries an app.

Refs IABTechLab#15
§ 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
Without apps[].domain a buyer has nothing to run the app-ads.txt check
against. RECOMMENDED (SHOULD) rather than a conditional REQUIRED, as the
object has no field in which a seller claims app-ads.txt authorisation.

Refs IABTechLab#15
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
Move the summary rule out of the § 2.1 key list, drop skip from the CTV example, and mark the CHANGELOG entry as breaking.
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
- Rename apps[].domain to developer_domain, as IABTechLab#15 filed it. It is the
  developer domain from the store listing that app-ads.txt uses, not
  OpenRTB 2.6 app.domain, which is the domain of the app.
- Define platform as the store that issued bundle, since a bundle is
  unique only within its store.
- List apps[].platform and apps[].bundle in the Summary Representation
  (section 2.1), as IABTechLab#15 asked.

Refs IABTechLab#15
Add built_by to an asset, so assets[] can hold a seller-built read and
its provenance. The seller writes the supplied keys of such an entry,
and adding one needs no new version. A live read has no file to record,
so it has no entry.

Refs IABTechLab#5, IABTechLab#32
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
A commitment now names whom the spend is for.
A commitment now names whom the spend is for.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants