feat: add capability_id to PackageRequest and Package (v2 format-selection at create_media_buy)#4844
Closed
bokelley wants to merge 1 commit into
Closed
feat: add capability_id to PackageRequest and Package (v2 format-selection at create_media_buy)#4844bokelley wants to merge 1 commit into
bokelley wants to merge 1 commit into
Conversation
…t-selection gap at create_media_buy Adds `capability_id?: string` to `PackageRequest` (v2 write path) and the confirmed `Package` response (echo), so buyers can use the same stable publisher-scoped identifier from `ProductFormatDeclaration` (discovery via get_products) through buy creation without translating back through v1_format_ref[]. Existing `format_ids[]`-based requests are unchanged (additive only). Sellers echo `capability_id` on the confirmed package when the buyer supplied it. Normative resolution rules (capability_id-only, both, v1-only, neither) and UNSUPPORTED_FEATURE error-on-miss behavior added to schema descriptions and MDX docs. x-entity: "product_format_declaration" registered and applied to all four `capability_id` fields across the full storyboard — creative-manifest.json, creative-asset.json, package-request.json, and core/package.json. Closes #4842 https://claude.ai/code/session_01BaWxg6AXPsEdPUTVSmfYS1
Contributor
Author
|
Closing as superseded by current main. The v2 create_media_buy format-selection path has landed as capability_ids[] on PackageRequest, with corresponding create_media_buy docs and UNSUPPORTED_FEATURE guidance. This draft uses the older singular capability_id shape and would roll back the current array design. |
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.
Closes #4842
Summary
AdCP's v2 format-selection path (
capability_id) was already wired at discovery (ProductFormatDeclarationviaget_products) and fulfillment (creative-manifest,creative-assetviasync_creatives), but the buy-creation step (PackageRequest/create_media_buy) was stuck on the v1format_ids[]vocabulary. Buyers had to translate back throughv1_format_ref[]— the exact bridge this PR removes.Changes:
media-buy/package-request.json— addscapability_id?: stringas the v2 alternative toformat_ids[]. Full normative resolution rules (4 states: capability_id-only, both, v1-only, neither) andUNSUPPORTED_FEATUREerror-on-miss behavior in the field description.core/package.json— addscapability_id?: stringon the confirmed Package response; sellers echo it when the buyer used the v2 path.core/x-entity-types.json— registers new entity typeproduct_format_declarationand annotates all fourcapability_idfields across the full storyboard (creative-manifest, creative-asset, package-request, core/package) withx-entity: "product_format_declaration".core/creative-manifest.json,core/creative-asset.json— addsx-entity: "product_format_declaration"to existingcapability_idfields (these were un-annotated; fixed as part of the same storyboard consistency pass).docs/media-buy/task-reference/create_media_buy.mdx— addscapability_idrow to the Package Object table,†footnote, and a new "v2 format selection" subsection with resolution-rule table and example. Updates stale normative text ("format IDs are required" → "format specification tells the publisher…")..changeset/package-request-capability-id.md—minorbump (additive optional field on published schema surface).Non-breaking justification
package-request.jsonhas"additionalProperties": trueat the root. Old sellers ignorecapability_idand continue processingformat_ids[]unchanged. No existing required field was modified. The v1format_ids[]-only path is explicitly preserved in all four resolution-rule states.Pre-PR review
Two expert passes completed (2-iteration cap per playbook).
Pass 1 blockers (all fixed before push):
x-entityannotation missing oncapability_id→ addedproduct_format_declarationto registry; annotated all four cross-storyboardcapability_idfieldsUNSUPPORTED_FEATURE(notVALIDATION_ERROR) — aligned withproduct-format-declaration.jsonclosed-set normstreamhaus_homepage_takeover_premium,pinnacle_reels_vertical)create_media_buy.mdxPass 2 (post-fix):
ad-tech-protocol-expert: BLOCKED —capability_idoncreative-manifest.jsonandcreative-asset.jsonmissingx-entityannotation → fixed in the same commitcode-reviewer: APPROVEDFinal compliance build: 244 x-entity annotations, 30/32 entity types in use. ✅
Opened by the AdCP triage agent · session
Generated by Claude Code