@adcp/sdk 8.1.0-beta.7 → 8.1.0-beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/README.md +12 -0
  2. package/dist/lib/schemas-data/v2.5/_provenance.json +1 -1
  3. package/dist/lib/types/activate-signal.d.ts +647 -0
  4. package/dist/lib/types/build-creative.d.ts +2105 -0
  5. package/dist/lib/types/calibrate-content.d.ts +675 -0
  6. package/dist/lib/types/check-governance.d.ts +619 -0
  7. package/dist/lib/types/comply-test-controller.d.ts +8428 -0
  8. package/dist/lib/types/create-collection-list.d.ts +693 -0
  9. package/dist/lib/types/create-content-standards.d.ts +830 -0
  10. package/dist/lib/types/create-media-buy.d.ts +3374 -0
  11. package/dist/lib/types/create-property-list.d.ts +836 -0
  12. package/dist/lib/types/delete-collection-list.d.ts +497 -0
  13. package/dist/lib/types/delete-property-list.d.ts +497 -0
  14. package/dist/lib/types/get-account-financials.d.ts +624 -0
  15. package/dist/lib/types/get-adcp-capabilities.d.ts +2863 -0
  16. package/dist/lib/types/get-collection-list.d.ts +763 -0
  17. package/dist/lib/types/get-content-standards.d.ts +919 -0
  18. package/dist/lib/types/get-creative-delivery.d.ts +2219 -0
  19. package/dist/lib/types/get-creative-features.d.ts +1736 -0
  20. package/dist/lib/types/get-media-buy-artifacts.d.ts +864 -0
  21. package/dist/lib/types/get-media-buys.d.ts +1670 -0
  22. package/dist/lib/types/get-plan-audit-logs.d.ts +455 -0
  23. package/dist/lib/types/get-products.d.ts +4935 -0
  24. package/dist/lib/types/get-property-list.d.ts +874 -0
  25. package/dist/lib/types/get-signals.d.ts +986 -0
  26. package/dist/lib/types/list-accounts.d.ts +851 -0
  27. package/dist/lib/types/list-content-standards.d.ts +975 -0
  28. package/dist/lib/types/list-creative-formats.d.ts +3132 -0
  29. package/dist/lib/types/list-creatives.d.ts +2390 -0
  30. package/dist/lib/types/list-property-lists.d.ts +855 -0
  31. package/dist/lib/types/log-event.d.ts +373 -0
  32. package/dist/lib/types/per-tool-index.json +391 -0
  33. package/dist/lib/types/preview-creative.d.ts +1981 -0
  34. package/dist/lib/types/provide-performance-feedback.d.ts +218 -0
  35. package/dist/lib/types/report-plan-outcome.d.ts +433 -0
  36. package/dist/lib/types/report-usage.d.ts +579 -0
  37. package/dist/lib/types/si-get-offering.d.ts +259 -0
  38. package/dist/lib/types/si-initiate-session.d.ts +372 -0
  39. package/dist/lib/types/si-send-message.d.ts +300 -0
  40. package/dist/lib/types/si-terminate-session.d.ts +213 -0
  41. package/dist/lib/types/sync-accounts.d.ts +856 -0
  42. package/dist/lib/types/sync-audiences.d.ts +707 -0
  43. package/dist/lib/types/sync-catalogs.d.ts +766 -0
  44. package/dist/lib/types/sync-creatives.d.ts +2134 -0
  45. package/dist/lib/types/sync-event-sources.d.ts +665 -0
  46. package/dist/lib/types/sync-governance.d.ts +558 -0
  47. package/dist/lib/types/sync-plans.d.ts +979 -0
  48. package/dist/lib/types/update-collection-list.d.ts +697 -0
  49. package/dist/lib/types/update-content-standards.d.ts +847 -0
  50. package/dist/lib/types/update-media-buy.d.ts +3047 -0
  51. package/dist/lib/types/update-property-list.d.ts +840 -0
  52. package/dist/lib/types/validate-content-delivery.d.ts +722 -0
  53. package/dist/lib/types/validate-input.d.ts +1683 -0
  54. package/dist/lib/version.d.ts +3 -3
  55. package/dist/lib/version.js +3 -3
  56. package/package.json +9 -2
