@adcp/sdk 8.1.0-beta.6 → 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 (122) hide show
  1. package/README.md +12 -0
  2. package/dist/lib/conformance/oracle.d.ts.map +1 -1
  3. package/dist/lib/conformance/oracle.js +8 -1
  4. package/dist/lib/conformance/oracle.js.map +1 -1
  5. package/dist/lib/conformance/schemaArbitrary.js +135 -9
  6. package/dist/lib/conformance/schemaArbitrary.js.map +1 -1
  7. package/dist/lib/schemas-data/v2.5/_provenance.json +1 -1
  8. package/dist/lib/server/create-adcp-server.d.ts +5 -0
  9. package/dist/lib/server/create-adcp-server.d.ts.map +1 -1
  10. package/dist/lib/server/create-adcp-server.js +41 -3
  11. package/dist/lib/server/create-adcp-server.js.map +1 -1
  12. package/dist/lib/server/decisioning/capabilities.d.ts +8 -0
  13. package/dist/lib/server/decisioning/capabilities.d.ts.map +1 -1
  14. package/dist/lib/server/decisioning/proposal/dispatch.d.ts.map +1 -1
  15. package/dist/lib/server/decisioning/proposal/dispatch.js +2 -0
  16. package/dist/lib/server/decisioning/proposal/dispatch.js.map +1 -1
  17. package/dist/lib/server/decisioning/runtime/from-platform.d.ts.map +1 -1
  18. package/dist/lib/server/decisioning/runtime/from-platform.js +14 -1
  19. package/dist/lib/server/decisioning/runtime/from-platform.js.map +1 -1
  20. package/dist/lib/server/responses.d.ts +1 -1
  21. package/dist/lib/server/responses.d.ts.map +1 -1
  22. package/dist/lib/server/responses.js +5 -2
  23. package/dist/lib/server/responses.js.map +1 -1
  24. package/dist/lib/signing/types.d.ts +6 -0
  25. package/dist/lib/signing/types.d.ts.map +1 -1
  26. package/dist/lib/signing/types.js.map +1 -1
  27. package/dist/lib/signing/verifier.d.ts.map +1 -1
  28. package/dist/lib/signing/verifier.js +33 -4
  29. package/dist/lib/signing/verifier.js.map +1 -1
  30. package/dist/lib/testing/storyboard/compliance.d.ts +1 -0
  31. package/dist/lib/testing/storyboard/compliance.d.ts.map +1 -1
  32. package/dist/lib/testing/storyboard/compliance.js +8 -2
  33. package/dist/lib/testing/storyboard/compliance.js.map +1 -1
  34. package/dist/lib/testing/storyboard/index.d.ts +1 -1
  35. package/dist/lib/testing/storyboard/index.d.ts.map +1 -1
  36. package/dist/lib/testing/storyboard/index.js +3 -2
  37. package/dist/lib/testing/storyboard/index.js.map +1 -1
  38. package/dist/lib/testing/storyboard/probes.d.ts.map +1 -1
  39. package/dist/lib/testing/storyboard/probes.js +3 -0
  40. package/dist/lib/testing/storyboard/probes.js.map +1 -1
  41. package/dist/lib/testing/storyboard/runner.d.ts.map +1 -1
  42. package/dist/lib/testing/storyboard/runner.js +294 -29
  43. package/dist/lib/testing/storyboard/runner.js.map +1 -1
  44. package/dist/lib/testing/storyboard/types.d.ts +59 -0
  45. package/dist/lib/testing/storyboard/types.d.ts.map +1 -1
  46. package/dist/lib/testing/storyboard/types.js.map +1 -1
  47. package/dist/lib/testing/storyboard/validations.d.ts +4 -3
  48. package/dist/lib/testing/storyboard/validations.d.ts.map +1 -1
  49. package/dist/lib/testing/storyboard/validations.js +26 -2
  50. package/dist/lib/testing/storyboard/validations.js.map +1 -1
  51. package/dist/lib/types/activate-signal.d.ts +647 -0
  52. package/dist/lib/types/build-creative.d.ts +2105 -0
  53. package/dist/lib/types/calibrate-content.d.ts +675 -0
  54. package/dist/lib/types/check-governance.d.ts +619 -0
  55. package/dist/lib/types/comply-test-controller.d.ts +8428 -0
  56. package/dist/lib/types/core.generated.d.ts +180 -252
  57. package/dist/lib/types/core.generated.d.ts.map +1 -1
  58. package/dist/lib/types/core.generated.js +1 -1
  59. package/dist/lib/types/create-collection-list.d.ts +693 -0
  60. package/dist/lib/types/create-content-standards.d.ts +830 -0
  61. package/dist/lib/types/create-media-buy.d.ts +3374 -0
  62. package/dist/lib/types/create-property-list.d.ts +836 -0
  63. package/dist/lib/types/delete-collection-list.d.ts +497 -0
  64. package/dist/lib/types/delete-property-list.d.ts +497 -0
  65. package/dist/lib/types/get-account-financials.d.ts +624 -0
  66. package/dist/lib/types/get-adcp-capabilities.d.ts +2863 -0
  67. package/dist/lib/types/get-collection-list.d.ts +763 -0
  68. package/dist/lib/types/get-content-standards.d.ts +919 -0
  69. package/dist/lib/types/get-creative-delivery.d.ts +2219 -0
  70. package/dist/lib/types/get-creative-features.d.ts +1736 -0
  71. package/dist/lib/types/get-media-buy-artifacts.d.ts +864 -0
  72. package/dist/lib/types/get-media-buys.d.ts +1670 -0
  73. package/dist/lib/types/get-plan-audit-logs.d.ts +455 -0
  74. package/dist/lib/types/get-products.d.ts +4935 -0
  75. package/dist/lib/types/get-property-list.d.ts +874 -0
  76. package/dist/lib/types/get-signals.d.ts +986 -0
  77. package/dist/lib/types/list-accounts.d.ts +851 -0
  78. package/dist/lib/types/list-content-standards.d.ts +975 -0
  79. package/dist/lib/types/list-creative-formats.d.ts +3132 -0
  80. package/dist/lib/types/list-creatives.d.ts +2390 -0
  81. package/dist/lib/types/list-property-lists.d.ts +855 -0
  82. package/dist/lib/types/log-event.d.ts +373 -0
  83. package/dist/lib/types/per-tool-index.json +391 -0
  84. package/dist/lib/types/preview-creative.d.ts +1981 -0
  85. package/dist/lib/types/provide-performance-feedback.d.ts +218 -0
  86. package/dist/lib/types/report-plan-outcome.d.ts +433 -0
  87. package/dist/lib/types/report-usage.d.ts +579 -0
  88. package/dist/lib/types/schemas.generated.d.ts +127279 -125067
  89. package/dist/lib/types/schemas.generated.d.ts.map +1 -1
  90. package/dist/lib/types/schemas.generated.js +221 -293
  91. package/dist/lib/types/schemas.generated.js.map +1 -1
  92. package/dist/lib/types/si-get-offering.d.ts +259 -0
  93. package/dist/lib/types/si-initiate-session.d.ts +372 -0
  94. package/dist/lib/types/si-send-message.d.ts +300 -0
  95. package/dist/lib/types/si-terminate-session.d.ts +213 -0
  96. package/dist/lib/types/sync-accounts.d.ts +856 -0
  97. package/dist/lib/types/sync-audiences.d.ts +707 -0
  98. package/dist/lib/types/sync-catalogs.d.ts +766 -0
  99. package/dist/lib/types/sync-creatives.d.ts +2134 -0
  100. package/dist/lib/types/sync-event-sources.d.ts +665 -0
  101. package/dist/lib/types/sync-governance.d.ts +558 -0
  102. package/dist/lib/types/sync-plans.d.ts +979 -0
  103. package/dist/lib/types/update-collection-list.d.ts +697 -0
  104. package/dist/lib/types/update-content-standards.d.ts +847 -0
  105. package/dist/lib/types/update-media-buy.d.ts +3047 -0
  106. package/dist/lib/types/update-property-list.d.ts +840 -0
  107. package/dist/lib/types/validate-content-delivery.d.ts +722 -0
  108. package/dist/lib/types/validate-input.d.ts +1683 -0
  109. package/dist/lib/utils/response-schemas.js +1 -1
  110. package/dist/lib/utils/response-schemas.js.map +1 -1
  111. package/dist/lib/utils/response-unwrapper.d.ts.map +1 -1
  112. package/dist/lib/utils/response-unwrapper.js +18 -3
  113. package/dist/lib/utils/response-unwrapper.js.map +1 -1
  114. package/dist/lib/version.d.ts +3 -3
  115. package/dist/lib/version.js +3 -3
  116. package/examples/error-compliant-server.ts +1 -1
  117. package/examples/hello_seller_adapter_guaranteed.ts +8 -3
  118. package/examples/hello_seller_adapter_multi_tenant.ts +27 -23
  119. package/examples/hello_seller_adapter_non_guaranteed.ts +7 -3
  120. package/examples/hello_seller_adapter_proposal_mode.ts +22 -6
  121. package/examples/hello_signals_adapter_marketplace.ts +34 -3
  122. package/package.json +9 -2
