Repository navigation
§ 5.2.4 to § 5.2.8 — Property option: seller relationship, app identity, and screens (#88) - #149
Open
KonstantinMirin wants to merge 118 commits into
Open
KonstantinMirin wants to merge 118 commits into
KonstantinMirin wants to merge 118 commits into
Conversation
§ 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
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
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
…ntract No IAB Tech Lab document defines the AAMP wire and lifecycle contract yet. The pre-release iab-agentic-primitives library's OpenAPI file and JSON Schemas define the messages the reference agents exchange, so an implementer can use them as the binding until the contract is published. Refs IABTechLab#59
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 lets a seller list any domain without saying by what right it sells it. Its property keys sit in prose. This PR gives the property option one key table, and each part of it a numbered section.
PropertyOptionhas one key table. Each property statesseller_relationshipandchild_audience, and carriesdomains[],apps[], or both. Whenpropertiesis absent, the seller promises no property.AppIdis{ store, bundle }, andAppaddsstore_urlanddeveloper_domain.store, aVocabularyTerm, names the app store.SellerAccountnames the accounts it checks. An app's governing developer domain comes from its store listing.audiencesand buyer-supplied data.Screen,Loop, andSyncGrouptables.app_bundle[]becomesapps[]ofAppId.Option.scripts/check_appendix.pylints both.child_audience, andseller_relationship. § 2.7 coversstore_urlas an author-chosen URL.Related issue
Closes #88.
Refs #15, #17, #96, #97, and #71.
Builds on
This PR builds on our DOOH PR and, through it, on these PRs of ours:
It merges #17 by @Sirajmx. Through our PRs 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 commit "Give the property option one key table and one app identity".
Type
Checklist
propertieskeepsSelectable[PropertyOption];scripts/check_appendix.pypassesexamples/is updated and still parses. Each property gainsseller_relationship,child_audience, andseller_accounts[].platform: rokubecomesstore: roku_channel_store, and the audio example names a property.manifest.jsonis regenerated, and both proposal examples carry a recomputedrecord_digest.scripts/check_examples.pyreads the new tables and passes.scripts/check_pricing_fixtures.pypasses 60 of 60storethe seller doesn't know.selectabledeclaresavailable[]andincluded[]; anythingsettabledeclares bounds (§ 3.1, § 3.2) —propertieskeeps both; no newselectableorsettablefieldsKnock-on effects
seller_relationshipandchild_audience. A property sold by a reseller or through a deal mechanism needsseller_accounts[].developer_domainstays RECOMMENDED but informative. The check reads the store listing, which closes the gap @fgranata raised.inventory_partner_domainsits on the property, and § 5.2.6 checksseller_accounts[]against the partner's ads.txt.AppId.platformbecomesstore,storeurlbecomesstore_url, andapp_bundle[]becomesapps[].inventorypartnerdomainbecomesinventory_partner_domain.seller_accounts[]is REQUIRED when the line item offers a deal mechanism (§ 5.9), not when it offers anything butDIRECT_IO. The manager row readsgeoormarkets.Screen.time_zoneis OPTIONAL.child_audienceandchild_treatmentbecomePropertyOptionrows. Our audience PR brings the audience half.exclusionsas a map whoseappsentries areAppId. Until then,apps[]sits beside the other block-list keys.line-item-ctv.yaml, and our formats PR reconciles them.Open questions
seller_relationshipis REQUIRED, andinventory_partner_domainsits on the property. Question 4 is settled here: this PR merges § 5.2 — App identity on properties (#15) #17 and makesdeveloper_domaininformative.propertiesis OPTIONAL, so a line item with no property states no seller relationship or child-directed status. Shouldpropertiesbe REQUIRED, so that every line item states a seller relationship and a child-directed status?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.