@@ -0,0 +1,579 @@
1
+ // AUTO-GENERATED — DO NOT EDIT.
2
+ // Per-tool .d.ts slice for `report_usage`. Built from the published
3
+ // `tools.generated.d.ts` + `core.generated.d.ts` + `enums.generated.d.ts`
4
+ // by `scripts/generate-per-tool-types.ts`.
5
+ //
6
+ // Self-contained: imports nothing from the broader SDK. Adopters who
7
+ // import only this slice pay a fraction of the tsc cost of pulling in
8
+ // `@adcp/sdk` root — useful when strict + skipLibCheck:false adopters
9
+ // hit memory pressure on the full surface.
10
+
11
+ /**
12
+ * Reports how a vendor's service was consumed after campaign delivery. Used by orchestrators (DSPs, storefronts) to inform vendor agents (signals, governance, creative, or — when the receiving agent is the seller of the media buy itself — a sales agent for buyer-attested or vendor-attested billing reconciliation) what was used so the receiver can track earned revenue and verify billing. Records can span multiple accounts and campaigns in a single request. When the buy's `measurement_terms.billing_measurement.vendor` names a party other than the seller's own ad server, that party (or the buyer on its behalf) pushes final measurements via this task; the seller invoices against those final records. See [Billing authority](/docs/media-buy/advanced-topics/billing-authority) for the end-to-end flow.
13
+ */
14
+ export interface ReportUsageRequest {
15
+ /**
16
+ * Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.
17
+ */
18
+ adcp_version?: string;
19
+ /**
20
+ * DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.
21
+ */
22
+ adcp_major_version?: number;
23
+ /**
24
+ * Client-generated unique key for this request. If a request with the same key has already been accepted, the server returns the original response without re-processing. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request. Prevents duplicate billing on retries.
25
+ */
26
+ idempotency_key: string;
27
+ reporting_period: DatetimeRange;
28
+ /**
29
+ * One or more usage records. Each record is self-contained: it carries its own account, allowing a single request to span multiple accounts.
30
+ */
31
+ usage: {
32
+ account: AccountReference;
33
+ /**
34
+ * Seller-assigned media buy identifier. Links this usage record to a specific media buy.
35
+ */
36
+ media_buy_id?: string;
37
+ /**
38
+ * Amount owed to the vendor for this record, denominated in currency.
39
+ * @minimum 0
40
+ */
41
+ vendor_cost: number;
42
+ /**
43
+ * ISO 4217 currency code.
44
+ * @pattern ^[A-Z]{3}$
45
+ */
46
+ currency: string;
47
+ /**
48
+ * Pricing option identifier from the vendor's discovery response (e.g., get_signals, list_content_standards). The vendor uses this to verify the correct rate was applied.
49
+ */
50
+ pricing_option_id?: string;
51
+ /**
52
+ * Impressions delivered using this vendor service.
53
+ * @minimum 0
54
+ */
55
+ impressions?: number;
56
+ /**
57
+ * Media spend in currency for the period. Required when a percent_of_media pricing model was used, so the vendor can verify the applied rate.
58
+ * @minimum 0
59
+ */
60
+ media_spend?: number;
61
+ /**
62
+ * Signal identifier from get_signals. Required for signals agents.
63
+ */
64
+ signal_agent_segment_id?: string;
65
+ /**
66
+ * Content standards configuration identifier. Required for governance agents.
67
+ */
68
+ standards_id?: string;
69
+ /**
70
+ * Rights grant identifier from acquire_rights. Required for brand/rights agents. Links usage records to specific rights grants for cap tracking, billing verification, and overage calculation.
71
+ */
72
+ rights_id?: string;
73
+ /**
74
+ * Creative identifier from build_creative or list_creatives. Required for creative agents. Links usage records to specific creatives for billing verification.
75
+ */
76
+ creative_id?: string;
77
+ /**
78
+ * Property list identifier from list_property_lists. Required for property list agents. Links usage records to specific property lists for billing verification.
79
+ */
80
+ property_list_id?: string;
81
+ /**
82
+ * Whether this usage record represents the reporter's final, billing-authoritative numbers for the reporting period. **Absent means unknown** — the reporter has not declared finality on this record. Set `true` only when the reporter has actually settled the numbers (e.g., 3PAS month-end close after SIVT scrubbing, conversion dedup, and view-through windows have closed; vendor file post-C7 for broadcast). Set `false` when pushing preliminary measurements (daily pacing pushes, intra-period progress) that are still settling. Receivers MUST NOT invoice on `final: false` records, and MUST NOT invoice on records where `final` is absent for buys whose `measurement_terms.billing_measurement` names this reporter as authoritative — request a final record first. Receivers MAY invoice on absent for buys with no `measurement_terms.billing_measurement` (3.0-style usage where the receiver treats reports as authoritative on receipt) and for non-media-buy variants (signals, governance, creative, brand — domains with no provisional state concept). When the same `(account, media_buy_id, reporting_period)` is later reported with `final: true`, that record supersedes any prior records for the period.
83
+ */
84
+ final?: boolean;
85
+ /**
86
+ * ISO 8601 timestamp at which the reporter considered these numbers final. Present only when `final: true`. Anchors any deadline declared in the buy's `measurement_terms.billing_measurement.finalization_deadline_hours`.
87
+ * @format date-time
88
+ */
89
+ finalized_at?: string;
90
+ /**
91
+ * Which measurement window this record represents, referencing a window_id from the product's reporting_capabilities.measurement_windows or from `measurement_terms.billing_measurement.measurement_window`. Examples: 'c7' for broadcast TV, 'post_sivt' for digital post-IVT, 'downloads_30d' for podcast. When absent, the record is not windowed (standard digital reporting). When the buy's `measurement_terms.billing_measurement.measurement_window` is set, reporters SHOULD include `measurement_window` so the receiver can reconcile against the correct stage.
92
+ * @maxLength 50
93
+ */
94
+ measurement_window?: string;
95
+ }[];
96
+ context?: ContextObject;
97
+ ext?: ExtensionObject;
98
+ }
99
+
100
+ /**
101
+ * Response from report_usage. Partial acceptance is valid — records that pass validation are stored even when others fail.
102
+ */
103
+ export interface ReportUsageResponse {
104
+ /**
105
+ * Session/conversation identifier for tracking related operations across multiple task invocations. Managed by the protocol layer to maintain conversational context. Distinct from `context` (per-request opaque echo, see below).
106
+ */
107
+ context_id?: string;
108
+ context?: ContextObject;
109
+ /**
110
+ * Unique identifier for tracking asynchronous operations. Present when a task requires extended processing time. Used to query task status and retrieve results when complete.
111
+ */
112
+ task_id?: string;
113
+ status: TaskStatus;
114
+ /**
115
+ * Human-readable summary of the task result. Provides natural language explanation of what happened, suitable for display to end users or for AI agent comprehension. Generated by the protocol layer based on the task response.
116
+ */
117
+ message?: string;
118
+ /**
119
+ * ISO 8601 timestamp when the response was generated. Useful for debugging, logging, cache validation, and tracking async operation progress.
120
+ */
121
+ timestamp?: string;
122
+ /**
123
+ * Set to true when this response was returned from the idempotency cache rather than from a fresh execution. Set to false (or omitted) when the request was executed fresh. Buyers use this to distinguish cached replays from new executions — matters for billing reconciliation, audit logs, state-machine routing (cached state-tracking fields are historical snapshots, not current state — re-read via the resource's read endpoint), and any downstream system that assumes exactly-once event semantics. From 3.1 onward, `replayed` MAY appear on responses to any request that resolved via the idempotency cache, including read tools — universal `idempotency_key` (see security.mdx §Idempotency) means the cache holds read responses too.
124
+ */
125
+ replayed?: boolean;
126
+ adcp_error?: Error;
127
+ push_notification_config?: PushNotificationConfig;
128
+ /**
129
+ * Governance context token issued by the account's governance agent during check_governance. Buyers attach it to governed purchase requests (media buys, rights acquisitions, signal activations, creative services); sellers persist it and include it on all subsequent governance calls for that action's lifecycle. An account binds to one governance agent (see sync_governance); governance is phased across `purchase` / `modification` / `delivery`, not partitioned across specialist agents, so the envelope carries a single token for the full lifecycle.
130
+ *
131
+ * Value format: governance agents MUST emit a compact JWS per the AdCP JWS profile (see Security — Signed Governance Context). Sellers MAY verify; sellers that do not verify MUST persist and forward the token unchanged. In 3.1 all sellers MUST verify. Non-JWS values from pre-3.0 governance agents are deprecated.
132
+ *
133
+ * This is the primary correlation key for audit and reporting across the governance lifecycle.
134
+ */
135
+ governance_context?: string;
136
+ /**
137
+ * Conceptual grouping for the task-specific response data defined by individual task response schemas (e.g., get-products-response.json, create-media-buy-response.json). `payload` is a documentary construct — it is NOT a required wire field, and its on-the-wire shape depends on transport (see Transport serialization below). Task response schemas declare body fields without wrapping them in a `payload` object; the wire representation places those body fields per transport convention. On MCP the body fields appear as siblings of envelope fields at the root of the tool response; on A2A they appear inside `task.artifacts[0].parts[].DataPart`; on REST they appear at the root of the JSON body.
138
+ */
139
+ payload?: {};
140
+ /**
141
+ * Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.
142
+ */
143
+ adcp_version?: string;
144
+ /**
145
+ * DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.
146
+ */
147
+ adcp_major_version?: number;
148
+ /**
149
+ * Number of usage records successfully stored.
150
+ * @minimum 0
151
+ */
152
+ accepted: number;
153
+ /**
154
+ * Validation errors for individual records. The field property identifies which record failed (e.g., 'usage[1].pricing_option_id').
155
+ */
156
+ errors?: Error[];
157
+ /**
158
+ * When true, the account is a sandbox account and no billing occurred.
159
+ */
160
+ sandbox?: boolean;
161
+ ext?: ExtensionObject;
162
+ }
163
+
164
+ /**
165
+ * Account for product lookup. Returns products with pricing specific to this account's rate card.
166
+ */
167
+ export type AccountReference = {
168
+ /**
169
+ * Seller-assigned account identifier (from sync_accounts or list_accounts)
170
+ */
171
+ account_id: string;
172
+ } | {
173
+ brand: BrandReference;
174
+ /**
175
+ * Domain of the entity operating on the brand's behalf. When the brand operates directly, this is the brand's domain.
176
+ * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
177
+ */
178
+ operator: string;
179
+ /**
180
+ * When true, references the sandbox account for this brand/operator pair. Defaults to false (production account).
181
+ */
182
+ sandbox?: boolean;
183
+ };
184
+
185
+ /**
186
+ * Legacy authentication schemes for the webhook auth block. Bearer: token sent in Authorization header. HMAC-SHA256: legacy shared-secret signing. Both are deprecated; new integrations SHOULD omit the authentication block and use the RFC 9421 webhook signing profile (applicable on schemas where authentication is optional). Removed in AdCP 4.0.
187
+ */
188
+ export type AuthenticationScheme = 'Bearer' | 'HMAC-SHA256';
189
+
190
+ /**
191
+ * Brand identifier within the house portfolio. Optional for single-brand domains.
192
+ */
193
+ export type BrandID = string;
194
+
195
+ /**
196
+ * Brand reference for product discovery context. Resolved to full brand identity at execution time.
197
+ */
198
+ export interface BrandReference {
199
+ /**
200
+ * Domain where /.well-known/brand.json is hosted, or the brand's operating domain
201
+ * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
202
+ */
203
+ domain: string;
204
+ brand_id?: BrandID;
205
+ /**
206
+ * Inline override for the brand's industries. Useful when the caller cannot modify the brand's canonical brand.json but needs to declare industries for governance (e.g., Annex III vertical detection). brand.json remains the canonical source; when omitted here, governance agents SHOULD resolve from brand.json.
207
+ */
208
+ industries?: string[];
209
+ /**
210
+ * Inline override for the brand's contestation contact point. Useful when the operator does not control brand.json but needs to discharge Art 22(3) for this plan. brand.json is canonical; when omitted, governance agents resolve brand → house → missing.
211
+ */
212
+ data_subject_contestation?: {
213
+ [k: string]: unknown | undefined;
214
+ };
215
+ /**
216
+ * Inline override for brand-kit fields normally resolved from `/.well-known/brand.json` on `domain` (logo, colors, voice, tagline). Use when brand.json is missing, stale, or inappropriate for this specific call — e.g., a campaign-scoped tagline, a co-branded creative, a freshly-rebranded color palette the brand.json hasn't shipped yet. Same inline-override pattern as `industries` and `data_subject_contestation` above: brand.json is canonical, the override is per-call. Adopters needing to override fields outside this subset (`voice_attributes`, `prohibited_terms`, etc.) MUST publish a different brand.json and reference it via a different `domain` — the inline override is intentionally narrow to a small high-traffic subset.
217
+ *
218
+ * **Merge semantics (normative).** The merge is **field-level**, not whole-object replacement. Each field within `brand_kit_override` (`logo`, `colors`, `voice`, `tagline`) is evaluated independently — when a field is present on the override the override value applies; when a field is absent the brand.json value applies (or is absent if brand.json doesn't carry one either). For composite fields (`colors.primary`, `colors.secondary`, `colors.accent`), the merge is one level deeper: each color slot is evaluated independently — a producer can override `colors.primary` while still inheriting `colors.secondary` from brand.json. SDKs MUST NOT treat a present `brand_kit_override.colors` as wiping the brand.json `colors` block entirely; only the per-slot fields present in the override take precedence. Without this rule, a partial-override semantics would diverge across SDKs and produce inconsistent rendering for the same payload.
219
+ */
220
+ brand_kit_override?: {
221
+ logo?: ImageAsset;
222
+ /**
223
+ * Override brand colors (hex strings).
224
+ */
225
+ colors?: {
226
+ /**
227
+ * @pattern ^#[0-9a-fA-F]{6}$
228
+ */
229
+ primary?: string;
230
+ /**
231
+ * @pattern ^#[0-9a-fA-F]{6}$
232
+ */
233
+ secondary?: string;
234
+ /**
235
+ * @pattern ^#[0-9a-fA-F]{6}$
236
+ */
237
+ accent?: string;
238
+ };
239
+ /**
240
+ * Override brand-voice description for surface-composed text/audio output.
241
+ */
242
+ voice?: string;
243
+ /**
244
+ * Override tagline.
245
+ */
246
+ tagline?: string;
247
+ };
248
+ }
249
+
250
+ /**
251
+ * C2PA action classification for this watermark
252
+ */
253
+ export type C2PAWatermarkAction = 'c2pa.watermarked.bound' | 'c2pa.watermarked.unbound';
254
+
255
+ /**
256
+ * Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
257
+ */
258
+ export interface ContextObject {
259
+ }
260
+
261
+ /**
262
+ * Time period for performance measurement
263
+ */
264
+ export interface DatetimeRange {
265
+ /**
266
+ * Start timestamp (inclusive), ISO 8601
267
+ * @format date-time
268
+ */
269
+ start: string;
270
+ /**
271
+ * End timestamp (inclusive), ISO 8601
272
+ * @format date-time
273
+ */
274
+ end: string;
275
+ }
276
+
277
+ /**
278
+ * IPTC-aligned classification of AI involvement in producing this content
279
+ */
280
+ export type DigitalSourceType = 'digital_capture' | 'digital_creation' | 'trained_algorithmic_media' | 'composite_with_trained_algorithmic_media' | 'algorithmic_media' | 'composite_capture' | 'composite_synthetic' | 'human_edits' | 'data_driven_media';
281
+
282
+ /**
283
+ * How long the disclosure must persist during content playback or display
284
+ */
285
+ export type DisclosurePersistence = 'continuous' | 'initial' | 'flexible';
286
+
287
+ /**
288
+ * Where a required disclosure should appear within a creative. Used by creative briefs to specify disclosure placement and by formats to declare which positions they can render.
289
+ */
290
+ export type DisclosurePosition = 'prominent' | 'footer' | 'audio' | 'subtitle' | 'overlay' | 'end_card' | 'pre_roll' | 'companion';
291
+
292
+ /**
293
+ * How provenance data is carried within the content
294
+ */
295
+ export type EmbeddedProvenanceMethod = 'manifest_wrapper' | 'provenance_markers';
296
+
297
+ /**
298
+ * Extension object for platform-specific, vendor-namespaced parameters. Extensions are always optional and must be namespaced under a vendor/platform key (e.g., ext.gam, ext.roku). Used for custom capabilities, partner-specific configuration, and features being proposed for standardization.
299
+ */
300
+ export interface ExtensionObject {
301
+ }
302
+
303
+ /**
304
+ * Override logo asset.
305
+ */
306
+ export interface ImageAsset {
307
+ /**
308
+ * Discriminator identifying this as an image asset. See /schemas/creative/asset-types for the registry.
309
+ */
310
+ asset_type: 'image';
311
+ /**
312
+ * URL to the image asset
313
+ */
314
+ url: string;
315
+ /**
316
+ * Width in pixels
317
+ * @minimum 1
318
+ */
319
+ width: number;
320
+ /**
321
+ * Height in pixels
322
+ * @minimum 1
323
+ */
324
+ height: number;
325
+ /**
326
+ * Image file format (jpg, png, gif, webp, etc.)
327
+ */
328
+ format?: string;
329
+ /**
330
+ * Alternative text for accessibility
331
+ */
332
+ alt_text?: string;
333
+ provenance?: Provenance;
334
+ }
335
+
336
+ /**
337
+ * Provenance metadata for this asset, overrides manifest-level provenance
338
+ */
339
+ export interface Provenance {
340
+ digital_source_type?: DigitalSourceType;
341
+ /**
342
+ * AI system used to generate or modify this content. Aligns with IPTC 2025.1 AI metadata fields and C2PA claim_generator.
343
+ */
344
+ ai_tool?: {
345
+ /**
346
+ * Name of the AI tool or model (e.g., 'DALL-E 3', 'Stable Diffusion XL', 'Gemini')
347
+ */
348
+ name: string;
349
+ /**
350
+ * Version identifier for the AI tool or model (e.g., '25.1', '0125', '2.1'). For generative models, use the model version rather than the API version.
351
+ */
352
+ version?: string;
353
+ /**
354
+ * Organization that provides the AI tool (e.g., 'OpenAI', 'Stability AI', 'Google')
355
+ */
356
+ provider?: string;
357
+ };
358
+ /**
359
+ * Level of human involvement in the AI-assisted creation process. Independent of `disclosure.required` — the protocol does not derive disclosure obligations from oversight level. Some regulations include carve-outs for human-edited or human-directed AI output, but those carve-outs have factual prerequisites the schema cannot evaluate. Asserting `edited` or `directed` does not by itself justify `disclosure.required: false`.
360
+ */
361
+ human_oversight?: 'none' | 'prompt_only' | 'selected' | 'edited' | 'directed';
362
+ /**
363
+ * Party declaring this provenance. Identifies who attached the provenance claim, enabling receiving parties to assess trust.
364
+ */
365
+ declared_by?: {
366
+ /**
367
+ * URL of the agent or service that declared this provenance
368
+ */
369
+ agent_url?: string;
370
+ /**
371
+ * Role of the declaring party in the supply chain
372
+ */
373
+ role: 'creator' | 'advertiser' | 'agency' | 'platform' | 'tool';
374
+ };
375
+ /**
376
+ * When this provenance claim was made (ISO 8601). Distinct from created_time, which records when the content itself was produced. A provenance claim may be attached well after content creation, for example when retroactively declaring AI involvement for regulatory compliance.
377
+ * @format date-time
378
+ */
379
+ declared_at?: string;
380
+ /**
381
+ * When this content was created or generated (ISO 8601)
382
+ * @format date-time
383
+ */
384
+ created_time?: string;
385
+ /**
386
+ * C2PA sidecar manifest reference. Links to a detached cryptographic provenance manifest for this content. Note: file-level C2PA bindings break when ad servers transcode, resize, or re-encode assets. For pipelines with intermediaries, consider embedded_provenance as the primary provenance mechanism.
387
+ */
388
+ c2pa?: {
389
+ /**
390
+ * URL to the C2PA manifest store for this content
391
+ */
392
+ manifest_url: string;
393
+ };
394
+ /**
395
+ * Provenance metadata embedded within the content stream. Each entry declares one embedding layer: structured provenance data carried inside the content itself, as distinct from sidecar references (c2pa.manifest_url). Embedded provenance survives operations that break sidecar and file-level bindings: ad-server transcoding, CMS ingestion, copy-paste, reformatting, and CDN re-encoding. For ad-tech pipelines where content passes through multiple intermediaries, embedded provenance is the reliable path for provenance that persists from declaration through delivery. This is a declaration by the embedding party. The receiving party (the seller) is the verifier-of-record: it confirms the claim by calling a governance agent it trusts (typically one published in `creative_policy.accepted_verifiers`).
396
+ */
397
+ embedded_provenance?: {
398
+ method: EmbeddedProvenanceMethod;
399
+ /**
400
+ * Standard the embedding conforms to, if any (e.g., 'c2pa' for C2PA Section A.7 text manifest embedding)
401
+ */
402
+ standard?: string;
403
+ /**
404
+ * Organization that performed the embedding (e.g., 'Encypher', 'Digimarc'). Display label and audit context — not a wire identifier.
405
+ */
406
+ provider: string;
407
+ /**
408
+ * Buyer's representation that this embedding can be verified by a governance agent on the seller's `creative_policy.accepted_verifiers` list. The `agent_url` MUST match (canonicalized) one of the seller's published `accepted_verifiers[].agent_url` entries; sellers reject `sync_creatives` submissions whose `verify_agent.agent_url` is off-list with `PROVENANCE_VERIFIER_NOT_ACCEPTED`. This is buyer-supplied evidence, not buyer-driven routing — the seller is the verifier-of-record and the seller controls which agent it actually calls (the seller MAY use a different on-list agent if it determines this is more appropriate; the seller does not call buyer-asserted endpoints outside its allowlist). MAY be omitted for self-verifiable embeddings (e.g., a C2PA text manifest with a public key the seller already trusts).
409
+ */
410
+ verify_agent?: {
411
+ /**
412
+ * URL of the governance agent the buyer represents was used to embed/verify this layer. MUST use the `https://` scheme and MUST appear in the seller's `creative_policy.accepted_verifiers[].agent_url` list (canonicalized per /docs/reference/url-canonicalization: lowercase scheme and host, strip default port, normalize path dot-segments). Sellers MUST NOT call this URL until the canonicalized match is confirmed.
413
+ * @pattern ^https:\/\/
414
+ */
415
+ agent_url: string;
416
+ /**
417
+ * Optional `feature_id` the buyer represents the seller should request via `get_creative_features` (e.g., `encypher.markers_present_v2`). SHOULD match the `feature_id` declared on the matching `accepted_verifiers[]` entry, or be omitted to defer the selector to the seller. When the seller's entry pins a `feature_id`, that value wins; when neither side pins, the seller selects from the agent's `governance.creative_features` catalog.
418
+ */
419
+ feature_id?: string;
420
+ };
421
+ /**
422
+ * When the provenance data was embedded (ISO 8601)
423
+ * @format date-time
424
+ */
425
+ embedded_at?: string;
426
+ }[];
427
+ /**
428
+ * Content watermarks applied to this asset. Each entry declares one watermarking layer: a content modification that encodes an identifier or fingerprint within the asset. Watermarks differ from embedded provenance: a watermark encodes an identifier (who generated it, who owns it), while embedded provenance carries or references a structured provenance record (the full chain of custody). A single asset may carry both. Aligns with C2PA action taxonomy: c2pa.watermarked.bound (watermark linked to a C2PA manifest) and c2pa.watermarked.unbound (watermark independent of any manifest). This is a declaration by the watermarking party. The receiving party (the seller) is the verifier-of-record: it confirms the claim by calling a governance agent it trusts (typically one published in `creative_policy.accepted_verifiers`).
429
+ */
430
+ watermarks?: {
431
+ media_type: WatermarkMediaType;
432
+ /**
433
+ * Organization that applied the watermark (e.g., 'Imatag', 'Steg.AI', 'Encypher'). Display label and audit context — not a wire identifier.
434
+ */
435
+ provider: string;
436
+ /**
437
+ * Buyer's representation that this watermark can be detected by a governance agent on the seller's `creative_policy.accepted_verifiers` list. The `agent_url` MUST match (canonicalized) one of the seller's published `accepted_verifiers[].agent_url` entries; sellers reject `sync_creatives` submissions whose `verify_agent.agent_url` is off-list with `PROVENANCE_VERIFIER_NOT_ACCEPTED`. This is buyer-supplied evidence, not buyer-driven routing — the seller is the verifier-of-record and the seller controls which agent it actually calls (the seller MAY use a different on-list agent if it determines this is more appropriate; the seller does not call buyer-asserted endpoints outside its allowlist).
438
+ */
439
+ verify_agent?: {
440
+ /**
441
+ * URL of the governance agent the buyer represents was used to apply/detect this watermark. MUST use the `https://` scheme and MUST appear in the seller's `creative_policy.accepted_verifiers[].agent_url` list (canonicalized per /docs/reference/url-canonicalization: lowercase scheme and host, strip default port, normalize path dot-segments). Sellers MUST NOT call this URL until the canonicalized match is confirmed.
442
+ * @pattern ^https:\/\/
443
+ */
444
+ agent_url: string;
445
+ /**
446
+ * Optional `feature_id` the buyer represents the seller should request via `get_creative_features` (e.g., `imatag.watermark_detected`). SHOULD match the `feature_id` declared on the matching `accepted_verifiers[]` entry, or be omitted to defer the selector to the seller. When the seller's entry pins a `feature_id`, that value wins; when neither side pins, the seller selects from the agent's `governance.creative_features` catalog.
447
+ */
448
+ feature_id?: string;
449
+ };
450
+ c2pa_action?: C2PAWatermarkAction;
451
+ /**
452
+ * When the watermark was applied (ISO 8601)
453
+ * @format date-time
454
+ */
455
+ embedded_at?: string;
456
+ }[];
457
+ /**
458
+ * Regulatory disclosure requirements for this content. Indicates whether AI disclosure is required and under which jurisdictions.
459
+ */
460
+ disclosure?: {
461
+ /**
462
+ * The declaring party's claim that AI disclosure is required for this content under applicable regulations. This is a declared signal carried through the supply chain — useful as a routing and audit input — not a regulatory determination made by the protocol. Receiving parties remain responsible for their own jurisdictional analysis and should not treat `required: false` as compliance cover.
463
+ */
464
+ required: boolean;
465
+ /**
466
+ * Jurisdictions where disclosure obligations apply
467
+ */
468
+ jurisdictions?: {
469
+ /**
470
+ * ISO 3166-1 alpha-2 country code (e.g., 'US', 'DE', 'CN')
471
+ */
472
+ country: string;
473
+ /**
474
+ * Sub-national region code (e.g., 'CA' for California, 'BY' for Bavaria)
475
+ */
476
+ region?: string;
477
+ /**
478
+ * Regulation identifier (e.g., 'eu_ai_act_article_50', 'ca_sb_942', 'cn_deep_synthesis')
479
+ */
480
+ regulation: string;
481
+ /**
482
+ * Required disclosure label text for this jurisdiction, in the local language
483
+ */
484
+ label_text?: string;
485
+ /**
486
+ * How the disclosure should be rendered for this jurisdiction. Expresses the declaring party's intent for persistence and position based on regulatory requirements. Publishers control actual rendering but governance agents can audit whether guidance was followed.
487
+ */
488
+ render_guidance?: {
489
+ persistence?: DisclosurePersistence;
490
+ /**
491
+ * Minimum display duration in milliseconds for initial persistence. Recommended when persistence is initial — without it, the duration is at the publisher's discretion. At serve time the publisher reads this from provenance since the brief is not available.
492
+ * @minimum 1
493
+ */
494
+ min_duration_ms?: number;
495
+ /**
496
+ * Preferred disclosure positions in priority order. The first position a format supports should be used.
497
+ */
498
+ positions?: DisclosurePosition[];
499
+ ext?: ExtensionObject;
500
+ };
501
+ }[];
502
+ };
503
+ /**
504
+ * Third-party verification or detection results for this content. Multiple services may independently evaluate the same content. Provenance is a claim — verification results attached by the declaring party are supplementary. The enforcing party (e.g., seller/publisher) should run its own verification via get_creative_features or calibrate_content.
505
+ */
506
+ verification?: {
507
+ /**
508
+ * Name of the verification service (e.g., 'DoubleVerify', 'Hive Moderation', 'Reality Defender')
509
+ */
510
+ verified_by: string;
511
+ /**
512
+ * When the verification was performed (ISO 8601)
513
+ * @format date-time
514
+ */
515
+ verified_time?: string;
516
+ /**
517
+ * Verification outcome
518
+ */
519
+ result: 'authentic' | 'ai_generated' | 'ai_modified' | 'inconclusive';
520
+ /**
521
+ * Confidence score of the verification result (0.0 to 1.0)
522
+ * @minimum 0
523
+ * @maximum 1
524
+ */
525
+ confidence?: number;
526
+ /**
527
+ * URL to the full verification report
528
+ */
529
+ details_url?: string;
530
+ }[];
531
+ ext?: ExtensionObject;
532
+ }
533
+
534
+ /**
535
+ * Push notification configuration for async task updates (A2A and REST protocols). Echoed from the request to confirm webhook settings. Specifies URL, authentication scheme (Bearer or HMAC-SHA256), and credentials. MCP uses progress notifications instead of webhooks.
536
+ */
537
+ export interface PushNotificationConfig {
538
+ /**
539
+ * Webhook endpoint URL for task status notifications. The wire contract is unconstrained beyond `format: "uri"` — in particular, publishers SHOULD NOT enforce a destination-port allowlist by default, since buyers legitimately host receivers on non-standard TLS ports (`:9443`, `:4443`, path-routed multi-tenant gateways). The SSRF guard the protocol relies on is the IP-range check + DNS-rebinding-resistant connect pin defined in [Webhook URL validation (SSRF)](/docs/building/by-layer/L1/security#webhook-url-validation-ssrf), not port filtering. Operators who want a hardened destination-port allowlist as defense-in-depth (e.g., locked-down enterprise egress) opt in explicitly — see [Destination port: permissive by default](/docs/building/by-layer/L1/security#destination-port-permissive-by-default).
540
+ */
541
+ url: string;
542
+ /**
543
+ * Buyer-supplied correlation identifier for the operation that will produce webhooks against this registration. The seller MUST echo this value verbatim into every webhook payload's `operation_id` field (see [`mcp-webhook-payload.json`](/schemas/core/mcp-webhook-payload.json) and [Webhooks — Operation IDs](/docs/building/by-layer/L3/webhooks#operation-ids-and-url-templates)). Buyers SHOULD generate a unique value per task invocation (UUID recommended). This field is the canonical registration channel for `operation_id`; buyers MAY additionally embed the same value in the URL path or query as a routing aid for their own HTTP server, but the URL is opaque to the seller and the wire-level source of truth is this field. Sellers MUST NOT parse the URL to recover `operation_id`. Sellers that receive a webhook registration without `operation_id` MAY reject the task with `INVALID_REQUEST`.
544
+ * @minLength 1
545
+ * @maxLength 255
546
+ * @pattern ^[A-Za-z0-9_.:-]{1,255}$
547
+ */
548
+ operation_id?: string;
549
+ /**
550
+ * Optional client-provided token for webhook validation. The seller MUST echo this value verbatim in every webhook payload's `token` field (see [`mcp-webhook-payload.json`](/schemas/core/mcp-webhook-payload.json) for the receiver-side validation obligation). Length bounds give receivers a defensive range check on the echoed value; senders SHOULD generate tokens with at least 128 bits of entropy (≥22 base64url characters). This is a complementary authenticity mechanism that can layer on top of the RFC 9421 webhook signature — unlike the `authentication` block below, it is not on the 4.0 removal track. Receivers that registered both a signing key (RFC 9421) and a `token` MUST NOT treat a valid token echo as authorization to skip signature verification; both checks remain independent obligations.
551
+ * @minLength 16
552
+ * @maxLength 4096
553
+ */
554
+ token?: string;
555
+ /**
556
+ * Legacy authentication configuration (A2A-compatible). Opts the seller into Bearer or HMAC-SHA256 signing instead of the default RFC 9421 webhook profile. Deprecated; removed in AdCP 4.0. **Precedence is a switch, not a fallback:** presence of this block selects the legacy scheme; absence selects 9421. A seller MUST NOT sign the same webhook both ways, and a buyer MUST NOT attempt 'try 9421 first, fall back to HMAC' verification — signature mode is determined solely by whether this block was present at registration time. The seller's baseline 9421 webhook-signing key published at its brand.json `agents[]` `jwks_uri` does not override this selector; it is always discoverable but only used when `authentication` is omitted. See docs/building/implementation/security.mdx#webhook-callbacks for the full precedence and downgrade-resistance rules (including the `webhook_mode_mismatch` rejection a buyer MUST apply when a received webhook's signing mode does not match the registered mode).
557
+ */
558
+ authentication?: {
559
+ /**
560
+ * Array of authentication schemes. Supported: ['Bearer'] for simple token auth, ['HMAC-SHA256'] for legacy shared-secret signing. Both are deprecated; new integrations SHOULD omit `authentication` and use the RFC 9421 webhook profile.
561
+ */
562
+ schemes: AuthenticationScheme[];
563
+ /**
564
+ * Credentials for the legacy scheme. For Bearer: token sent in Authorization header. For HMAC-SHA256: shared secret used to generate signature. Minimum 32 characters. Exchanged out-of-band during onboarding.
565
+ * @minLength 32
566
+ */
567
+ credentials: string;
568
+ };
569
+ }
570
+
571
+ /**
572
+ * Current task execution state. Indicates whether the task is completed, in progress (working), submitted for async processing, failed, or requires user input. REQUIRED on every task response envelope. Synchronous tasks (including read-only metadata calls like `get_adcp_capabilities`) MUST emit `status: "completed"`; async tasks emit `submitted`, `working`, `input-required`, etc. per their lifecycle. Agents MUST NOT emit the legacy task_status or response_status fields alongside this field — the status field is the single authoritative task state.
573
+ */
574
+ export type TaskStatus = 'submitted' | 'working' | 'input-required' | 'completed' | 'canceled' | 'failed' | 'rejected' | 'auth-required' | 'unknown';
575
+
576
+ /**
577
+ * Media category of the watermarked content
578
+ */
579
+ export type WatermarkMediaType = 'audio' | 'image' | 'video' | 'text';