@@ -0,0 +1,2134 @@
1
+ // AUTO-GENERATED — DO NOT EDIT.
2
+ // Per-tool .d.ts slice for `sync_creatives`. 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
+ * Request parameters for syncing creative assets with upsert semantics - supports bulk operations, scoped updates, and assignment management
13
+ */
14
+ export interface SyncCreativesRequest {
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
+ account: AccountReference;
24
+ /**
25
+ * Array of creative assets to sync (create or update)
26
+ */
27
+ creatives: CreativeAsset[];
28
+ /**
29
+ * Optional filter to limit sync scope to specific creative IDs. When provided, only these creatives will be created/updated. Other creatives in the library are unaffected. Useful for partial updates and error recovery.
30
+ */
31
+ creative_ids?: string[];
32
+ /**
33
+ * Optional bulk assignment of creatives to packages. Each entry maps one creative to one package with optional weight and placement targeting. Standalone creative agents that do not manage media buys ignore this field.
34
+ */
35
+ assignments?: {
36
+ /**
37
+ * ID of the creative to assign
38
+ */
39
+ creative_id: string;
40
+ /**
41
+ * ID of the package to assign the creative to
42
+ */
43
+ package_id: string;
44
+ /**
45
+ * Relative delivery weight (0-100). When multiple creatives are assigned to the same package, weights determine impression distribution proportionally. When omitted, the creative receives equal rotation with other unweighted creatives. A weight of 0 means the creative is assigned but paused (receives no delivery).
46
+ * @minimum 0
47
+ * @maximum 100
48
+ */
49
+ weight?: number;
50
+ /**
51
+ * Restrict this creative to specific placements within the package. When omitted, the creative is eligible for all placements.
52
+ */
53
+ placement_ids?: string[];
54
+ }[];
55
+ /**
56
+ * Client-generated idempotency key for safe retries. If a sync fails without a response, resending with the same idempotency_key guarantees at-most-once execution. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.
57
+ * @minLength 16
58
+ * @maxLength 255
59
+ * @pattern ^[A-Za-z0-9_.:-]{16,255}$
60
+ */
61
+ idempotency_key: string;
62
+ /**
63
+ * When true, creatives not included in this sync will be archived. Use with caution for full library replacement. Invalid when creative_ids is provided — delete_missing applies to the entire library scope, not a filtered subset.
64
+ */
65
+ delete_missing?: boolean;
66
+ /**
67
+ * When true, preview changes without applying them. Returns what would be created/updated/deleted.
68
+ */
69
+ dry_run?: boolean;
70
+ validation_mode?: ValidationMode;
71
+ push_notification_config?: PushNotificationConfig;
72
+ context?: ContextObject;
73
+ ext?: ExtensionObject;
74
+ }
75
+
76
+ /**
77
+ * Response from creative sync operation. Exactly one of three shapes: (1) synchronous success — per-creative results in the creatives array (best-effort processing with per-item status/failures); (2) terminal failure — errors array with no creatives processed; (3) submitted task envelope — status 'submitted' with task_id when the whole operation is queued (batch ingestion, async review that must settle before per-item results can be issued). The submitted branch MAY carry advisory errors for non-blocking warnings; terminal failures belong in the error branch. Final per-item results land on the task completion artifact, not this envelope. These three shapes are mutually exclusive — a response has exactly one.
78
+ */
79
+ export type SyncCreativesResponse = {
80
+ /**
81
+ * 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).
82
+ */
83
+ context_id?: string;
84
+ context?: ContextObject;
85
+ /**
86
+ * Unique identifier for tracking asynchronous operations. Present when a task requires extended processing time. Used to query task status and retrieve results when complete.
87
+ */
88
+ task_id?: string;
89
+ status: TaskStatus;
90
+ /**
91
+ * 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.
92
+ */
93
+ message?: string;
94
+ /**
95
+ * ISO 8601 timestamp when the response was generated. Useful for debugging, logging, cache validation, and tracking async operation progress.
96
+ */
97
+ timestamp?: string;
98
+ /**
99
+ * 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.
100
+ */
101
+ replayed?: boolean;
102
+ adcp_error?: Error;
103
+ push_notification_config?: PushNotificationConfig;
104
+ /**
105
+ * 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.
106
+ *
107
+ * 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.
108
+ *
109
+ * This is the primary correlation key for audit and reporting across the governance lifecycle.
110
+ */
111
+ governance_context?: string;
112
+ /**
113
+ * 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.
114
+ */
115
+ payload?: {};
116
+ /**
117
+ * 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.
118
+ */
119
+ adcp_version?: string;
120
+ /**
121
+ * 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.
122
+ */
123
+ adcp_major_version?: number;
124
+ } & (SyncCreativesSuccess | SyncCreativesError | SyncCreativesSubmitted);
125
+
126
+ /**
127
+ * Success response - sync operation processed creatives (may include per-item failures)
128
+ */
129
+ export interface SyncCreativesSuccess {
130
+ /**
131
+ * Whether this was a dry run (no actual changes made)
132
+ */
133
+ dry_run?: boolean;
134
+ /**
135
+ * Results for each creative processed. Items with action='failed' indicate per-item validation/processing failures, not operation-level failures.
136
+ */
137
+ creatives: {
138
+ /**
139
+ * Creative ID from the request
140
+ */
141
+ creative_id: string;
142
+ account?: Account;
143
+ action: CreativeAction;
144
+ status?: CreativeStatus;
145
+ /**
146
+ * Platform-specific ID assigned to the creative
147
+ */
148
+ platform_id?: string;
149
+ /**
150
+ * Field names that were modified (only present when action='updated')
151
+ */
152
+ changes?: string[];
153
+ /**
154
+ * Validation or processing errors (only present when action='failed')
155
+ */
156
+ errors?: Error[];
157
+ /**
158
+ * Non-fatal warnings about this creative
159
+ */
160
+ warnings?: string[];
161
+ /**
162
+ * Preview URL for generative creatives (only present for generative formats)
163
+ */
164
+ preview_url?: string;
165
+ /**
166
+ * ISO 8601 timestamp when preview link expires (only present when preview_url exists)
167
+ * @format date-time
168
+ */
169
+ expires_at?: string;
170
+ /**
171
+ * Package IDs this creative was successfully assigned to (only present when assignments were requested)
172
+ */
173
+ assigned_to?: string[];
174
+ /**
175
+ * Assignment errors by package ID (only present when assignment failures occurred)
176
+ */
177
+ assignment_errors?: {
178
+ /**
179
+ * Error message for this package assignment
180
+ *
181
+ * This interface was referenced by `undefined`'s JSON-Schema definition
182
+ * via the `patternProperty` "^[a-zA-Z0-9_-]+$".
183
+ */
184
+ [k: string]: string | undefined;
185
+ };
186
+ }[];
187
+ /**
188
+ * When true, this response contains simulated data from sandbox mode.
189
+ */
190
+ sandbox?: boolean;
191
+ context?: ContextObject;
192
+ ext?: ExtensionObject;
193
+ }
194
+
195
+ /**
196
+ * Error response - operation failed completely, no creatives were processed
197
+ */
198
+ export interface SyncCreativesError {
199
+ /**
200
+ * Operation-level errors that prevented processing any creatives (e.g., authentication failure, service unavailable, invalid request format)
201
+ */
202
+ errors: Error[];
203
+ context?: ContextObject;
204
+ ext?: ExtensionObject;
205
+ }
206
+
207
+ /**
208
+ * Async task envelope returned when the whole sync operation cannot be confirmed before the response is emitted — for example, when the seller batches ingestion, when async review must settle before per-item results can be issued, or when governance review gates the sync. The buyer polls tasks/get with task_id or receives a webhook when the task completes; the creatives array with per-item action/status lands on the completion artifact, not this envelope. Per-item async review (an item in pending_review while the rest of the sync resolves synchronously) belongs on the SyncCreativesSuccess branch with status: pending_review, not here.
209
+ */
210
+ export interface SyncCreativesSubmitted {
211
+ /**
212
+ * Task-level status literal. Discriminates this async envelope from the synchronous success shape, whose creatives array carries per-item approval state via CreativeStatus. See task-status.json for the full task-status enum.
213
+ */
214
+ status: 'submitted';
215
+ /**
216
+ * Task handle the buyer uses with tasks/get, and that the seller references on push-notification callbacks. The creatives array is issued on the completion artifact, not here. Per AdCP wire conventions this is snake_case; A2A adapters MAY surface it as taskId, but the payload field emitted by the agent is task_id.
217
+ */
218
+ task_id: string;
219
+ /**
220
+ * Optional human-readable explanation of why the task is submitted — e.g., 'Batch ingestion queued; typical turnaround 15-30 minutes.' Plain text only. Buyers MUST treat this as untrusted seller input: escape before rendering to HTML UIs, and sanitize or isolate before passing to an LLM prompt context — a hostile seller may inject prompt-injection payloads aimed at the buyer's agent.
221
+ * @maxLength 2000
222
+ */
223
+ message?: string;
224
+ /**
225
+ * Optional advisory errors accompanying the submitted envelope. Use only for non-blocking warnings (e.g., throttled_severity advisories, governance observations). Terminal failures belong in the error branch, not here.
226
+ */
227
+ errors?: Error[];
228
+ context?: ContextObject;
229
+ ext?: ExtensionObject;
230
+ }
231
+
232
+ /**
233
+ * Account billed for this media buy. Includes advertiser, billing proxy (if any), and rate card applied.
234
+ */
235
+ export interface Account {
236
+ /**
237
+ * Unique identifier for this account
238
+ */
239
+ account_id: string;
240
+ /**
241
+ * Human-readable account name (e.g., 'Acme', 'Acme c/o Pinnacle')
242
+ */
243
+ name: string;
244
+ /**
245
+ * The advertiser whose rates apply to this account
246
+ */
247
+ advertiser?: string;
248
+ /**
249
+ * Optional intermediary who receives invoices on behalf of the advertiser (e.g., agency)
250
+ */
251
+ billing_proxy?: string;
252
+ status: AccountStatus;
253
+ brand?: BrandReference;
254
+ /**
255
+ * Domain of the entity operating this account. When the brand operates directly, this is the brand's domain.
256
+ * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
257
+ */
258
+ operator?: string;
259
+ billing?: BillingParty;
260
+ billing_entity?: BusinessEntity;
261
+ /**
262
+ * Identifier for the rate card applied to this account
263
+ */
264
+ rate_card?: string;
265
+ payment_terms?: PaymentTerms;
266
+ /**
267
+ * Maximum outstanding balance allowed
268
+ */
269
+ credit_limit?: {
270
+ /**
271
+ * @minimum 0
272
+ */
273
+ amount: number;
274
+ /**
275
+ * @pattern ^[A-Z]{3}$
276
+ */
277
+ currency: string;
278
+ };
279
+ /**
280
+ * Present when status is 'pending_approval'. Contains next steps for completing account activation.
281
+ */
282
+ setup?: {
283
+ /**
284
+ * URL where the human can complete the required action (credit application, legal agreement, add funds).
285
+ */
286
+ url?: string;
287
+ /**
288
+ * Human-readable description of what's needed.
289
+ */
290
+ message: string;
291
+ /**
292
+ * When this setup link expires.
293
+ * @format date-time
294
+ */
295
+ expires_at?: string;
296
+ };
297
+ account_scope?: AccountScope;
298
+ /**
299
+ * Governance agent endpoint registered on this account. Exactly one entry per sync_governance's one-agent-per-account invariant. The array shape is preserved for wire compatibility with 3.0; `maxItems: 1` is load-bearing and mirrors the singular `governance_context` on the protocol envelope. Authentication credentials are write-only and not included in responses — use sync_governance to set or update credentials.
300
+ */
301
+ governance_agents?: {
302
+ /**
303
+ * Governance agent endpoint URL. Must use HTTPS.
304
+ * @pattern ^https:\/\/
305
+ */
306
+ url: string;
307
+ }[];
308
+ /**
309
+ * Cloud storage bucket where the seller delivers offline reporting files for this account. Seller provisions a dedicated bucket or a per-account prefix within a shared bucket, and grants the buyer read access out-of-band. Access MUST be scoped at the IAM layer so each account can only read its own prefix — bucket-wide grants are non-compliant even with per-account prefixes. Seller MUST revoke access when the account's status transitions to inactive, suspended, or closed. See security considerations for offline delivery in docs/media-buy/media-buys/optimization-reporting. Only present when the seller supports offline delivery (reporting_delivery_methods includes 'offline' in capabilities).
310
+ */
311
+ reporting_bucket?: {
312
+ protocol: CloudStorageProtocol;
313
+ /**
314
+ * Bucket or container name
315
+ * @minLength 3
316
+ * @maxLength 63
317
+ * @pattern ^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$
318
+ */
319
+ bucket: string;
320
+ /**
321
+ * Path prefix within the bucket. Seller appends date-based partitioning beneath this prefix.
322
+ * @maxLength 512
323
+ * @pattern ^[a-zA-Z0-9\/_.-]+$
324
+ */
325
+ prefix?: string;
326
+ /**
327
+ * Cloud region for the bucket
328
+ * @maxLength 64
329
+ * @pattern ^[a-z0-9-]+$
330
+ */
331
+ region?: string;
332
+ /**
333
+ * File format for delivered files. Parquet, Avro, and ORC use internal compression (the top-level compression field is ignored for these formats).
334
+ */
335
+ format?: 'jsonl' | 'csv' | 'parquet' | 'avro' | 'orc';
336
+ /**
337
+ * Compression applied to delivered files
338
+ */
339
+ compression?: 'gzip' | 'none';
340
+ /**
341
+ * How long reporting files are retained in the bucket before deletion. Buyers must read files within this window. Minimum recommended: 14 days.
342
+ * @minimum 1
343
+ */
344
+ file_retention_days: number;
345
+ /**
346
+ * URL to documentation for configuring buyer read access to this bucket (IAM role, service account, etc.). Operator-facing documentation — buyer agents MUST NOT auto-fetch this URL; surface it to a human operator. If an implementation fetches it (for preview), apply webhook URL SSRF validation and do not pass the fetched content into an LLM context without indirect-prompt-injection guarding. See docs/media-buy/media-buys/optimization-reporting#security-considerations-for-offline-delivery.
347
+ * @pattern ^https:\/\/
348
+ */
349
+ setup_instructions?: string;
350
+ };
351
+ /**
352
+ * When true, this is a sandbox account — no real platform calls, no real spend. For explicit accounts (require_operator_auth: true), sandbox accounts are pre-existing test accounts on the platform discovered via list_accounts. For implicit accounts, sandbox is part of the natural key: the same brand/operator pair can have both a production and sandbox account.
353
+ */
354
+ sandbox?: boolean;
355
+ /**
356
+ * Account-level webhook subscriptions for notifications whose lifecycle outlives any single media buy (e.g., `creative.status_changed`, `creative.purged`, wholesale feed change payloads). Distinct from `push_notification_config` on individual operations, which anchors at a per-resource scope. Buyers register and update entries via `sync_accounts`; sellers echo the applied state here on `list_accounts` reads so buyers can verify what's active. `authentication.credentials` is write-only — sellers MUST NOT echo legacy auth credentials in this response. When two or more entries register the same `event_types`, each receives an independent fire — see #3009 multi-subscriber composition.
357
+ */
358
+ notification_configs?: NotificationConfig[];
359
+ ext?: ExtensionObject;
360
+ }
361
+
362
+ /**
363
+ * Account for product lookup. Returns products with pricing specific to this account's rate card.
364
+ */
365
+ export type AccountReference = {
366
+ /**
367
+ * Seller-assigned account identifier (from sync_accounts or list_accounts)
368
+ */
369
+ account_id: string;
370
+ } | {
371
+ brand: BrandReference;
372
+ /**
373
+ * Domain of the entity operating on the brand's behalf. When the brand operates directly, this is the brand's domain.
374
+ * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
375
+ */
376
+ operator: string;
377
+ /**
378
+ * When true, references the sandbox account for this brand/operator pair. Defaults to false (production account).
379
+ */
380
+ sandbox?: boolean;
381
+ };
382
+
383
+ /**
384
+ * How the seller scoped a billing account relative to the operator and brand dimensions.
385
+ */
386
+ export type AccountScope = 'operator' | 'brand' | 'operator_brand' | 'agent';
387
+
388
+ /**
389
+ * Account lifecycle status. See the Accounts Protocol overview for the operations matrix showing which tasks are permitted in each state.
390
+ */
391
+ export type AccountStatus = 'active' | 'pending_approval' | 'rejected' | 'payment_required' | 'suspended' | 'closed';
392
+
393
+ /**
394
+ * Canonical union of all asset variant schemas. Referenced from creative-asset.json and creative-manifest.json to ensure a single named type is emitted by schema-to-TypeScript tooling. Add new asset types here and to the creative/asset-types registry.
395
+ */
396
+ export type AssetVariant = ImageAsset | VideoAsset | AudioAsset | VASTAsset | TextAsset | URLAsset | HTMLAsset | JavaScriptAsset | ZipAsset | WebhookAsset | CSSAsset | DAASTAsset | MarkdownAsset | BriefAsset | CatalogAsset | CardAsset;
397
+
398
+ /**
399
+ * Audio asset with URL and technical specifications
400
+ */
401
+ export interface AudioAsset {
402
+ /**
403
+ * Discriminator identifying this as an audio asset. See /schemas/creative/asset-types for the registry.
404
+ */
405
+ asset_type: 'audio';
406
+ /**
407
+ * URL to the audio asset
408
+ */
409
+ url: string;
410
+ /**
411
+ * Audio duration in milliseconds
412
+ * @minimum 0
413
+ */
414
+ duration_ms?: number;
415
+ /**
416
+ * File size in bytes
417
+ * @minimum 1
418
+ */
419
+ file_size_bytes?: number;
420
+ /**
421
+ * Audio container/file format (mp3, m4a, aac, wav, ogg, flac, etc.)
422
+ */
423
+ container_format?: string;
424
+ /**
425
+ * Audio codec used (aac, aac_lc, he_aac, pcm, mp3, vorbis, opus, flac, ac3, eac3, etc.)
426
+ */
427
+ codec?: string;
428
+ /**
429
+ * Sampling rate in Hz (e.g., 44100, 48000, 96000)
430
+ */
431
+ sampling_rate_hz?: number;
432
+ channels?: AudioChannelLayout;
433
+ /**
434
+ * Bit depth
435
+ */
436
+ bit_depth?: 16 | 24 | 32;
437
+ /**
438
+ * Bitrate in kilobits per second
439
+ * @minimum 1
440
+ */
441
+ bitrate_kbps?: number;
442
+ /**
443
+ * Integrated loudness in LUFS
444
+ */
445
+ loudness_lufs?: number;
446
+ /**
447
+ * True peak level in dBFS
448
+ */
449
+ true_peak_dbfs?: number;
450
+ /**
451
+ * URL to text transcript of the audio content
452
+ */
453
+ transcript_url?: string;
454
+ provenance?: Provenance;
455
+ }
456
+
457
+ /**
458
+ * Audio channel configuration
459
+ */
460
+ export type AudioChannelLayout = 'mono' | 'stereo' | '5.1' | '7.1';
461
+
462
+ /**
463
+ * 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.
464
+ */
465
+ export type AuthenticationScheme = 'Bearer' | 'HMAC-SHA256';
466
+
467
+ /**
468
+ * Who is invoiced on this account. See billing_entity for the invoiced party's business details.
469
+ */
470
+ export type BillingParty = 'operator' | 'agent' | 'advertiser';
471
+
472
+ /**
473
+ * Brand identifier within the house portfolio. Optional for single-brand domains.
474
+ */
475
+ export type BrandID = string;
476
+
477
+ /**
478
+ * Brand reference for product discovery context. Resolved to full brand identity at execution time.
479
+ */
480
+ export interface BrandReference {
481
+ /**
482
+ * Domain where /.well-known/brand.json is hosted, or the brand's operating domain
483
+ * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
484
+ */
485
+ domain: string;
486
+ brand_id?: BrandID;
487
+ /**
488
+ * 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.
489
+ */
490
+ industries?: string[];
491
+ /**
492
+ * 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.
493
+ */
494
+ data_subject_contestation?: {
495
+ [k: string]: unknown | undefined;
496
+ };
497
+ /**
498
+ * 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.
499
+ *
500
+ * **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.
501
+ */
502
+ brand_kit_override?: {
503
+ logo?: ImageAsset;
504
+ /**
505
+ * Override brand colors (hex strings).
506
+ */
507
+ colors?: {
508
+ /**
509
+ * @pattern ^#[0-9a-fA-F]{6}$
510
+ */
511
+ primary?: string;
512
+ /**
513
+ * @pattern ^#[0-9a-fA-F]{6}$
514
+ */
515
+ secondary?: string;
516
+ /**
517
+ * @pattern ^#[0-9a-fA-F]{6}$
518
+ */
519
+ accent?: string;
520
+ };
521
+ /**
522
+ * Override brand-voice description for surface-composed text/audio output.
523
+ */
524
+ voice?: string;
525
+ /**
526
+ * Override tagline.
527
+ */
528
+ tagline?: string;
529
+ };
530
+ }
531
+
532
+ /**
533
+ * Campaign-level creative context as an asset. Carries the creative brief through the manifest so it travels with the creative through regeneration, resizing, and auditing.
534
+ */
535
+ export interface BriefAsset {
536
+ /**
537
+ * Campaign or flight name for identification
538
+ */
539
+ name: string;
540
+ /**
541
+ * Campaign objective that guides creative tone and call-to-action strategy
542
+ */
543
+ objective?: 'awareness' | 'consideration' | 'conversion' | 'retention' | 'engagement';
544
+ /**
545
+ * Desired tone for this campaign, modulating the brand's base tone (e.g., 'playful and festive', 'premium and aspirational')
546
+ */
547
+ tone?: string;
548
+ /**
549
+ * Target audience description for this campaign
550
+ */
551
+ audience?: string;
552
+ /**
553
+ * Creative territory or positioning the campaign should occupy
554
+ */
555
+ territory?: string;
556
+ /**
557
+ * Messaging framework for the campaign
558
+ */
559
+ messaging?: {
560
+ /**
561
+ * Primary headline
562
+ */
563
+ headline?: string;
564
+ /**
565
+ * Supporting tagline or sub-headline
566
+ */
567
+ tagline?: string;
568
+ /**
569
+ * Call-to-action text
570
+ */
571
+ cta?: string;
572
+ /**
573
+ * Key messages to communicate in priority order
574
+ */
575
+ key_messages?: string[];
576
+ };
577
+ /**
578
+ * Visual and strategic reference materials such as mood boards, product shots, example creatives, and strategy documents
579
+ */
580
+ reference_assets?: ReferenceAsset[];
581
+ /**
582
+ * Regulatory and legal compliance requirements for this campaign. Campaign-specific, regional, and product-based — distinct from brand-level disclaimers in brand.json.
583
+ */
584
+ compliance?: {
585
+ /**
586
+ * Disclosures that must appear in creatives for this campaign. Each disclosure specifies the text, where it should appear, and which jurisdictions require it.
587
+ */
588
+ required_disclosures?: {
589
+ /**
590
+ * The disclosure text that must appear in the creative
591
+ */
592
+ text: string;
593
+ position?: DisclosurePosition;
594
+ /**
595
+ * Jurisdictions where this disclosure is required. ISO 3166-1 alpha-2 country codes or ISO 3166-2 subdivision codes (e.g., 'US', 'GB', 'US-NJ', 'CA-QC'). If omitted, the disclosure applies to all jurisdictions in the campaign.
596
+ */
597
+ jurisdictions?: string[];
598
+ /**
599
+ * The regulation or legal authority requiring this disclosure (e.g., 'SEC Rule 156', 'FCA COBS 4.5', 'FDA 21 CFR 202')
600
+ */
601
+ regulation?: string;
602
+ /**
603
+ * Minimum display duration in milliseconds. For video/audio disclosures, how long the disclosure must be visible or audible. For static formats, how long the disclosure must remain on screen before any auto-advance.
604
+ */
605
+ min_duration_ms?: number;
606
+ /**
607
+ * Language of the disclosure text as a BCP 47 language tag (e.g., 'en', 'fr-CA', 'es'). When omitted, the disclosure is assumed to match the creative's language.
608
+ */
609
+ language?: string;
610
+ persistence?: DisclosurePersistence;
611
+ }[];
612
+ /**
613
+ * Claims that must not appear in creatives for this campaign. Creative agents should ensure generated content avoids these claims.
614
+ */
615
+ prohibited_claims?: string[];
616
+ };
617
+ /**
618
+ * Discriminator identifying this as a brief asset. See /schemas/creative/asset-types for the registry.
619
+ */
620
+ asset_type: 'brief';
621
+ }
622
+
623
+ /**
624
+ * Override the account's default billing entity for this specific buy. When provided, the seller invoices this entity instead. The seller MUST validate the invoice recipient is authorized for this account. When governance_agents are configured, the seller MUST include invoice_recipient in the check_governance request.
625
+ */
626
+ export interface BusinessEntity {
627
+ /**
628
+ * Registered legal name of the business entity
629
+ * @maxLength 200
630
+ */
631
+ legal_name: string;
632
+ /**
633
+ * VAT identification number (e.g., DE123456789 for Germany, FR12345678901 for France). Required for B2B invoicing in the EU. Must be normalized: no spaces, dots, or dashes.
634
+ * @pattern ^[A-Z]{2}[A-Z0-9]{2,13}$
635
+ */
636
+ vat_id?: string;
637
+ /**
638
+ * Tax identification number for jurisdictions that do not use VAT (e.g., US EIN)
639
+ * @maxLength 30
640
+ */
641
+ tax_id?: string;
642
+ /**
643
+ * Company registration number (e.g., HRB 12345 for German Handelsregister)
644
+ * @maxLength 50
645
+ */
646
+ registration_number?: string;
647
+ /**
648
+ * Postal address for invoicing and legal correspondence
649
+ */
650
+ address?: {
651
+ /**
652
+ * Street address including building number
653
+ * @maxLength 200
654
+ */
655
+ street: string;
656
+ /**
657
+ * @maxLength 100
658
+ */
659
+ city: string;
660
+ /**
661
+ * @maxLength 20
662
+ */
663
+ postal_code: string;
664
+ /**
665
+ * State, province, or region
666
+ * @maxLength 100
667
+ */
668
+ region?: string;
669
+ /**
670
+ * ISO 3166-1 alpha-2 country code
671
+ * @pattern ^[A-Z]{2}$
672
+ */
673
+ country: string;
674
+ };
675
+ /**
676
+ * Contacts for billing, legal, and operational matters. Contains personal data subject to GDPR and equivalent regulations. Implementations MUST use this data only for invoicing and account management.
677
+ */
678
+ contacts?: {
679
+ /**
680
+ * Contact's functional role in the business relationship
681
+ */
682
+ role: 'billing' | 'legal' | 'creative' | 'general';
683
+ /**
684
+ * Full name of the contact
685
+ * @maxLength 200
686
+ */
687
+ name?: string;
688
+ /**
689
+ * @maxLength 254
690
+ * @format email
691
+ */
692
+ email?: string;
693
+ /**
694
+ * @maxLength 30
695
+ */
696
+ phone?: string;
697
+ }[];
698
+ /**
699
+ * Bank account details for payment processing. Write-only: included in requests to provide payment coordinates, but MUST NOT be echoed in responses. Sellers store these details and confirm receipt without returning them.
700
+ */
701
+ bank?: {
702
+ /**
703
+ * Name on the bank account
704
+ * @maxLength 200
705
+ */
706
+ account_holder: string;
707
+ /**
708
+ * International Bank Account Number (SEPA markets)
709
+ * @pattern ^[A-Z]{2}[0-9]{2}[A-Z0-9]{4,30}$
710
+ */
711
+ iban?: string;
712
+ /**
713
+ * Bank Identifier Code / SWIFT code (SEPA markets)
714
+ * @pattern ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$
715
+ */
716
+ bic?: string;
717
+ /**
718
+ * Bank routing number for non-SEPA markets (e.g., US ABA routing number, Canadian transit/institution number)
719
+ * @maxLength 30
720
+ */
721
+ routing_number?: string;
722
+ /**
723
+ * Bank account number for non-SEPA markets
724
+ * @maxLength 30
725
+ */
726
+ account_number?: string;
727
+ };
728
+ ext?: ExtensionObject;
729
+ }
730
+
731
+ /**
732
+ * C2PA action classification for this watermark
733
+ */
734
+ export type C2PAWatermarkAction = 'c2pa.watermarked.bound' | 'c2pa.watermarked.unbound';
735
+
736
+ /**
737
+ * CSS stylesheet asset
738
+ */
739
+ export interface CSSAsset {
740
+ /**
741
+ * Discriminator identifying this as a CSS asset. See /schemas/creative/asset-types for the registry.
742
+ */
743
+ asset_type: 'css';
744
+ /**
745
+ * CSS content
746
+ */
747
+ content: string;
748
+ /**
749
+ * CSS media query context (e.g., 'screen', 'print')
750
+ */
751
+ media?: string;
752
+ provenance?: Provenance;
753
+ }
754
+
755
+ /**
756
+ * The v2 canonical-format-kind this v1 format projects to (`image`, `html5`, `display_tag`, `image_carousel`, `video_hosted`, `video_vast`, `audio_hosted`, `audio_daast`, `sponsored_placement`, `responsive_creative`, `agent_placement`, or `custom`).
757
+ */
758
+ export type CanonicalFormatKind = 'image' | 'html5' | 'display_tag' | 'image_carousel' | 'video_hosted' | 'video_vast' | 'audio_hosted' | 'audio_daast' | 'sponsored_placement' | 'native_in_feed' | 'responsive_creative' | 'agent_placement' | 'custom';
759
+
760
+ /**
761
+ * A single card in a multi-card creative (image_carousel, future composed carousels). Carries: `media` (an image OR video asset), optional `headline` (short text), optional `description` (longer text), optional `cta` (call-to-action label), optional `landing_page_url` (url asset with `url_type: "clickthrough"`).
762
+ *
763
+ * Covers the multi-card patterns across Meta carousel, Pinterest sponsored pin, Snap Collection, TikTok carousel, and AI-surface result cards. The two-field text shape (`headline` + `description`) reflects how almost every adopter splits short labels from longer copy; Pinterest pin description and Meta per-card description both go in `description`.
764
+ *
765
+ * Used as the array element type for the `cards` slot on image_carousel canonicals. Adopters MUST NOT invent per-card key conventions like `card_0_headline` / `cards.0.headline` — the manifest's `assets.cards` value is an array of card-asset objects, period. Per-card platform extensions (e.g., Meta-specific carousel attributes, Pinterest rich-pin metadata, Snap Collection price tags) attach via the `platform_extensions` field, never via inline non-canonical keys.
766
+ */
767
+ export interface CardAsset {
768
+ /**
769
+ * Discriminator identifying this as a card asset. See /schemas/creative/asset-types for the registry.
770
+ */
771
+ asset_type: 'card';
772
+ /**
773
+ * The card's primary visual asset. Either an `image` or `video` asset, matching the parent format's `allowed_card_media_asset_types` parameter.
774
+ */
775
+ media: ImageAsset | VideoAsset;
776
+ /**
777
+ * Optional per-card short text label (typically 25-40 chars). Length governed by `card_headline_max_chars` on the format declaration. Meta carousel headline, Pinterest pin title, Snap Collection sticker text, TikTok caption-short.
778
+ */
779
+ headline?: string;
780
+ /**
781
+ * Optional per-card longer text (typically 100-500 chars). Distinct from `headline`: `description` is body copy, `headline` is the label. Length governed by `card_description_max_chars` on the format declaration. Meta carousel description, Pinterest pin description, AI-surface result body text, TikTok long caption.
782
+ */
783
+ description?: string;
784
+ /**
785
+ * Optional per-card call-to-action label (e.g., 'SHOP_NOW', 'LEARN_MORE'). When the parent format declares `cta_values` (allowed CTA labels), the per-card `cta` MUST be one of those values. Lets a Meta or TikTok carousel show different CTAs per card.
786
+ */
787
+ cta?: string;
788
+ landing_page_url?: URLAsset;
789
+ /**
790
+ * Per-card platform-specific extensions (URI+digest references). Same hosting model as format-level platform_extensions. Use this for Meta carousel-card attributes, Pinterest pin overrides, etc. — NEVER inline non-canonical keys on the card object directly.
791
+ */
792
+ platform_extensions?: PlatformExtensionReference[];
793
+ provenance?: Provenance;
794
+ }
795
+
796
+ /**
797
+ * A typed data feed as a creative asset. Carries catalog context (products, stores, jobs, etc.) within the manifest's assets map.
798
+ */
799
+ export interface CatalogAsset {
800
+ /**
801
+ * Buyer's identifier for this catalog. Required when syncing via sync_catalogs. When used in creatives, references a previously synced catalog on the account.
802
+ */
803
+ catalog_id?: string;
804
+ /**
805
+ * Human-readable name for this catalog (e.g., 'Summer Products 2025', 'Amsterdam Store Locations').
806
+ */
807
+ name?: string;
808
+ type: CatalogType;
809
+ /**
810
+ * URL to an external catalog feed. The platform fetches and resolves items from this URL. For offering-type catalogs, the feed contains an array of Offering objects. For other types, the feed format is determined by feed_format. When omitted with type 'product', the platform uses its synced copy of the brand's product catalog.
811
+ */
812
+ url?: string;
813
+ feed_format?: FeedFormat;
814
+ update_frequency?: UpdateFrequency;
815
+ /**
816
+ * Inline catalog data. The item schema depends on the catalog type: Offering objects for 'offering', StoreItem for 'store', HotelItem for 'hotel', FlightItem for 'flight', JobItem for 'job', VehicleItem for 'vehicle', RealEstateItem for 'real_estate', EducationItem for 'education', DestinationItem for 'destination', AppItem for 'app', or freeform objects for 'product', 'inventory', and 'promotion'. Mutually exclusive with url — provide one or the other, not both. Implementations should validate items against the type-specific schema.
817
+ */
818
+ items?: {}[];
819
+ /**
820
+ * Filter catalog to specific item IDs. For offering-type catalogs, these are offering_id values. For product-type catalogs, these are SKU identifiers.
821
+ */
822
+ ids?: string[];
823
+ /**
824
+ * Filter product-type catalogs by GTIN identifiers for cross-retailer catalog matching. Accepts standard GTIN formats (GTIN-8, UPC-A/GTIN-12, EAN-13/GTIN-13, GTIN-14). Only applicable when type is 'product'.
825
+ */
826
+ gtins?: string[];
827
+ /**
828
+ * Filter catalog to items with these tags. Tags are matched using OR logic — items matching any tag are included.
829
+ */
830
+ tags?: string[];
831
+ /**
832
+ * Filter catalog to items in this category (e.g., 'beverages/soft-drinks', 'chef-positions').
833
+ */
834
+ category?: string;
835
+ /**
836
+ * Natural language filter for catalog items (e.g., 'all pasta sauces under $5', 'amsterdam vacancies').
837
+ */
838
+ query?: string;
839
+ /**
840
+ * Event types that represent conversions for items in this catalog. Declares what events the platform should attribute to catalog items — e.g., a job catalog converts via submit_application, a product catalog via purchase. The event's content_ids field carries the item IDs that connect back to catalog items. Use content_id_type to declare what identifier type content_ids values represent.
841
+ */
842
+ conversion_events?: EventType[];
843
+ content_id_type?: ContentIDType;
844
+ /**
845
+ * Declarative normalization rules for external feeds. Maps non-standard feed field names, date formats, price encodings, and image URLs to the AdCP catalog item schema. Applied during sync_catalogs ingestion. Supports field renames, named transforms (date, divide, boolean, split), static literal injection, and assignment of image URLs to typed asset pools.
846
+ */
847
+ feed_field_mappings?: CatalogFieldMapping[];
848
+ /**
849
+ * Discriminator identifying this as a catalog asset. See /schemas/creative/asset-types for the registry.
850
+ */
851
+ asset_type: 'catalog';
852
+ }
853
+
854
+ /**
855
+ * Declares how a field in an external feed maps to the AdCP catalog item schema. Used in sync_catalogs feed_field_mappings to normalize non-AdCP feeds (Google Merchant Center, LinkedIn Jobs XML, hotel XML, etc.) to the standard catalog item schema without requiring the buyer to preprocess every feed. Multiple mappings can assemble a nested object via dot notation (e.g., separate mappings for price.amount and price.currency).
856
+ */
857
+ export interface CatalogFieldMapping {
858
+ /**
859
+ * Field name in the external feed record. Omit when injecting a static literal value (use the value property instead).
860
+ */
861
+ feed_field?: string;
862
+ /**
863
+ * Target field on the catalog item schema, using dot notation for nested fields (e.g., 'name', 'price.amount', 'location.city'). Mutually exclusive with asset_group_id.
864
+ */
865
+ catalog_field?: string;
866
+ /**
867
+ * Places the feed field value (a URL) into a typed asset pool on the catalog item's assets array. The value is wrapped as an image or video asset in a group with this ID. Use standard group IDs: 'images_landscape', 'images_vertical', 'images_square', 'logo', 'video'. Mutually exclusive with catalog_field.
868
+ */
869
+ asset_group_id?: string;
870
+ /**
871
+ * Static literal value to inject into catalog_field for every item, regardless of what the feed contains. Mutually exclusive with feed_field. Useful for fields the feed omits (e.g., currency when price is always USD, or a constant category value).
872
+ */
873
+ value?: unknown;
874
+ /**
875
+ * Named transform to apply to the feed field value before writing to the catalog schema. See transform-specific parameters (format, timezone, by, separator).
876
+ */
877
+ transform?: 'date' | 'divide' | 'boolean' | 'split';
878
+ /**
879
+ * For transform 'date': the input date format string (e.g., 'YYYYMMDD', 'MM/DD/YYYY', 'DD-MM-YYYY'). Output is always ISO 8601 (e.g., '2025-03-01'). Uses Unicode date pattern tokens.
880
+ */
881
+ format?: string;
882
+ /**
883
+ * For transform 'date': the timezone of the input value. IANA timezone identifier (e.g., 'UTC', 'America/New_York', 'Europe/Amsterdam'). Defaults to UTC when omitted.
884
+ */
885
+ timezone?: string;
886
+ /**
887
+ * For transform 'divide': the divisor to apply (e.g., 100 to convert integer cents to decimal dollars).
888
+ */
889
+ by?: number;
890
+ /**
891
+ * For transform 'split': the separator character or string to split on. Defaults to ','.
892
+ */
893
+ separator?: string;
894
+ /**
895
+ * Fallback value to use when feed_field is absent, null, or empty. Applied after any transform would have been applied. Allows optional feed fields to have a guaranteed baseline value.
896
+ */
897
+ default?: unknown;
898
+ ext?: ExtensionObject;
899
+ }
900
+
901
+ /**
902
+ * Catalog type. Structural types: 'offering' (AdCP Offering objects), 'product' (ecommerce entries), 'inventory' (stock per location), 'store' (physical locations), 'promotion' (deals and pricing). Vertical types: 'hotel', 'flight', 'job', 'vehicle', 'real_estate', 'education', 'destination', 'app' — each with an industry-specific item schema.
903
+ */
904
+ export type CatalogType = 'offering' | 'product' | 'inventory' | 'store' | 'promotion' | 'hotel' | 'flight' | 'job' | 'vehicle' | 'real_estate' | 'education' | 'destination' | 'app';
905
+
906
+ /**
907
+ * Cloud storage protocol
908
+ */
909
+ export type CloudStorageProtocol = 's3' | 'gcs' | 'azure_blob';
910
+
911
+ /**
912
+ * Identifier type that the event's content_ids field should be matched against for items in this catalog. For example, 'gtin' means content_ids values are Global Trade Item Numbers, 'sku' means retailer SKUs. Omit when using a custom identifier scheme not listed in the enum.
913
+ */
914
+ export type ContentIDType = 'sku' | 'gtin' | 'offering_id' | 'job_id' | 'hotel_id' | 'flight_id' | 'vehicle_id' | 'listing_id' | 'store_id' | 'program_id' | 'destination_id' | 'app_id';
915
+
916
+ /**
917
+ * 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.
918
+ */
919
+ export interface ContextObject {
920
+ }
921
+
922
+ /**
923
+ * Action taken for this creative during this sync operation (lifecycle operation, not approval state).
924
+ */
925
+ export type CreativeAction = 'created' | 'updated' | 'unchanged' | 'failed' | 'deleted';
926
+
927
+ /**
928
+ * Creative asset for upload to library — supports static assets, generative formats, and third-party snippets. Identifies which format this creative conforms to via EITHER a v1 `format_id` (structured `{agent_url, id}`) OR v2 `format_kind` (canonical format name). Mutually exclusive — see the `oneOf` at the schema root.
929
+ */
930
+ export type CreativeAsset = {
931
+ /**
932
+ * Unique identifier for the creative. Stable across v1 and v2 paths — a creative registered against v1 `format_id` retains the same `creative_id` when later viewed via v2 flatten.
933
+ */
934
+ creative_id: string;
935
+ /**
936
+ * Human-readable creative name
937
+ */
938
+ name: string;
939
+ format_id?: FormatReferenceStructuredObject;
940
+ format_kind?: CanonicalFormatKind;
941
+ /**
942
+ * v2 path, optional. Stable identifier matching one of the seller's product `format_options[i].capability_id` values. REQUIRED only when the target product has multiple `format_options` entries sharing the same `format_kind`.
943
+ */
944
+ capability_id?: string;
945
+ /**
946
+ * Assets required by the format, keyed by asset_id. Each slot value is either a single asset object or an array of asset objects (for slots with `min`/`max > 1` like carousel `cards` or responsive_creative `headlines`). Each asset value carries an `asset_type` discriminator that selects the matching asset schema.
947
+ */
948
+ assets: {
949
+ /**
950
+ * This interface was referenced by `undefined`'s JSON-Schema definition
951
+ * via the `patternProperty` "^[a-z0-9_]+$".
952
+ */
953
+ [k: string]: AssetVariant | AssetVariant[];
954
+ };
955
+ /**
956
+ * Preview contexts for generative formats - defines what scenarios to generate previews for
957
+ */
958
+ inputs?: {
959
+ /**
960
+ * Human-readable name for this preview variant
961
+ */
962
+ name: string;
963
+ /**
964
+ * Macro values to apply for this preview
965
+ */
966
+ macros?: {
967
+ [k: string]: string | undefined;
968
+ };
969
+ /**
970
+ * Natural language description of the context for AI-generated content
971
+ */
972
+ context_description?: string;
973
+ }[];
974
+ /**
975
+ * User-defined tags for organization and searchability
976
+ */
977
+ tags?: string[];
978
+ status?: CreativeStatus;
979
+ /**
980
+ * Optional delivery weight for creative rotation when uploading via create_media_buy or update_media_buy (0-100). If omitted, platform determines rotation. Only used during upload to media buy - not stored in creative library.
981
+ * @minimum 0
982
+ * @maximum 100
983
+ */
984
+ weight?: number;
985
+ /**
986
+ * Optional array of placement IDs where this creative should run when uploading via create_media_buy or update_media_buy. References placement_id values from the product's placements array. If omitted, creative runs on all placements. Only used during upload to media buy - not stored in creative library.
987
+ */
988
+ placement_ids?: string[];
989
+ /**
990
+ * Industry-standard identifiers for this creative (e.g., Ad-ID, ISCI, Clearcast clock number). In broadcast buying, these identifiers tie the creative to rotation instructions and traffic systems. A creative may have multiple identifiers when different systems reference the same asset.
991
+ */
992
+ industry_identifiers?: IndustryIdentifier[];
993
+ provenance?: Provenance;
994
+ } & (V1CreativeNamedFormatReference | V2CreativeCanonicalFormatKind);
995
+
996
+ /**
997
+ * Industry-standard identifier types for advertising creatives. These identifiers are managed by external registries and used across the supply chain to track and reference specific creative assets.
998
+ */
999
+ export type CreativeIdentifierType = 'ad_id' | 'isci' | 'clearcast_clock';
1000
+
1001
+ /**
1002
+ * For generative creatives: set to 'approved' to finalize, 'rejected' to request regeneration with updated assets/message. Omit for non-generative creatives (system will set based on processing state).
1003
+ */
1004
+ export type CreativeStatus = 'processing' | 'pending_review' | 'approved' | 'rejected' | 'archived';
1005
+
1006
+ /**
1007
+ * DAAST (Digital Audio Ad Serving Template) tag for third-party audio ad serving
1008
+ */
1009
+ export type DAASTAsset = {
1010
+ /**
1011
+ * Discriminator identifying this as a DAAST asset. See /schemas/creative/asset-types for the registry.
1012
+ */
1013
+ asset_type: 'daast';
1014
+ daast_version?: DAASTVersion;
1015
+ /**
1016
+ * Expected audio duration in milliseconds (if known)
1017
+ * @minimum 0
1018
+ */
1019
+ duration_ms?: number;
1020
+ /**
1021
+ * Tracking events supported by this DAAST tag
1022
+ */
1023
+ tracking_events?: DAASTTrackingEvent[];
1024
+ /**
1025
+ * Whether companion display ads are included
1026
+ */
1027
+ companion_ads?: boolean;
1028
+ /**
1029
+ * URL to text transcript of the audio content
1030
+ */
1031
+ transcript_url?: string;
1032
+ provenance?: Provenance;
1033
+ } & ({
1034
+ /**
1035
+ * Discriminator indicating DAAST is delivered via URL endpoint
1036
+ */
1037
+ delivery_type: 'url';
1038
+ /**
1039
+ * URL endpoint that returns DAAST XML
1040
+ */
1041
+ url: string;
1042
+ } | {
1043
+ /**
1044
+ * Discriminator indicating DAAST is delivered as inline XML content
1045
+ */
1046
+ delivery_type: 'inline';
1047
+ /**
1048
+ * Inline DAAST XML content
1049
+ */
1050
+ content: string;
1051
+ });
1052
+
1053
+ /**
1054
+ * Tracking events for audio ads. Aligned to the IAB DAAST 1.1 `Tracking@event` enumeration from §3.2.1.7 of the spec (creativeView, start, firstQuartile, midpoint, thirdQuartile, complete, mute, unmute, pause, rewind, resume, skip, progress) — plus `close` (referenced descriptively in DAAST 1.1 §3.2.4.2 contrasting it with `skip`), and AdCP-flattened representations of the `Impression`, `Error`, and click elements (`<Impression>`, `<Error>`, and the click children of `<AdInteractions>`) so a single declared list can cover everything a measurement vendor wants to track. `viewable` / `notViewable` / `viewUndetermined` and `measurableImpression` / `viewableImpression` are AdCP extensions for OM-SDK Audio measurability signals (DAAST 1.1 itself does not define a `<ViewableImpression>` element). DAAST 1.1 audio-incompatible video events are deliberately omitted: no `loaded`, `playerExpand` / `playerCollapse`, `fullscreen` / `exitFullscreen`, `acceptInvitation`, `adExpand` / `adCollapse`, `minimize`, `overlayViewDuration`, or `interactiveStart`.
1055
+ */
1056
+ export type DAASTTrackingEvent = 'impression' | 'creativeView' | 'start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'mute' | 'unmute' | 'pause' | 'resume' | 'rewind' | 'skip' | 'progress' | 'clickTracking' | 'customClick' | 'close' | 'error' | 'viewable' | 'notViewable' | 'viewUndetermined' | 'measurableImpression' | 'viewableImpression';
1057
+
1058
+ /**
1059
+ * DAAST specification version
1060
+ */
1061
+ export type DAASTVersion = '1.0' | '1.1';
1062
+
1063
+ /**
1064
+ * IPTC-aligned classification of AI involvement in producing this content
1065
+ */
1066
+ 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';
1067
+
1068
+ /**
1069
+ * How long the disclosure must persist during content playback or display
1070
+ */
1071
+ export type DisclosurePersistence = 'continuous' | 'initial' | 'flexible';
1072
+
1073
+ /**
1074
+ * 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.
1075
+ */
1076
+ export type DisclosurePosition = 'prominent' | 'footer' | 'audio' | 'subtitle' | 'overlay' | 'end_card' | 'pre_roll' | 'companion';
1077
+
1078
+ /**
1079
+ * How provenance data is carried within the content
1080
+ */
1081
+ export type EmbeddedProvenanceMethod = 'manifest_wrapper' | 'provenance_markers';
1082
+
1083
+ /**
1084
+ * Standard marketing event types for event logging, aligned with IAB ECAPI
1085
+ */
1086
+ export type EventType = 'page_view' | 'view_content' | 'select_content' | 'select_item' | 'search' | 'share' | 'add_to_cart' | 'remove_from_cart' | 'viewed_cart' | 'add_to_wishlist' | 'initiate_checkout' | 'add_payment_info' | 'purchase' | 'refund' | 'lead' | 'qualify_lead' | 'close_convert_lead' | 'disqualify_lead' | 'complete_registration' | 'subscribe' | 'start_trial' | 'app_install' | 'app_launch' | 'contact' | 'schedule' | 'donate' | 'submit_application' | 'custom';
1087
+
1088
+ /**
1089
+ * 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.
1090
+ */
1091
+ export interface ExtensionObject {
1092
+ }
1093
+
1094
+ /**
1095
+ * Format of the external feed at url. Required when url points to a non-AdCP feed (e.g., Google Merchant Center XML, Meta Product Catalog). Omit for offering-type catalogs where the feed is native AdCP JSON.
1096
+ */
1097
+ export type FeedFormat = 'google_merchant_center' | 'facebook_catalog' | 'shopify' | 'linkedin_jobs' | 'custom';
1098
+
1099
+ /**
1100
+ * A JSON object — never a plain string — that identifies a creative format by its declaring agent and local slug. Required properties: agent_url (URI of the agent that owns the format) and id (slug matching [a-zA-Z0-9_-]+). Example: {"agent_url": "https://creative.adcontextprotocol.org", "id": "display_300x250"}. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants. Using a plain string here is a schema violation.
1101
+ */
1102
+ export interface FormatReferenceStructuredObject {
1103
+ /**
1104
+ * URL of the agent that defines this format (e.g., 'https://creative.adcontextprotocol.org' for standard formats, or 'https://publisher.com/.well-known/adcp/sales' for custom formats). Callers comparing two `format-id` values MUST canonicalize `agent_url` per the AdCP URL canonicalization rules before treating two formats as the same. See docs/reference/url-canonicalization.
1105
+ */
1106
+ agent_url: string;
1107
+ /**
1108
+ * Format identifier within the agent's namespace (e.g., 'display_static', 'video_hosted', 'audio_standard'). When used alone, references a template format. When combined with dimension/duration fields, creates a parameterized format ID for a specific variant.
1109
+ * @pattern ^[a-zA-Z0-9_-]+$
1110
+ */
1111
+ id: string;
1112
+ /**
1113
+ * Width in pixels for visual formats. When specified, height must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.
1114
+ * @minimum 1
1115
+ */
1116
+ width?: number;
1117
+ /**
1118
+ * Height in pixels for visual formats. When specified, width must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.
1119
+ * @minimum 1
1120
+ */
1121
+ height?: number;
1122
+ /**
1123
+ * Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
1124
+ * @minimum 1
1125
+ */
1126
+ duration_ms?: number;
1127
+ }
1128
+
1129
+ /**
1130
+ * Whether the video uses a constant or variable frame rate. Broadcast and SSAI contexts require constant frame rate for seamless splicing.
1131
+ */
1132
+ export type FrameRateType = 'constant' | 'variable';
1133
+
1134
+ /**
1135
+ * Group of Pictures structure. SSAI and broadcast require closed GOPs for clean splice points; open GOPs may produce artifacts at ad boundaries.
1136
+ */
1137
+ export type GOPType = 'closed' | 'open';
1138
+
1139
+ /**
1140
+ * Inline HTML content asset. For URL-delivered HTML5 banner bundles, use the zip asset type instead. For single-URL iframe-rendered tag references, use the url asset type with an appropriate url_type.
1141
+ */
1142
+ export interface HTMLAsset {
1143
+ /**
1144
+ * Discriminator identifying this as an HTML asset. See /schemas/creative/asset-types for the registry.
1145
+ */
1146
+ asset_type: 'html';
1147
+ /**
1148
+ * HTML content
1149
+ */
1150
+ content: string;
1151
+ /**
1152
+ * HTML version (e.g., 'HTML5')
1153
+ */
1154
+ version?: string;
1155
+ /**
1156
+ * Self-declared accessibility properties for this opaque creative
1157
+ */
1158
+ accessibility?: {
1159
+ /**
1160
+ * Text alternative describing the creative content
1161
+ */
1162
+ alt_text?: string;
1163
+ /**
1164
+ * Whether the creative can be fully operated via keyboard
1165
+ */
1166
+ keyboard_navigable?: boolean;
1167
+ /**
1168
+ * Whether the creative respects prefers-reduced-motion or provides pause/stop controls
1169
+ */
1170
+ motion_control?: boolean;
1171
+ /**
1172
+ * Whether the creative has been tested with screen readers
1173
+ */
1174
+ screen_reader_tested?: boolean;
1175
+ };
1176
+ provenance?: Provenance;
1177
+ }
1178
+
1179
+ /**
1180
+ * HTTP method
1181
+ */
1182
+ export type HTTPMethod = 'GET' | 'POST';
1183
+
1184
+ /**
1185
+ * Override logo asset.
1186
+ */
1187
+ export interface ImageAsset {
1188
+ /**
1189
+ * Discriminator identifying this as an image asset. See /schemas/creative/asset-types for the registry.
1190
+ */
1191
+ asset_type: 'image';
1192
+ /**
1193
+ * URL to the image asset
1194
+ */
1195
+ url: string;
1196
+ /**
1197
+ * Width in pixels
1198
+ * @minimum 1
1199
+ */
1200
+ width: number;
1201
+ /**
1202
+ * Height in pixels
1203
+ * @minimum 1
1204
+ */
1205
+ height: number;
1206
+ /**
1207
+ * Image file format (jpg, png, gif, webp, etc.)
1208
+ */
1209
+ format?: string;
1210
+ /**
1211
+ * Alternative text for accessibility
1212
+ */
1213
+ alt_text?: string;
1214
+ provenance?: Provenance;
1215
+ }
1216
+
1217
+ /**
1218
+ * An industry-standard identifier for an advertising creative (e.g., Ad-ID, ISCI, Clearcast clock number). These identifiers are managed by external registries and used across the supply chain to track and reference specific creative assets.
1219
+ */
1220
+ export interface IndustryIdentifier {
1221
+ type: CreativeIdentifierType;
1222
+ /**
1223
+ * The identifier value (e.g., 'ABCD1234000H' for Ad-ID)
1224
+ * @maxLength 64
1225
+ */
1226
+ value: string;
1227
+ }
1228
+
1229
+ /**
1230
+ * Inline JavaScript content asset. For URL-delivered third-party tag scripts, use the url asset type with url_type 'tracker_script'. For HTML5 banner bundles that include JavaScript, use the zip asset type.
1231
+ */
1232
+ export interface JavaScriptAsset {
1233
+ /**
1234
+ * Discriminator identifying this as a JavaScript asset. See /schemas/creative/asset-types for the registry.
1235
+ */
1236
+ asset_type: 'javascript';
1237
+ /**
1238
+ * JavaScript content
1239
+ */
1240
+ content: string;
1241
+ module_type?: JavaScriptModuleType;
1242
+ /**
1243
+ * Self-declared accessibility properties for this opaque creative
1244
+ */
1245
+ accessibility?: {
1246
+ /**
1247
+ * Text alternative describing the creative content
1248
+ */
1249
+ alt_text?: string;
1250
+ /**
1251
+ * Whether the creative can be fully operated via keyboard
1252
+ */
1253
+ keyboard_navigable?: boolean;
1254
+ /**
1255
+ * Whether the creative respects prefers-reduced-motion or provides pause/stop controls
1256
+ */
1257
+ motion_control?: boolean;
1258
+ /**
1259
+ * Whether the creative has been tested with screen readers
1260
+ */
1261
+ screen_reader_tested?: boolean;
1262
+ };
1263
+ provenance?: Provenance;
1264
+ }
1265
+
1266
+ /**
1267
+ * JavaScript module type
1268
+ */
1269
+ export type JavaScriptModuleType = 'esm' | 'commonjs' | 'script';
1270
+
1271
+ /**
1272
+ * Markdown-formatted text content following CommonMark specification
1273
+ */
1274
+ export interface MarkdownAsset {
1275
+ /**
1276
+ * Discriminator identifying this as a markdown asset. See /schemas/creative/asset-types for the registry.
1277
+ */
1278
+ asset_type: 'markdown';
1279
+ /**
1280
+ * Markdown content following CommonMark spec with optional GitHub Flavored Markdown extensions
1281
+ */
1282
+ content: string;
1283
+ /**
1284
+ * Language code (e.g., 'en', 'es', 'fr')
1285
+ */
1286
+ language?: string;
1287
+ markdown_flavor?: MarkdownFlavor;
1288
+ /**
1289
+ * Whether raw HTML blocks are allowed in the markdown. False recommended for security.
1290
+ */
1291
+ allow_raw_html?: boolean;
1292
+ }
1293
+
1294
+ /**
1295
+ * Markdown flavor used. CommonMark for strict compatibility, GFM for tables/task lists/strikethrough.
1296
+ */
1297
+ export type MarkdownFlavor = 'commonmark' | 'gfm';
1298
+
1299
+ /**
1300
+ * Position of the moov atom in an MP4 container. 'start' enables progressive download without buffering the entire file; required for streaming ad delivery.
1301
+ */
1302
+ export type MoovAtomPosition = 'start' | 'end';
1303
+
1304
+ /**
1305
+ * Account-level webhook subscription for notifications whose lifecycle outlives any single media buy — creative state changes, library purges, wholesale feed change webhooks, and future account-scoped events. Distinct from `push-notification-config.json`, which anchors at a per-resource operation (a single task or media buy). An account MAY register multiple notification configs to fan a single seller's events out to multiple buyer-side endpoints; each entry filters by `event_types`. As with push-notification-config, the default signing scheme is the AdCP RFC 9421 webhook profile against the seller's brand.json `agents[]` JWKS; the optional `authentication` block opts into the deprecated Bearer / HMAC-SHA256 fallback for compatibility. Credentials and shared secrets in `authentication.credentials` are write-only — sellers MUST NOT echo them back in `list_accounts` responses. Sellers MUST verify endpoint control before activating account-level notification configs for high-volume event families such as wholesale feed changes; delivery-time SSRF validation still applies to every fire.
1306
+ */
1307
+ export interface NotificationConfig {
1308
+ /**
1309
+ * Buyer-supplied identifier for this subscription endpoint. Echoed on every webhook payload and on every `webhook_activity[]` record fired against this config so the buyer can attribute fires across multiple endpoints. MUST be unique within the account's `notification_configs[]` — uniqueness is enforced by the seller at registration time; duplicates are rejected with `errors[]`. Always required (even with a single subscriber) so the SDK contract is uniform — no conditional required-when-multiple rules to trip up implementations. Format is opaque — recommended values are short kebab-case slugs (`buyer-primary`, `audit-bus`, `dx-team`).
1310
+ * @minLength 1
1311
+ * @maxLength 64
1312
+ * @pattern ^[A-Za-z0-9_.:-]{1,64}$
1313
+ */
1314
+ subscriber_id: string;
1315
+ /**
1316
+ * Webhook endpoint URL. Same wire contract as `push-notification-config.url` — `format: "uri"`, no destination-port allowlist enforced by the protocol, SSRF protection via the IP-range check defined in docs/building/by-layer/L1/security.mdx#webhook-url-validation-ssrf. For wholesale feed subscribers, sellers MUST complete an activation challenge or equivalent proof-of-control before treating the subscriber as active.
1317
+ */
1318
+ url: string;
1319
+ /**
1320
+ * Notification types this subscriber wishes to receive on the registered `url`. The seller MUST NOT fire other types against this endpoint, and MUST NOT silently widen the filter when new types are added to `notification-type.json`. When omitted, the seller MUST default to a no-fire policy and surface an `errors[]` entry on `sync_accounts` so the buyer notices the missing filter. Values are drawn from `notification-type.json`, but only types whose contract anchors at the account scope are valid here — creative lifecycle events and wholesale feed change payloads are valid; media-buy-anchored types (`scheduled`, `final`, `delayed`, `adjusted`, `impairment`) belong on a media buy's `push_notification_config`, not on this surface; sellers MUST reject those entries as per-account validation failures with `INVALID_REQUEST` or `VALIDATION_ERROR` and `error.field` pointing at the invalid `event_types` entry rather than silently dropping them.
1321
+ */
1322
+ event_types: NotificationType[];
1323
+ /**
1324
+ * Legacy authentication selector. Same precedence and semantics as `push-notification-config.authentication` — presence opts the seller into Bearer or HMAC-SHA256 signing; absence selects the default RFC 9421 webhook profile keyed off the seller's brand.json `agents[]` JWKS. The same signed-registration downgrade-resistance rules apply to accounts[].notification_configs[].authentication. Deprecated; removed in AdCP 4.0. Credentials are write-only and MUST NOT be echoed on `list_accounts` reads.
1325
+ */
1326
+ authentication?: {
1327
+ schemes: AuthenticationScheme[];
1328
+ /**
1329
+ * Credentials for the legacy scheme. Bearer: token. HMAC-SHA256: shared secret. Minimum 32 characters. Exchanged out-of-band during onboarding. Write-only.
1330
+ * @minLength 32
1331
+ */
1332
+ credentials: string;
1333
+ };
1334
+ /**
1335
+ * When false, the seller persists the configuration but suppresses fires. Use to pause a noisy subscriber without losing the registration. Sellers MUST NOT skip persisting the entry when `active: false` — the buyer's next `sync_accounts` MUST observe the same array, otherwise the buyer cannot distinguish pause from drop.
1336
+ */
1337
+ active?: boolean;
1338
+ ext?: ExtensionObject;
1339
+ }
1340
+
1341
+ /**
1342
+ * Type of push notification fired by a seller agent. Media-buy-anchored notifications (`scheduled`, `final`, `delayed`, `adjusted`, `impairment`) fire against a media buy's `push_notification_config`. Account-anchored notifications (`creative.status_changed`, `creative.purged`, `product.*`, `signal.*`, `wholesale_feed.bulk_change`) fire against an account's `notification_configs[]` entries whose `event_types` include the value — these outlive any single media buy and anchor at the account. Wholesale feed notifications carry the actual change payload in `/schemas/core/wholesale-feed-webhook.json`; receivers use `get_products` / `get_signals` with `if_wholesale_feed_version` to repair or reconcile. New notification types added to this enum MUST declare their anchor (media-buy or account) and per-type `notification_id` semantics in the enumDescription. Sellers MUST reject `notification_configs[]` entries whose `event_types` include any media-buy-anchored type, and MUST reject `push_notification_config` registrations for account-anchored types.
1343
+ */
1344
+ export type NotificationType = 'scheduled' | 'final' | 'delayed' | 'adjusted' | 'impairment' | 'creative.status_changed' | 'creative.purged' | 'product.created' | 'product.updated' | 'product.priced' | 'product.removed' | 'signal.created' | 'signal.updated' | 'signal.priced' | 'signal.removed' | 'wholesale_feed.bulk_change';
1345
+
1346
+ /**
1347
+ * Payment terms agreed for this account. Binding for all invoices when the account is active.
1348
+ */
1349
+ export type PaymentTerms = 'net_15' | 'net_30' | 'net_45' | 'net_60' | 'net_90' | 'prepay';
1350
+
1351
+ /**
1352
+ * REQUIRED when `format_kind: "custom"`; otherwise MUST be absent. URI+digest reference to a fetchable schema describing this custom shape's actual `params` and `slots`. Same hosting model as `platform_extensions`: open-ecosystem publishers host the artifact at the canonical URI on their subdomain; closed-platform / walled-garden shapes resolve through the AAO mirror at `https://creative.adcontextprotocol.org/translated/...`. Buyer agents fetch by `uri@digest` (immutable per digest, aggressive caching, `Cache-Control: public, max-age=31536000, immutable`), validate `params` and `slots` against the fetched schema, and reason about manifests structurally — same mechanic as platform_extensions but at the format-structure level. Without `format_schema`, custom shapes would be opaque to buyer agents and the protocol would regress to per-seller integration code; that's why the schema is required, not optional.
1353
+ *
1354
+ * **Fetch contract (normative)** — `format_schema` is load-bearing for validation (unlike `platform_extensions`, which is informational on the *consumption* side). The *transport* rules below apply identically to BOTH fields — any SDK fetching a `platform-extension-ref.json` URI MUST apply this contract regardless of whether the field name is `format_schema` or `platform_extensions`. A shared SDK fetch path that drops to the weakest bar undermines `format_schema`'s hardening. The consumption distinction (load-bearing vs informational) is about *what the body means*; the transport distinction is `https`-and-allowlisted regardless.
1355
+ *
1356
+ * - **Transport**: `https` only. Buyers MUST reject `http://`, `file://`, `data:`, and any non-`https` scheme. The URI MUST resolve to a JSON document that is itself a valid JSON Schema (Draft 07 or 2020-12; producers MUST declare `$schema`).
1357
+ * - **SSRF protection**: buyers MUST resolve the URI hostname and reject if any resolved address is in RFC 1918 private space (`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`), loopback (`127.0.0.0/8`, `::1`), link-local (`169.254.0.0/16`, `fe80::/10`), CGNAT (`100.64.0.0/10`), or any RFC 6761 special-use name (`.local`, `.localhost`, `.internal`, `.test`, `.example`, `.invalid`). Cloud metadata endpoints (`169.254.169.254`, `metadata.google.internal`, `kubernetes.default.svc`) are explicitly forbidden — these are credential-leak primitives. Buyers MUST pin the connection to the resolved IP (or re-resolve and re-validate the allowlist per request) to defeat DNS rebinding.
1358
+ * - **HTTP redirects**: MUST be disabled. If a follow is implemented at all, the redirect target MUST pass the same scheme + SSRF + allowlist checks; otherwise the fetch hard-fails. Open redirects on same-origin paths are otherwise a free SSRF primitive.
1359
+ * - **Response size cap**: response body MUST be capped at 1 MiB. Enforce during streaming, not after full buffering. Over-cap hard-fails identically to digest mismatch.
1360
+ * - **Timeout**: SDKs SHOULD apply a fetch timeout ≤5 seconds. Timeout SHOULD be treated identically to an HTTP 5xx response (transient — retry policy at the SDK's discretion; on persistent failure surface as unresolved and skip the declaration for this session).
1361
+ * - **Digest verification**: SHA-256 of the response body MUST equal `digest`. **Digest mismatch is a hard fail** — the buyer MUST treat the format declaration as unresolvable and MUST NOT validate manifests against the mismatched body. A divergent digest is either a malicious substitution or producer error; either way, falling back to the un-verified body breaks the trust model. Digest format: `sha256:` prefix + 64 lowercase hex characters. Cache key is `uri@digest`; digest mismatch MUST NOT be cached as a negative result keyed on `uri` alone (defeats CDN-flap recovery), and MUST be distinguishable in telemetry from network 5xx / 404 (sustained mismatch is a substitution-attack signal, not a flap).
1362
+ * - **Sandboxing of `$ref`**: fetched schemas MAY use `$ref`. Buyers MUST resolve `$ref` only to URIs that are (a) same-origin as the parent `format_schema.uri` after RFC 3986 §6 normalization (lowercase scheme + host, strip default port, normalize path dot-segments, no userinfo component), OR (b) hosted under the AAO catalog domain (`https://creative.adcontextprotocol.org/...`), OR (c) intra-document JSON Pointer refs (`#/...`) bounded to the parent document's parsed tree. Cross-origin `$ref` to arbitrary URIs MUST be rejected. `$ref: file://...` MUST be rejected unconditionally. Transitive `$ref` chains MUST be bounded at depth ≤8 AND `$ref` count ≤256 across the resolved tree (depth 8 with breadth 100 per level is 10^16 nodes — depth alone is not enough). Publishers SHOULD inline rather than $ref where possible.
1363
+ * - **Schema-compile bounds (DoS protection)**: validators MUST bound CPU/memory on fetched schemas. Recommended: compiled-schema keyword count ≤10 000, `pattern` regexes evaluated with a non-backtracking engine (re2) OR under a per-pattern timeout, per-manifest validation budget ≤250 ms (exceeded budget → treat manifest as invalid, surface telemetry signal). Without these, a 'valid' schema with catastrophic regex backtracking or exponential `allOf`/`anyOf` expansion pins a CPU forever.
1364
+ * - **Cache**: buyers cache fetched schemas by `uri@digest` and treat them as immutable (the same hosting contract as `platform_extensions`). On `404`, network partition, or persistent fetch failure, buyers SHOULD degrade gracefully (treat the declaration as unresolved, skip it for the current `get_products` response, surface via `errors[]` with the relevant code) rather than failing the entire session.
1365
+ * - **Schema-not-valid handling**: if the fetched body parses as JSON but is not a valid JSON Schema, the buyer MUST treat the declaration as unresolvable (same as digest mismatch) and surface via `errors[]`. Validators MUST NOT attempt partial validation against an invalid schema.
1366
+ * - **AAO catalog trust**: `https://creative.adcontextprotocol.org/*` is a single trust anchor in the same-origin allowlist; compromise of the catalog domain or its CA compromises every buyer agent. Catalog-served bodies MUST be digest-pinned identically to origin fetches (the digest is on the *parent* `format_schema.uri@digest`, not on the catalog response). Future hardening (signed bodies, transparency log) is tracked separately.
1367
+ */
1368
+ export interface PlatformExtensionReference {
1369
+ /**
1370
+ * HTTPS URL identifying the extension. `https://` is mandatory — `http://`, `file://`, `data:`, and other schemes are rejected at the schema layer (defense-in-depth on top of the fetch-contract normative rules). The URI base is the owning agent's URL; the path identifies the extension within that agent. Example: 'https://creative.adcontextprotocol.org/translated/meta/extensions/meta_pixel'. The full fetch contract — SSRF allowlist, response-size cap, $ref sandbox, schema-compile bounds — is documented on `product-format-declaration.json#format_schema` and applies to ALL fetches of this reference shape regardless of whether the field is named `format_schema` (load-bearing for validation) or `platform_extensions` (informational); the *transport* rules are identical, only the *consumption* semantics differ.
1371
+ * @pattern ^https:\/\/
1372
+ */
1373
+ uri: string;
1374
+ /**
1375
+ * SHA-256 content digest of the extension definition (sha256:<hex>). Used to detect drift — if the agent revises the extension, the digest changes and cached definitions become invalid.
1376
+ * @pattern ^sha256:[a-f0-9]{64}$
1377
+ */
1378
+ digest: string;
1379
+ }
1380
+
1381
+ /**
1382
+ * Provenance metadata for this asset, overrides manifest-level provenance
1383
+ */
1384
+ export interface Provenance {
1385
+ digital_source_type?: DigitalSourceType;
1386
+ /**
1387
+ * AI system used to generate or modify this content. Aligns with IPTC 2025.1 AI metadata fields and C2PA claim_generator.
1388
+ */
1389
+ ai_tool?: {
1390
+ /**
1391
+ * Name of the AI tool or model (e.g., 'DALL-E 3', 'Stable Diffusion XL', 'Gemini')
1392
+ */
1393
+ name: string;
1394
+ /**
1395
+ * 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.
1396
+ */
1397
+ version?: string;
1398
+ /**
1399
+ * Organization that provides the AI tool (e.g., 'OpenAI', 'Stability AI', 'Google')
1400
+ */
1401
+ provider?: string;
1402
+ };
1403
+ /**
1404
+ * 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`.
1405
+ */
1406
+ human_oversight?: 'none' | 'prompt_only' | 'selected' | 'edited' | 'directed';
1407
+ /**
1408
+ * Party declaring this provenance. Identifies who attached the provenance claim, enabling receiving parties to assess trust.
1409
+ */
1410
+ declared_by?: {
1411
+ /**
1412
+ * URL of the agent or service that declared this provenance
1413
+ */
1414
+ agent_url?: string;
1415
+ /**
1416
+ * Role of the declaring party in the supply chain
1417
+ */
1418
+ role: 'creator' | 'advertiser' | 'agency' | 'platform' | 'tool';
1419
+ };
1420
+ /**
1421
+ * 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.
1422
+ * @format date-time
1423
+ */
1424
+ declared_at?: string;
1425
+ /**
1426
+ * When this content was created or generated (ISO 8601)
1427
+ * @format date-time
1428
+ */
1429
+ created_time?: string;
1430
+ /**
1431
+ * 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.
1432
+ */
1433
+ c2pa?: {
1434
+ /**
1435
+ * URL to the C2PA manifest store for this content
1436
+ */
1437
+ manifest_url: string;
1438
+ };
1439
+ /**
1440
+ * 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`).
1441
+ */
1442
+ embedded_provenance?: {
1443
+ method: EmbeddedProvenanceMethod;
1444
+ /**
1445
+ * Standard the embedding conforms to, if any (e.g., 'c2pa' for C2PA Section A.7 text manifest embedding)
1446
+ */
1447
+ standard?: string;
1448
+ /**
1449
+ * Organization that performed the embedding (e.g., 'Encypher', 'Digimarc'). Display label and audit context — not a wire identifier.
1450
+ */
1451
+ provider: string;
1452
+ /**
1453
+ * 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).
1454
+ */
1455
+ verify_agent?: {
1456
+ /**
1457
+ * 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.
1458
+ * @pattern ^https:\/\/
1459
+ */
1460
+ agent_url: string;
1461
+ /**
1462
+ * 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.
1463
+ */
1464
+ feature_id?: string;
1465
+ };
1466
+ /**
1467
+ * When the provenance data was embedded (ISO 8601)
1468
+ * @format date-time
1469
+ */
1470
+ embedded_at?: string;
1471
+ }[];
1472
+ /**
1473
+ * 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`).
1474
+ */
1475
+ watermarks?: {
1476
+ media_type: WatermarkMediaType;
1477
+ /**
1478
+ * Organization that applied the watermark (e.g., 'Imatag', 'Steg.AI', 'Encypher'). Display label and audit context — not a wire identifier.
1479
+ */
1480
+ provider: string;
1481
+ /**
1482
+ * 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).
1483
+ */
1484
+ verify_agent?: {
1485
+ /**
1486
+ * 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.
1487
+ * @pattern ^https:\/\/
1488
+ */
1489
+ agent_url: string;
1490
+ /**
1491
+ * 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.
1492
+ */
1493
+ feature_id?: string;
1494
+ };
1495
+ c2pa_action?: C2PAWatermarkAction;
1496
+ /**
1497
+ * When the watermark was applied (ISO 8601)
1498
+ * @format date-time
1499
+ */
1500
+ embedded_at?: string;
1501
+ }[];
1502
+ /**
1503
+ * Regulatory disclosure requirements for this content. Indicates whether AI disclosure is required and under which jurisdictions.
1504
+ */
1505
+ disclosure?: {
1506
+ /**
1507
+ * 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.
1508
+ */
1509
+ required: boolean;
1510
+ /**
1511
+ * Jurisdictions where disclosure obligations apply
1512
+ */
1513
+ jurisdictions?: {
1514
+ /**
1515
+ * ISO 3166-1 alpha-2 country code (e.g., 'US', 'DE', 'CN')
1516
+ */
1517
+ country: string;
1518
+ /**
1519
+ * Sub-national region code (e.g., 'CA' for California, 'BY' for Bavaria)
1520
+ */
1521
+ region?: string;
1522
+ /**
1523
+ * Regulation identifier (e.g., 'eu_ai_act_article_50', 'ca_sb_942', 'cn_deep_synthesis')
1524
+ */
1525
+ regulation: string;
1526
+ /**
1527
+ * Required disclosure label text for this jurisdiction, in the local language
1528
+ */
1529
+ label_text?: string;
1530
+ /**
1531
+ * 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.
1532
+ */
1533
+ render_guidance?: {
1534
+ persistence?: DisclosurePersistence;
1535
+ /**
1536
+ * 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.
1537
+ * @minimum 1
1538
+ */
1539
+ min_duration_ms?: number;
1540
+ /**
1541
+ * Preferred disclosure positions in priority order. The first position a format supports should be used.
1542
+ */
1543
+ positions?: DisclosurePosition[];
1544
+ ext?: ExtensionObject;
1545
+ };
1546
+ }[];
1547
+ };
1548
+ /**
1549
+ * 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.
1550
+ */
1551
+ verification?: {
1552
+ /**
1553
+ * Name of the verification service (e.g., 'DoubleVerify', 'Hive Moderation', 'Reality Defender')
1554
+ */
1555
+ verified_by: string;
1556
+ /**
1557
+ * When the verification was performed (ISO 8601)
1558
+ * @format date-time
1559
+ */
1560
+ verified_time?: string;
1561
+ /**
1562
+ * Verification outcome
1563
+ */
1564
+ result: 'authentic' | 'ai_generated' | 'ai_modified' | 'inconclusive';
1565
+ /**
1566
+ * Confidence score of the verification result (0.0 to 1.0)
1567
+ * @minimum 0
1568
+ * @maximum 1
1569
+ */
1570
+ confidence?: number;
1571
+ /**
1572
+ * URL to the full verification report
1573
+ */
1574
+ details_url?: string;
1575
+ }[];
1576
+ ext?: ExtensionObject;
1577
+ }
1578
+
1579
+ /**
1580
+ * 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.
1581
+ */
1582
+ export interface PushNotificationConfig {
1583
+ /**
1584
+ * 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).
1585
+ */
1586
+ url: string;
1587
+ /**
1588
+ * 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`.
1589
+ * @minLength 1
1590
+ * @maxLength 255
1591
+ * @pattern ^[A-Za-z0-9_.:-]{1,255}$
1592
+ */
1593
+ operation_id?: string;
1594
+ /**
1595
+ * 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.
1596
+ * @minLength 16
1597
+ * @maxLength 4096
1598
+ */
1599
+ token?: string;
1600
+ /**
1601
+ * 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).
1602
+ */
1603
+ authentication?: {
1604
+ /**
1605
+ * 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.
1606
+ */
1607
+ schemes: AuthenticationScheme[];
1608
+ /**
1609
+ * 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.
1610
+ * @minLength 32
1611
+ */
1612
+ credentials: string;
1613
+ };
1614
+ }
1615
+
1616
+ /**
1617
+ * A reference asset that provides creative context. Carries visual materials (mood boards, product shots, example creatives) with semantic roles that tell creative agents how to use them.
1618
+ */
1619
+ export interface ReferenceAsset {
1620
+ /**
1621
+ * URL to the reference asset (image, video, or document)
1622
+ */
1623
+ url: string;
1624
+ /**
1625
+ * How the creative agent should use this asset. style_reference: match the visual style; product_shot: include this product; mood_board: overall look and feel; example_creative: example of a similar execution; logo: logo to use; strategy_doc: strategy or planning document for context; storyboard: sequential visual direction for video or multi-scene creative
1626
+ */
1627
+ role: 'style_reference' | 'product_shot' | 'mood_board' | 'example_creative' | 'logo' | 'strategy_doc' | 'storyboard';
1628
+ /**
1629
+ * Human-readable description of the asset and how it should inform creative generation
1630
+ */
1631
+ description?: string;
1632
+ }
1633
+
1634
+ /**
1635
+ * Video scan method. Modern digital delivery requires progressive scan; interlaced is retained for broadcast legacy content.
1636
+ */
1637
+ export type ScanType = 'progressive' | 'interlaced';
1638
+
1639
+ /**
1640
+ * 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.
1641
+ */
1642
+ export type TaskStatus = 'submitted' | 'working' | 'input-required' | 'completed' | 'canceled' | 'failed' | 'rejected' | 'auth-required' | 'unknown';
1643
+
1644
+ /**
1645
+ * Text content asset
1646
+ */
1647
+ export interface TextAsset {
1648
+ /**
1649
+ * Discriminator identifying this as a text asset. See /schemas/creative/asset-types for the registry.
1650
+ */
1651
+ asset_type: 'text';
1652
+ /**
1653
+ * Text content
1654
+ */
1655
+ content: string;
1656
+ /**
1657
+ * Language code (e.g., 'en', 'es', 'fr')
1658
+ */
1659
+ language?: string;
1660
+ provenance?: Provenance;
1661
+ }
1662
+
1663
+ /**
1664
+ * URL reference asset. `url_type` declares the mechanism a receiver uses to invoke the URL (clickthrough vs. tracker_pixel vs. tracker_script) and is distinct from the URL's purpose, which the format declares in `url-asset-requirements.role` (clickthrough, landing_page, impression_tracker, click_tracker, viewability_tracker, third_party_tracker). Senders SHOULD include `url_type` on every URL asset. When `url_type` is absent, receivers SHOULD fall back to the format's `url-asset-requirements.role` per this mapping: clickthrough/landing_page → `clickthrough`; impression_tracker/click_tracker → `tracker_pixel`; viewability_tracker → `tracker_script` (OMID and equivalent verification SDKs require a <script> tag — firing them as a pixel produces no measurement); third_party_tracker → no safe fallback (mechanism is integration-specific — DV/IAS ship both pixel and script forms — receivers MAY reject or warn). When neither `url_type` nor a format-side `role` is available, receivers MUST NOT silently pick a mechanism; they SHOULD reject the manifest. Note: VAST/DAAST tag URLs are not URL assets — use `asset_type: "vast"` (or the dedicated tracker types pending RFC #2915), not `asset_type: "url"` with a tracker_pixel mechanism.
1665
+ */
1666
+ export interface URLAsset {
1667
+ /**
1668
+ * Discriminator identifying this as a URL asset. See /schemas/creative/asset-types for the registry.
1669
+ */
1670
+ asset_type: 'url';
1671
+ /**
1672
+ * URL reference. May be a plain URI or an RFC 6570 URI template carrying AdCP universal macros (e.g., `{SKU}`, `{MEDIA_BUY_ID}`). Buyers MUST NOT pre-encode macro braces at sync time; the ad server URL-encodes substituted values at impression time. See docs/creative/universal-macros.mdx.
1673
+ */
1674
+ url: string;
1675
+ url_type?: URLAssetType;
1676
+ /**
1677
+ * Description of what this URL points to
1678
+ */
1679
+ description?: string;
1680
+ provenance?: Provenance;
1681
+ }
1682
+
1683
+ /**
1684
+ * Mechanism a receiver uses to invoke this URL (distinct from purpose, which lives in `url-asset-requirements.role`): `clickthrough` for user click destination (landing page), `tracker_pixel` for impression/event tracking via HTTP request (fires GET, expects pixel/204 response), `tracker_script` for measurement SDKs that must load as a <script> tag (OMID verification, native event trackers using method:2). SHOULD be present on every URL asset; senders that omit it force the receiver into the role-based fallback described in this schema's top-level description.
1685
+ */
1686
+ export type URLAssetType = 'clickthrough' | 'tracker_pixel' | 'tracker_script';
1687
+
1688
+ /**
1689
+ * Standardized macro placeholders for dynamic value substitution in creative tracking URLs. Macros are replaced with actual values at impression time. See docs/creative/universal-macros.mdx for detailed documentation.
1690
+ */
1691
+ export type UniversalMacro = 'MEDIA_BUY_ID' | 'PACKAGE_ID' | 'CREATIVE_ID' | 'CACHEBUSTER' | 'TIMESTAMP' | 'CLICK_URL' | 'GDPR' | 'GDPR_CONSENT' | 'US_PRIVACY' | 'GPP_STRING' | 'GPP_SID' | 'IP_ADDRESS' | 'LIMIT_AD_TRACKING' | 'DEVICE_TYPE' | 'OS' | 'OS_VERSION' | 'DEVICE_MAKE' | 'DEVICE_MODEL' | 'USER_AGENT' | 'APP_BUNDLE' | 'APP_NAME' | 'COUNTRY' | 'REGION' | 'CITY' | 'ZIP' | 'DMA' | 'LAT' | 'LONG' | 'DEVICE_ID' | 'DEVICE_ID_TYPE' | 'DOMAIN' | 'PAGE_URL' | 'REFERRER' | 'KEYWORDS' | 'PLACEMENT_ID' | 'FOLD_POSITION' | 'AD_WIDTH' | 'AD_HEIGHT' | 'VIDEO_ID' | 'VIDEO_TITLE' | 'VIDEO_DURATION' | 'VIDEO_CATEGORY' | 'CONTENT_GENRE' | 'CONTENT_RATING' | 'PLAYER_WIDTH' | 'PLAYER_HEIGHT' | 'POD_POSITION' | 'POD_SIZE' | 'AD_BREAK_ID' | 'STATION_ID' | 'COLLECTION_NAME' | 'INSTALLMENT_ID' | 'AUDIO_DURATION' | 'TMPX' | 'AXEM' | 'CATALOG_ID' | 'SKU' | 'GTIN' | 'OFFERING_ID' | 'JOB_ID' | 'HOTEL_ID' | 'FLIGHT_ID' | 'VEHICLE_ID' | 'LISTING_ID' | 'STORE_ID' | 'PROGRAM_ID' | 'DESTINATION_ID' | 'CREATIVE_VARIANT_ID' | 'APP_ITEM_ID';
1692
+
1693
+ /**
1694
+ * How often the platform should re-fetch the feed from url. Only applicable when url is provided. Platforms may use this as a hint for polling schedules.
1695
+ */
1696
+ export type UpdateFrequency = 'realtime' | 'hourly' | 'daily' | 'weekly';
1697
+
1698
+ /**
1699
+ * Creative references a named format via the structured `format_id` object. The v1 path; remains supported through 4.x.
1700
+ */
1701
+ export interface V1CreativeNamedFormatReference {
1702
+ /**
1703
+ * Unique identifier for the creative. Stable across v1 and v2 paths — a creative registered against v1 `format_id` retains the same `creative_id` when later viewed via v2 flatten.
1704
+ */
1705
+ creative_id: string;
1706
+ /**
1707
+ * Human-readable creative name
1708
+ */
1709
+ name: string;
1710
+ format_id: FormatReferenceStructuredObject;
1711
+ /**
1712
+ * v2 path, optional. Stable identifier matching one of the seller's product `format_options[i].capability_id` values. REQUIRED only when the target product has multiple `format_options` entries sharing the same `format_kind`.
1713
+ */
1714
+ capability_id?: string;
1715
+ /**
1716
+ * Assets required by the format, keyed by asset_id. Each slot value is either a single asset object or an array of asset objects (for slots with `min`/`max > 1` like carousel `cards` or responsive_creative `headlines`). Each asset value carries an `asset_type` discriminator that selects the matching asset schema.
1717
+ */
1718
+ assets: {
1719
+ /**
1720
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1721
+ * via the `patternProperty` "^[a-z0-9_]+$".
1722
+ */
1723
+ [k: string]: AssetVariant | AssetVariant[];
1724
+ };
1725
+ /**
1726
+ * Preview contexts for generative formats - defines what scenarios to generate previews for
1727
+ */
1728
+ inputs?: {
1729
+ /**
1730
+ * Human-readable name for this preview variant
1731
+ */
1732
+ name: string;
1733
+ /**
1734
+ * Macro values to apply for this preview
1735
+ */
1736
+ macros?: {
1737
+ [k: string]: string | undefined;
1738
+ };
1739
+ /**
1740
+ * Natural language description of the context for AI-generated content
1741
+ */
1742
+ context_description?: string;
1743
+ }[];
1744
+ /**
1745
+ * User-defined tags for organization and searchability
1746
+ */
1747
+ tags?: string[];
1748
+ status?: CreativeStatus;
1749
+ /**
1750
+ * Optional delivery weight for creative rotation when uploading via create_media_buy or update_media_buy (0-100). If omitted, platform determines rotation. Only used during upload to media buy - not stored in creative library.
1751
+ * @minimum 0
1752
+ * @maximum 100
1753
+ */
1754
+ weight?: number;
1755
+ /**
1756
+ * Optional array of placement IDs where this creative should run when uploading via create_media_buy or update_media_buy. References placement_id values from the product's placements array. If omitted, creative runs on all placements. Only used during upload to media buy - not stored in creative library.
1757
+ */
1758
+ placement_ids?: string[];
1759
+ /**
1760
+ * Industry-standard identifiers for this creative (e.g., Ad-ID, ISCI, Clearcast clock number). In broadcast buying, these identifiers tie the creative to rotation instructions and traffic systems. A creative may have multiple identifiers when different systems reference the same asset.
1761
+ */
1762
+ industry_identifiers?: IndustryIdentifier[];
1763
+ provenance?: Provenance;
1764
+ }
1765
+
1766
+ /**
1767
+ * Creative declares which canonical format it targets via `format_kind` (e.g., `image`). The v2 path introduced by RFC #3305.
1768
+ */
1769
+ export interface V2CreativeCanonicalFormatKind {
1770
+ /**
1771
+ * Unique identifier for the creative. Stable across v1 and v2 paths — a creative registered against v1 `format_id` retains the same `creative_id` when later viewed via v2 flatten.
1772
+ */
1773
+ creative_id: string;
1774
+ /**
1775
+ * Human-readable creative name
1776
+ */
1777
+ name: string;
1778
+ format_kind: CanonicalFormatKind;
1779
+ /**
1780
+ * v2 path, optional. Stable identifier matching one of the seller's product `format_options[i].capability_id` values. REQUIRED only when the target product has multiple `format_options` entries sharing the same `format_kind`.
1781
+ */
1782
+ capability_id?: string;
1783
+ /**
1784
+ * Assets required by the format, keyed by asset_id. Each slot value is either a single asset object or an array of asset objects (for slots with `min`/`max > 1` like carousel `cards` or responsive_creative `headlines`). Each asset value carries an `asset_type` discriminator that selects the matching asset schema.
1785
+ */
1786
+ assets: {
1787
+ /**
1788
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1789
+ * via the `patternProperty` "^[a-z0-9_]+$".
1790
+ */
1791
+ [k: string]: AssetVariant | AssetVariant[];
1792
+ };
1793
+ /**
1794
+ * Preview contexts for generative formats - defines what scenarios to generate previews for
1795
+ */
1796
+ inputs?: {
1797
+ /**
1798
+ * Human-readable name for this preview variant
1799
+ */
1800
+ name: string;
1801
+ /**
1802
+ * Macro values to apply for this preview
1803
+ */
1804
+ macros?: {
1805
+ [k: string]: string | undefined;
1806
+ };
1807
+ /**
1808
+ * Natural language description of the context for AI-generated content
1809
+ */
1810
+ context_description?: string;
1811
+ }[];
1812
+ /**
1813
+ * User-defined tags for organization and searchability
1814
+ */
1815
+ tags?: string[];
1816
+ status?: CreativeStatus;
1817
+ /**
1818
+ * Optional delivery weight for creative rotation when uploading via create_media_buy or update_media_buy (0-100). If omitted, platform determines rotation. Only used during upload to media buy - not stored in creative library.
1819
+ * @minimum 0
1820
+ * @maximum 100
1821
+ */
1822
+ weight?: number;
1823
+ /**
1824
+ * Optional array of placement IDs where this creative should run when uploading via create_media_buy or update_media_buy. References placement_id values from the product's placements array. If omitted, creative runs on all placements. Only used during upload to media buy - not stored in creative library.
1825
+ */
1826
+ placement_ids?: string[];
1827
+ /**
1828
+ * Industry-standard identifiers for this creative (e.g., Ad-ID, ISCI, Clearcast clock number). In broadcast buying, these identifiers tie the creative to rotation instructions and traffic systems. A creative may have multiple identifiers when different systems reference the same asset.
1829
+ */
1830
+ industry_identifiers?: IndustryIdentifier[];
1831
+ provenance?: Provenance;
1832
+ }
1833
+
1834
+ /**
1835
+ * VAST (Video Ad Serving Template) tag for third-party video ad serving
1836
+ */
1837
+ export type VASTAsset = {
1838
+ /**
1839
+ * Discriminator identifying this as a VAST asset. See /schemas/creative/asset-types for the registry.
1840
+ */
1841
+ asset_type: 'vast';
1842
+ vast_version?: VASTVersion;
1843
+ /**
1844
+ * Whether VPAID (Video Player-Ad Interface Definition) is supported
1845
+ */
1846
+ vpaid_enabled?: boolean;
1847
+ /**
1848
+ * Expected video duration in milliseconds (if known)
1849
+ * @minimum 0
1850
+ */
1851
+ duration_ms?: number;
1852
+ /**
1853
+ * Tracking events supported by this VAST tag
1854
+ */
1855
+ tracking_events?: VASTTrackingEvent[];
1856
+ /**
1857
+ * URL to captions file (WebVTT, SRT, etc.)
1858
+ */
1859
+ captions_url?: string;
1860
+ /**
1861
+ * URL to audio description track for visually impaired users
1862
+ */
1863
+ audio_description_url?: string;
1864
+ provenance?: Provenance;
1865
+ } & ({
1866
+ /**
1867
+ * Discriminator indicating VAST is delivered via URL endpoint
1868
+ */
1869
+ delivery_type: 'url';
1870
+ /**
1871
+ * URL endpoint that returns VAST XML
1872
+ */
1873
+ url: string;
1874
+ } | {
1875
+ /**
1876
+ * Discriminator indicating VAST is delivered as inline XML content
1877
+ */
1878
+ delivery_type: 'inline';
1879
+ /**
1880
+ * Inline VAST XML content
1881
+ */
1882
+ content: string;
1883
+ });
1884
+
1885
+ /**
1886
+ * Tracking events for video ads. Includes the IAB VAST 4.2 `Tracking@event` enumeration (vast_4.2.xsd `TrackingEvents_type`, lines 112–136), plus AdCP-flattened representations of the `Impression`, `Error`, `VideoClicks`, and `ViewableImpression` elements (which live in dedicated VAST elements, not under `<TrackingEvents>` — they are surfaced here so a single declared list can cover everything a measurement vendor wants to track). `fullscreen` / `exitFullscreen` are retained for VAST 2.x / 3.x compatibility (VAST 4.0+ replaced them with `playerExpand` / `playerCollapse`). `measurableImpression` is an AdCP extension for MRC measurability signals.
1887
+ */
1888
+ export type VASTTrackingEvent = 'impression' | 'creativeView' | 'loaded' | 'start' | 'firstQuartile' | 'midpoint' | 'thirdQuartile' | 'complete' | 'mute' | 'unmute' | 'pause' | 'resume' | 'rewind' | 'skip' | 'playerExpand' | 'playerCollapse' | 'fullscreen' | 'exitFullscreen' | 'progress' | 'acceptInvitation' | 'adExpand' | 'adCollapse' | 'minimize' | 'overlayViewDuration' | 'otherAdInteraction' | 'interactiveStart' | 'clickTracking' | 'customClick' | 'close' | 'closeLinear' | 'error' | 'viewable' | 'notViewable' | 'viewUndetermined' | 'measurableImpression' | 'viewableImpression';
1889
+
1890
+ /**
1891
+ * VAST specification version
1892
+ */
1893
+ export type VASTVersion = '2.0' | '3.0' | '4.0' | '4.1' | '4.2';
1894
+
1895
+ /**
1896
+ * Validation strictness. 'strict' fails entire sync on any validation error. 'lenient' processes valid catalogs and reports errors.
1897
+ */
1898
+ export type ValidationMode = 'strict' | 'lenient';
1899
+
1900
+ /**
1901
+ * Video asset with URL and technical specifications including audio track properties
1902
+ */
1903
+ export interface VideoAsset {
1904
+ /**
1905
+ * Discriminator identifying this as a video asset. See /schemas/creative/asset-types for the registry.
1906
+ */
1907
+ asset_type: 'video';
1908
+ /**
1909
+ * URL to the video asset
1910
+ */
1911
+ url: string;
1912
+ /**
1913
+ * Width in pixels
1914
+ * @minimum 1
1915
+ */
1916
+ width: number;
1917
+ /**
1918
+ * Height in pixels
1919
+ * @minimum 1
1920
+ */
1921
+ height: number;
1922
+ /**
1923
+ * Video duration in milliseconds
1924
+ * @minimum 1
1925
+ */
1926
+ duration_ms?: number;
1927
+ /**
1928
+ * File size in bytes
1929
+ * @minimum 1
1930
+ */
1931
+ file_size_bytes?: number;
1932
+ /**
1933
+ * Video container format (mp4, webm, mov, etc.)
1934
+ */
1935
+ container_format?: string;
1936
+ /**
1937
+ * Video codec used (h264, h265, vp9, av1, prores, etc.)
1938
+ */
1939
+ video_codec?: string;
1940
+ /**
1941
+ * Video stream bitrate in kilobits per second
1942
+ * @minimum 1
1943
+ */
1944
+ video_bitrate_kbps?: number;
1945
+ /**
1946
+ * Frame rate as string to preserve precision (e.g., '23.976', '29.97', '30')
1947
+ */
1948
+ frame_rate?: string;
1949
+ frame_rate_type?: FrameRateType;
1950
+ scan_type?: ScanType;
1951
+ /**
1952
+ * Color space of the video
1953
+ */
1954
+ color_space?: 'rec709' | 'rec2020' | 'rec2100' | 'srgb' | 'dci_p3';
1955
+ /**
1956
+ * HDR format if applicable, or 'sdr' for standard dynamic range
1957
+ */
1958
+ hdr_format?: 'sdr' | 'hdr10' | 'hdr10_plus' | 'hlg' | 'dolby_vision';
1959
+ /**
1960
+ * Chroma subsampling format
1961
+ */
1962
+ chroma_subsampling?: '4:2:0' | '4:2:2' | '4:4:4';
1963
+ /**
1964
+ * Video bit depth
1965
+ */
1966
+ video_bit_depth?: 8 | 10 | 12;
1967
+ /**
1968
+ * GOP/keyframe interval in seconds
1969
+ */
1970
+ gop_interval_seconds?: number;
1971
+ gop_type?: GOPType;
1972
+ moov_atom_position?: MoovAtomPosition;
1973
+ /**
1974
+ * Whether the video contains an audio track
1975
+ */
1976
+ has_audio?: boolean;
1977
+ /**
1978
+ * Audio codec used (aac, aac_lc, he_aac, pcm, mp3, ac3, eac3, etc.)
1979
+ */
1980
+ audio_codec?: string;
1981
+ /**
1982
+ * Audio sampling rate in Hz (e.g., 44100, 48000)
1983
+ */
1984
+ audio_sampling_rate_hz?: number;
1985
+ audio_channels?: AudioChannelLayout;
1986
+ /**
1987
+ * Audio bit depth
1988
+ */
1989
+ audio_bit_depth?: 16 | 24 | 32;
1990
+ /**
1991
+ * Audio bitrate in kilobits per second
1992
+ * @minimum 1
1993
+ */
1994
+ audio_bitrate_kbps?: number;
1995
+ /**
1996
+ * Integrated loudness in LUFS
1997
+ */
1998
+ audio_loudness_lufs?: number;
1999
+ /**
2000
+ * True peak level in dBFS
2001
+ */
2002
+ audio_true_peak_dbfs?: number;
2003
+ /**
2004
+ * URL to captions file (WebVTT, SRT, etc.)
2005
+ */
2006
+ captions_url?: string;
2007
+ /**
2008
+ * URL to text transcript of the video content
2009
+ */
2010
+ transcript_url?: string;
2011
+ /**
2012
+ * URL to audio description track for visually impaired users
2013
+ */
2014
+ audio_description_url?: string;
2015
+ provenance?: Provenance;
2016
+ }
2017
+
2018
+ /**
2019
+ * Media category of the watermarked content
2020
+ */
2021
+ export type WatermarkMediaType = 'audio' | 'image' | 'video' | 'text';
2022
+
2023
+ /**
2024
+ * Webhook for server-side dynamic content rendering (DCO)
2025
+ */
2026
+ export interface WebhookAsset {
2027
+ /**
2028
+ * Discriminator identifying this as a webhook asset. See /schemas/creative/asset-types for the registry.
2029
+ */
2030
+ asset_type: 'webhook';
2031
+ /**
2032
+ * Webhook URL to call for dynamic content
2033
+ */
2034
+ url: string;
2035
+ method?: HTTPMethod;
2036
+ /**
2037
+ * Maximum time to wait for response in milliseconds
2038
+ * @minimum 10
2039
+ * @maximum 5000
2040
+ */
2041
+ timeout_ms?: number;
2042
+ /**
2043
+ * Universal macros that can be passed to webhook (e.g., DEVICE_TYPE, COUNTRY). See docs/creative/universal-macros.mdx for full list.
2044
+ */
2045
+ supported_macros?: (UniversalMacro | string)[];
2046
+ /**
2047
+ * Universal macros that must be provided for webhook to function
2048
+ */
2049
+ required_macros?: (UniversalMacro | string)[];
2050
+ response_type: WebhookResponseType;
2051
+ /**
2052
+ * Security configuration for webhook calls
2053
+ */
2054
+ security: {
2055
+ method: WebhookSecurityMethod;
2056
+ /**
2057
+ * Header name for HMAC signature (e.g., 'X-Signature')
2058
+ */
2059
+ hmac_header?: string;
2060
+ /**
2061
+ * Header name for API key (e.g., 'X-API-Key')
2062
+ */
2063
+ api_key_header?: string;
2064
+ };
2065
+ provenance?: Provenance;
2066
+ }
2067
+
2068
+ /**
2069
+ * Expected content type of webhook response
2070
+ */
2071
+ export type WebhookResponseType = 'html' | 'json' | 'xml' | 'javascript';
2072
+
2073
+ /**
2074
+ * Authentication method
2075
+ */
2076
+ export type WebhookSecurityMethod = 'hmac_sha256' | 'api_key' | 'none';
2077
+
2078
+ /**
2079
+ * Bundled creative asset delivered as a zip archive — typically an HTML5 banner with index.html plus supporting CSS, JS, images, and fonts. Receivers unpack the zip, validate internal structure, and serve contents from CDN. Distinct from inline HTML (html asset) and from third-party tag URLs (url asset with url_type tracker_script).
2080
+ */
2081
+ export interface ZipAsset {
2082
+ /**
2083
+ * Discriminator identifying this as a zip-bundled asset. See /schemas/creative/asset-types for the registry.
2084
+ */
2085
+ asset_type: 'zip';
2086
+ /**
2087
+ * URL where the zip archive is hosted. Must be HTTPS.
2088
+ */
2089
+ url: string;
2090
+ /**
2091
+ * Maximum file size in kilobytes. Receivers should reject zips exceeding this.
2092
+ * @minimum 0
2093
+ */
2094
+ max_file_size_kb?: number;
2095
+ /**
2096
+ * Relative path to the entry file within the zip (typically 'index.html'). Receivers default to 'index.html' if absent.
2097
+ */
2098
+ entry_point?: string;
2099
+ /**
2100
+ * File extensions permitted inside the zip (e.g., ['html', 'css', 'js', 'png', 'jpg', 'svg', 'webp', 'json', 'woff2']). Receivers may reject zips containing other extensions.
2101
+ */
2102
+ allowed_inner_extensions?: string[];
2103
+ /**
2104
+ * Fallback image URL for environments that cannot render the bundled creative (e.g., non-HTML5 endpoints, ad blockers). Recommended for HTML5 banners.
2105
+ */
2106
+ backup_image_url?: string;
2107
+ /**
2108
+ * Optional SHA-256 content digest of the zip archive (sha256:<hex>) for integrity verification. Lets receivers detect tampered or stale archives.
2109
+ * @pattern ^sha256:[a-f0-9]{64}$
2110
+ */
2111
+ digest?: string;
2112
+ /**
2113
+ * Self-declared accessibility properties for this opaque creative
2114
+ */
2115
+ accessibility?: {
2116
+ /**
2117
+ * Text alternative describing the creative content
2118
+ */
2119
+ alt_text?: string;
2120
+ /**
2121
+ * Whether the creative can be fully operated via keyboard
2122
+ */
2123
+ keyboard_navigable?: boolean;
2124
+ /**
2125
+ * Whether the creative respects prefers-reduced-motion or provides pause/stop controls
2126
+ */
2127
+ motion_control?: boolean;
2128
+ /**
2129
+ * Whether the creative has been tested with screen readers
2130
+ */
2131
+ screen_reader_tested?: boolean;
2132
+ };
2133
+ provenance?: Provenance;
2134
+ }