@adcp/sdk 8.1.0-beta.7 → 8.1.0-beta.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/dist/lib/schemas-data/v2.5/_provenance.json +1 -1
- package/dist/lib/types/activate-signal.d.ts +647 -0
- package/dist/lib/types/build-creative.d.ts +2105 -0
- package/dist/lib/types/calibrate-content.d.ts +675 -0
- package/dist/lib/types/check-governance.d.ts +619 -0
- package/dist/lib/types/comply-test-controller.d.ts +8428 -0
- package/dist/lib/types/create-collection-list.d.ts +693 -0
- package/dist/lib/types/create-content-standards.d.ts +830 -0
- package/dist/lib/types/create-media-buy.d.ts +3374 -0
- package/dist/lib/types/create-property-list.d.ts +836 -0
- package/dist/lib/types/delete-collection-list.d.ts +497 -0
- package/dist/lib/types/delete-property-list.d.ts +497 -0
- package/dist/lib/types/get-account-financials.d.ts +624 -0
- package/dist/lib/types/get-adcp-capabilities.d.ts +2863 -0
- package/dist/lib/types/get-collection-list.d.ts +763 -0
- package/dist/lib/types/get-content-standards.d.ts +919 -0
- package/dist/lib/types/get-creative-delivery.d.ts +2219 -0
- package/dist/lib/types/get-creative-features.d.ts +1736 -0
- package/dist/lib/types/get-media-buy-artifacts.d.ts +864 -0
- package/dist/lib/types/get-media-buys.d.ts +1670 -0
- package/dist/lib/types/get-plan-audit-logs.d.ts +455 -0
- package/dist/lib/types/get-products.d.ts +4935 -0
- package/dist/lib/types/get-property-list.d.ts +874 -0
- package/dist/lib/types/get-signals.d.ts +986 -0
- package/dist/lib/types/list-accounts.d.ts +851 -0
- package/dist/lib/types/list-content-standards.d.ts +975 -0
- package/dist/lib/types/list-creative-formats.d.ts +3132 -0
- package/dist/lib/types/list-creatives.d.ts +2390 -0
- package/dist/lib/types/list-property-lists.d.ts +855 -0
- package/dist/lib/types/log-event.d.ts +373 -0
- package/dist/lib/types/per-tool-index.json +391 -0
- package/dist/lib/types/preview-creative.d.ts +1981 -0
- package/dist/lib/types/provide-performance-feedback.d.ts +218 -0
- package/dist/lib/types/report-plan-outcome.d.ts +433 -0
- package/dist/lib/types/report-usage.d.ts +579 -0
- package/dist/lib/types/si-get-offering.d.ts +259 -0
- package/dist/lib/types/si-initiate-session.d.ts +372 -0
- package/dist/lib/types/si-send-message.d.ts +300 -0
- package/dist/lib/types/si-terminate-session.d.ts +213 -0
- package/dist/lib/types/sync-accounts.d.ts +856 -0
- package/dist/lib/types/sync-audiences.d.ts +707 -0
- package/dist/lib/types/sync-catalogs.d.ts +766 -0
- package/dist/lib/types/sync-creatives.d.ts +2134 -0
- package/dist/lib/types/sync-event-sources.d.ts +665 -0
- package/dist/lib/types/sync-governance.d.ts +558 -0
- package/dist/lib/types/sync-plans.d.ts +979 -0
- package/dist/lib/types/update-collection-list.d.ts +697 -0
- package/dist/lib/types/update-content-standards.d.ts +847 -0
- package/dist/lib/types/update-media-buy.d.ts +3047 -0
- package/dist/lib/types/update-property-list.d.ts +840 -0
- package/dist/lib/types/validate-content-delivery.d.ts +722 -0
- package/dist/lib/types/validate-input.d.ts +1683 -0
- package/dist/lib/version.d.ts +3 -3
- package/dist/lib/version.js +3 -3
- package/package.json +9 -2
|
@@ -0,0 +1,2105 @@
|
|
|
1
|
+
// AUTO-GENERATED — DO NOT EDIT.
|
|
2
|
+
// Per-tool .d.ts slice for `build_creative`. 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 to transform, generate, or retrieve a creative manifest. Supports three modes: (1) generation from a brief or seed assets, (2) transformation of an existing manifest, (3) retrieval from a creative library by creative_id. Produces target manifest(s) in the specified format(s). Provide either target_format_id for a single format or target_format_ids for multiple formats.
|
|
13
|
+
*/
|
|
14
|
+
export interface BuildCreativeRequest {
|
|
15
|
+
/**
|
|
16
|
+
* Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.
|
|
17
|
+
*/
|
|
18
|
+
adcp_version?: string;
|
|
19
|
+
/**
|
|
20
|
+
* DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.
|
|
21
|
+
*/
|
|
22
|
+
adcp_major_version?: number;
|
|
23
|
+
/**
|
|
24
|
+
* Natural language instructions for the transformation or generation. For pure generation, this is the creative brief. For transformation, this provides guidance on how to adapt the creative. For refinement, this describes the desired changes.
|
|
25
|
+
*/
|
|
26
|
+
message?: string;
|
|
27
|
+
creative_manifest?: CreativeManifest;
|
|
28
|
+
/**
|
|
29
|
+
* Reference to a creative in the agent's library. The creative agent resolves this to a manifest from its library. Use this instead of creative_manifest when retrieving an existing creative for tag generation or format adaptation.
|
|
30
|
+
*/
|
|
31
|
+
creative_id?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Creative concept containing the creative. Creative agents SHOULD assign globally unique creative_id values; when they cannot guarantee uniqueness, concept_id is REQUIRED to disambiguate.
|
|
34
|
+
*/
|
|
35
|
+
concept_id?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Media buy identifier for tag generation context. When the creative agent is also the ad server, this provides the trafficking context needed to generate placement-specific tags (e.g., CM360 placement ID). Not needed when tags are generated at the creative level (most creative platforms).
|
|
38
|
+
*/
|
|
39
|
+
media_buy_id?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Package identifier within the media buy. Used with media_buy_id when the creative agent needs line-item-level context for tag generation. Omit to get a tag not scoped to a specific package.
|
|
42
|
+
*/
|
|
43
|
+
package_id?: string;
|
|
44
|
+
target_format_id?: FormatReferenceStructuredObject;
|
|
45
|
+
/**
|
|
46
|
+
* Array of format IDs to generate in a single call. Mutually exclusive with target_format_id. The creative agent produces one manifest per format. Each format definition specifies its own required input assets and output structure.
|
|
47
|
+
*/
|
|
48
|
+
target_format_ids?: FormatReferenceStructuredObject[];
|
|
49
|
+
account?: AccountReference;
|
|
50
|
+
brand?: BrandReference;
|
|
51
|
+
quality?: CreativeQuality;
|
|
52
|
+
/**
|
|
53
|
+
* Maximum number of catalog items to use when generating. When a catalog asset contains more items than this limit, the creative agent selects the top items based on relevance or catalog ordering. When item_limit exceeds the format's max_items, the creative agent SHOULD use the lesser of the two. Ignored when the manifest contains no catalog assets.
|
|
54
|
+
* @minimum 1
|
|
55
|
+
*/
|
|
56
|
+
item_limit?: number;
|
|
57
|
+
/**
|
|
58
|
+
* When true, requests the creative agent to include preview renders in the response alongside the manifest. Agents that support this return a 'preview' object in the response using the same structure as preview_creative. Agents that do not support inline preview simply omit the field. This avoids a separate preview_creative round trip for platforms that generate previews as a byproduct of building.
|
|
59
|
+
*/
|
|
60
|
+
include_preview?: boolean;
|
|
61
|
+
/**
|
|
62
|
+
* Input sets for preview generation when include_preview is true. Each input set defines macros and context values for one preview variant. If include_preview is true but this is omitted, the agent generates a single default preview. Only supported with target_format_id (single-format requests). Ignored when using target_format_ids — multi-format requests generate one default preview per format. Ignored when include_preview is false or omitted.
|
|
63
|
+
*/
|
|
64
|
+
preview_inputs?: {
|
|
65
|
+
/**
|
|
66
|
+
* Human-readable name for this input set (e.g., 'Sunny morning on mobile', 'Evening podcast ad')
|
|
67
|
+
*/
|
|
68
|
+
name: string;
|
|
69
|
+
/**
|
|
70
|
+
* Macro values to use for this preview variant
|
|
71
|
+
*/
|
|
72
|
+
macros?: {
|
|
73
|
+
[k: string]: string | undefined;
|
|
74
|
+
};
|
|
75
|
+
/**
|
|
76
|
+
* Natural language description of the context for AI-generated content
|
|
77
|
+
*/
|
|
78
|
+
context_description?: string;
|
|
79
|
+
}[];
|
|
80
|
+
preview_quality?: CreativeQuality;
|
|
81
|
+
preview_output_format?: PreviewOutputFormat;
|
|
82
|
+
/**
|
|
83
|
+
* Macro values to pre-substitute into the output manifest's assets. Keys are universal macro names (e.g., CLICK_URL, CACHEBUSTER); values are the substitution strings. The creative agent translates universal macros to its platform's native syntax. Substitution is literal — all occurrences of each macro in output assets are replaced with the provided value. The caller is responsible for URL-encoding values if the output context requires it. Macros not provided here remain as {MACRO} placeholders for the sales agent to resolve at serve time. Creative agents MUST ignore keys they do not recognize — unknown macro names are not an error.
|
|
84
|
+
*/
|
|
85
|
+
macro_values?: {
|
|
86
|
+
[k: string]: string | undefined;
|
|
87
|
+
};
|
|
88
|
+
/**
|
|
89
|
+
* Client-generated unique key for this request. Prevents duplicate creative generation on retries. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.
|
|
90
|
+
* @minLength 16
|
|
91
|
+
* @maxLength 255
|
|
92
|
+
* @pattern ^[A-Za-z0-9_.:-]{16,255}$
|
|
93
|
+
*/
|
|
94
|
+
idempotency_key: string;
|
|
95
|
+
context?: ContextObject;
|
|
96
|
+
ext?: ExtensionObject;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Response payload for build_creative. Exactly one of four shapes: (1) synchronous single-format success — creative_manifest issued in-line (target_format_id request); (2) synchronous multi-format success — creative_manifests issued in-line (target_format_ids request); (3) terminal failure — an errors array; (4) submitted task envelope — status 'submitted' with task_id when the build is queued (e.g., slow generative or multi-minute LLM pipeline). The submitted branch MAY carry advisory errors for non-blocking warnings; terminal failures belong in the error branch. These four shapes are mutually exclusive — a response has exactly one.
|
|
101
|
+
*/
|
|
102
|
+
export type BuildCreativeResponse = {
|
|
103
|
+
/**
|
|
104
|
+
* 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).
|
|
105
|
+
*/
|
|
106
|
+
context_id?: string;
|
|
107
|
+
context?: ContextObject;
|
|
108
|
+
/**
|
|
109
|
+
* Unique identifier for tracking asynchronous operations. Present when a task requires extended processing time. Used to query task status and retrieve results when complete.
|
|
110
|
+
*/
|
|
111
|
+
task_id?: string;
|
|
112
|
+
status: TaskStatus;
|
|
113
|
+
/**
|
|
114
|
+
* 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.
|
|
115
|
+
*/
|
|
116
|
+
message?: string;
|
|
117
|
+
/**
|
|
118
|
+
* ISO 8601 timestamp when the response was generated. Useful for debugging, logging, cache validation, and tracking async operation progress.
|
|
119
|
+
*/
|
|
120
|
+
timestamp?: string;
|
|
121
|
+
/**
|
|
122
|
+
* 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.
|
|
123
|
+
*/
|
|
124
|
+
replayed?: boolean;
|
|
125
|
+
adcp_error?: Error;
|
|
126
|
+
push_notification_config?: PushNotificationConfig;
|
|
127
|
+
/**
|
|
128
|
+
* 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.
|
|
129
|
+
*
|
|
130
|
+
* 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.
|
|
131
|
+
*
|
|
132
|
+
* This is the primary correlation key for audit and reporting across the governance lifecycle.
|
|
133
|
+
*/
|
|
134
|
+
governance_context?: string;
|
|
135
|
+
/**
|
|
136
|
+
* 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.
|
|
137
|
+
*/
|
|
138
|
+
payload?: {};
|
|
139
|
+
/**
|
|
140
|
+
* 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.
|
|
141
|
+
*/
|
|
142
|
+
adcp_version?: string;
|
|
143
|
+
/**
|
|
144
|
+
* 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.
|
|
145
|
+
*/
|
|
146
|
+
adcp_major_version?: number;
|
|
147
|
+
} & (BuildCreativeSuccess | BuildCreativeMultiSuccess | BuildCreativeError | BuildCreativeSubmitted);
|
|
148
|
+
|
|
149
|
+
/**
|
|
150
|
+
* Single-format success response. Returned when the request used target_format_id.
|
|
151
|
+
*/
|
|
152
|
+
export interface BuildCreativeSuccess {
|
|
153
|
+
creative_manifest: CreativeManifest;
|
|
154
|
+
/**
|
|
155
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
156
|
+
*/
|
|
157
|
+
sandbox?: boolean;
|
|
158
|
+
/**
|
|
159
|
+
* ISO 8601 timestamp when generated asset URLs in the manifest expire. Set to the earliest expiration across all generated assets. Re-build the creative after this time to get fresh URLs.
|
|
160
|
+
* @format date-time
|
|
161
|
+
*/
|
|
162
|
+
expires_at?: string;
|
|
163
|
+
/**
|
|
164
|
+
* Preview renders included when the request set include_preview to true and the agent supports it. Contains the same content fields as a preview_creative single response (previews, interactive_url, expires_at) minus the response_type discriminator, so clients can reuse the same preview rendering logic.
|
|
165
|
+
*/
|
|
166
|
+
preview?: {
|
|
167
|
+
/**
|
|
168
|
+
* Array of preview variants. Each preview corresponds to an input set from preview_inputs, or a single default preview if no inputs were provided.
|
|
169
|
+
*/
|
|
170
|
+
previews: {
|
|
171
|
+
/**
|
|
172
|
+
* Unique identifier for this preview variant
|
|
173
|
+
*/
|
|
174
|
+
preview_id: string;
|
|
175
|
+
/**
|
|
176
|
+
* Array of rendered pieces for this preview variant. Most formats render as a single piece. Companion ad formats render as multiple pieces.
|
|
177
|
+
*/
|
|
178
|
+
renders: PreviewRender[];
|
|
179
|
+
/**
|
|
180
|
+
* The input parameters that generated this preview variant. Echoes back the request input or shows defaults used.
|
|
181
|
+
*/
|
|
182
|
+
input: {
|
|
183
|
+
/**
|
|
184
|
+
* Human-readable name for this variant
|
|
185
|
+
*/
|
|
186
|
+
name: string;
|
|
187
|
+
/**
|
|
188
|
+
* Macro values applied to this variant
|
|
189
|
+
*/
|
|
190
|
+
macros?: {
|
|
191
|
+
[k: string]: string | undefined;
|
|
192
|
+
};
|
|
193
|
+
/**
|
|
194
|
+
* Context description applied to this variant
|
|
195
|
+
*/
|
|
196
|
+
context_description?: string;
|
|
197
|
+
};
|
|
198
|
+
}[];
|
|
199
|
+
/**
|
|
200
|
+
* Optional URL to an interactive testing page that shows all preview variants with controls to switch between them.
|
|
201
|
+
*/
|
|
202
|
+
interactive_url?: string;
|
|
203
|
+
/**
|
|
204
|
+
* ISO 8601 timestamp when preview URLs expire. May differ from the manifest's expires_at.
|
|
205
|
+
* @format date-time
|
|
206
|
+
*/
|
|
207
|
+
expires_at: string;
|
|
208
|
+
};
|
|
209
|
+
preview_error?: Error;
|
|
210
|
+
/**
|
|
211
|
+
* Which rate card pricing option was applied for this build. Present when the creative agent charges for its services. Pass this in report_usage to identify which pricing option was applied.
|
|
212
|
+
*/
|
|
213
|
+
pricing_option_id?: string;
|
|
214
|
+
/**
|
|
215
|
+
* Cost incurred for this build, denominated in currency. May be 0 for CPM-priced creatives where cost accrues at serve time rather than build time.
|
|
216
|
+
* @minimum 0
|
|
217
|
+
*/
|
|
218
|
+
vendor_cost?: number;
|
|
219
|
+
/**
|
|
220
|
+
* ISO 4217 currency code for vendor_cost.
|
|
221
|
+
* @pattern ^[A-Z]{3}$
|
|
222
|
+
*/
|
|
223
|
+
currency?: string;
|
|
224
|
+
consumption?: CreativeConsumption;
|
|
225
|
+
context?: ContextObject;
|
|
226
|
+
ext?: ExtensionObject;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Error response — creative generation failed. Multi-format requests (`target_format_ids[]`) are atomic per `BuildCreativeMultiSuccess` semantics: a single format failing means the entire batch returns an error response, not a partial success. Buyers diagnose per-format failures by reading the `errors[]` array's per-format attribution (see the `errors` field description).
|
|
231
|
+
*/
|
|
232
|
+
export interface BuildCreativeError {
|
|
233
|
+
/**
|
|
234
|
+
* Array of errors explaining why creative generation failed.
|
|
235
|
+
*
|
|
236
|
+
* **Per-format attribution on multi-format requests.** When the request used `target_format_ids[]` (a batch request), sellers MUST attribute each failure to the specific format(s) that caused it so buyers can correct and retry the failing subset rather than re-running the entire batch. Two attribution surfaces, populated together:
|
|
237
|
+
*
|
|
238
|
+
* 1. **`error.field`** — set to `target_format_ids[N]` where `N` is the zero-based index of the failing format in the request's `target_format_ids[]` array (e.g., `target_format_ids[1]` for the second requested format). Mirrors the JSONPath-lite convention `error.field` uses elsewhere. Required when the error is format-scoped.
|
|
239
|
+
* 2. **`error.details.format_id`** — the resolved `format_id` value (e.g., `"meta-reels-9x16"`). Required when the error is format-scoped. Lets buyers dispatch on the format identity without re-parsing `error.field`.
|
|
240
|
+
*
|
|
241
|
+
* Errors not attributable to a specific format (whole-batch failures: authentication, governance denial, transport-level errors) MAY omit `field` and `details.format_id`. Buyers MUST treat per-format errors as scoped to the named format only — a `correctable` error on `target_format_ids[1]` does NOT mean the buyer must reshape the entire batch; they may retry just that format with corrected input. Sellers SHOULD emit one error per failing format (rather than collapsing multiple format failures into a single error entry) so per-format recovery routing is unambiguous.
|
|
242
|
+
*/
|
|
243
|
+
errors: Error[];
|
|
244
|
+
context?: ContextObject;
|
|
245
|
+
ext?: ExtensionObject;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Async task envelope returned when build_creative cannot be confirmed before the response — for example, when a slow generative pipeline or multi-minute LLM workflow is queued. The buyer polls tasks/get with task_id or receives a webhook when the task completes; the creative_manifest(s) land on the completion artifact, not this envelope.
|
|
250
|
+
*/
|
|
251
|
+
export interface BuildCreativeSubmitted {
|
|
252
|
+
/**
|
|
253
|
+
* Task-level status literal. Discriminates this async envelope from the synchronous success shapes, whose creative_manifest or creative_manifests are issued in-line. See task-status.json for the full task-status enum.
|
|
254
|
+
*/
|
|
255
|
+
status: 'submitted';
|
|
256
|
+
/**
|
|
257
|
+
* Task handle the buyer uses with tasks/get, and that the seller references on push-notification callbacks. 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.
|
|
258
|
+
*/
|
|
259
|
+
task_id: string;
|
|
260
|
+
/**
|
|
261
|
+
* Optional human-readable explanation of why the task is submitted — e.g., 'Generative build queued; typical turnaround 3–5 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.
|
|
262
|
+
* @maxLength 2000
|
|
263
|
+
*/
|
|
264
|
+
message?: string;
|
|
265
|
+
/**
|
|
266
|
+
* 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.
|
|
267
|
+
*/
|
|
268
|
+
errors?: Error[];
|
|
269
|
+
context?: ContextObject;
|
|
270
|
+
ext?: ExtensionObject;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Account for product lookup. Returns products with pricing specific to this account's rate card.
|
|
275
|
+
*/
|
|
276
|
+
export type AccountReference = {
|
|
277
|
+
/**
|
|
278
|
+
* Seller-assigned account identifier (from sync_accounts or list_accounts)
|
|
279
|
+
*/
|
|
280
|
+
account_id: string;
|
|
281
|
+
} | {
|
|
282
|
+
brand: BrandReference;
|
|
283
|
+
/**
|
|
284
|
+
* Domain of the entity operating on the brand's behalf. When the brand operates directly, this is the brand's domain.
|
|
285
|
+
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
286
|
+
*/
|
|
287
|
+
operator: string;
|
|
288
|
+
/**
|
|
289
|
+
* When true, references the sandbox account for this brand/operator pair. Defaults to false (production account).
|
|
290
|
+
*/
|
|
291
|
+
sandbox?: boolean;
|
|
292
|
+
};
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* 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.
|
|
296
|
+
*/
|
|
297
|
+
export type AssetVariant = ImageAsset | VideoAsset | AudioAsset | VASTAsset | TextAsset | URLAsset | HTMLAsset | JavaScriptAsset | ZipAsset | WebhookAsset | CSSAsset | DAASTAsset | MarkdownAsset | BriefAsset | CatalogAsset | CardAsset;
|
|
298
|
+
|
|
299
|
+
/**
|
|
300
|
+
* Audio asset with URL and technical specifications
|
|
301
|
+
*/
|
|
302
|
+
export interface AudioAsset {
|
|
303
|
+
/**
|
|
304
|
+
* Discriminator identifying this as an audio asset. See /schemas/creative/asset-types for the registry.
|
|
305
|
+
*/
|
|
306
|
+
asset_type: 'audio';
|
|
307
|
+
/**
|
|
308
|
+
* URL to the audio asset
|
|
309
|
+
*/
|
|
310
|
+
url: string;
|
|
311
|
+
/**
|
|
312
|
+
* Audio duration in milliseconds
|
|
313
|
+
* @minimum 0
|
|
314
|
+
*/
|
|
315
|
+
duration_ms?: number;
|
|
316
|
+
/**
|
|
317
|
+
* File size in bytes
|
|
318
|
+
* @minimum 1
|
|
319
|
+
*/
|
|
320
|
+
file_size_bytes?: number;
|
|
321
|
+
/**
|
|
322
|
+
* Audio container/file format (mp3, m4a, aac, wav, ogg, flac, etc.)
|
|
323
|
+
*/
|
|
324
|
+
container_format?: string;
|
|
325
|
+
/**
|
|
326
|
+
* Audio codec used (aac, aac_lc, he_aac, pcm, mp3, vorbis, opus, flac, ac3, eac3, etc.)
|
|
327
|
+
*/
|
|
328
|
+
codec?: string;
|
|
329
|
+
/**
|
|
330
|
+
* Sampling rate in Hz (e.g., 44100, 48000, 96000)
|
|
331
|
+
*/
|
|
332
|
+
sampling_rate_hz?: number;
|
|
333
|
+
channels?: AudioChannelLayout;
|
|
334
|
+
/**
|
|
335
|
+
* Bit depth
|
|
336
|
+
*/
|
|
337
|
+
bit_depth?: 16 | 24 | 32;
|
|
338
|
+
/**
|
|
339
|
+
* Bitrate in kilobits per second
|
|
340
|
+
* @minimum 1
|
|
341
|
+
*/
|
|
342
|
+
bitrate_kbps?: number;
|
|
343
|
+
/**
|
|
344
|
+
* Integrated loudness in LUFS
|
|
345
|
+
*/
|
|
346
|
+
loudness_lufs?: number;
|
|
347
|
+
/**
|
|
348
|
+
* True peak level in dBFS
|
|
349
|
+
*/
|
|
350
|
+
true_peak_dbfs?: number;
|
|
351
|
+
/**
|
|
352
|
+
* URL to text transcript of the audio content
|
|
353
|
+
*/
|
|
354
|
+
transcript_url?: string;
|
|
355
|
+
provenance?: Provenance;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* Audio channel configuration
|
|
360
|
+
*/
|
|
361
|
+
export type AudioChannelLayout = 'mono' | 'stereo' | '5.1' | '7.1';
|
|
362
|
+
|
|
363
|
+
/**
|
|
364
|
+
* 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.
|
|
365
|
+
*/
|
|
366
|
+
export type AuthenticationScheme = 'Bearer' | 'HMAC-SHA256';
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* Brand identifier within the house portfolio. Optional for single-brand domains.
|
|
370
|
+
*/
|
|
371
|
+
export type BrandID = string;
|
|
372
|
+
|
|
373
|
+
/**
|
|
374
|
+
* Brand reference for product discovery context. Resolved to full brand identity at execution time.
|
|
375
|
+
*/
|
|
376
|
+
export interface BrandReference {
|
|
377
|
+
/**
|
|
378
|
+
* Domain where /.well-known/brand.json is hosted, or the brand's operating domain
|
|
379
|
+
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
380
|
+
*/
|
|
381
|
+
domain: string;
|
|
382
|
+
brand_id?: BrandID;
|
|
383
|
+
/**
|
|
384
|
+
* 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.
|
|
385
|
+
*/
|
|
386
|
+
industries?: string[];
|
|
387
|
+
/**
|
|
388
|
+
* 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.
|
|
389
|
+
*/
|
|
390
|
+
data_subject_contestation?: {
|
|
391
|
+
[k: string]: unknown | undefined;
|
|
392
|
+
};
|
|
393
|
+
/**
|
|
394
|
+
* 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.
|
|
395
|
+
*
|
|
396
|
+
* **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.
|
|
397
|
+
*/
|
|
398
|
+
brand_kit_override?: {
|
|
399
|
+
logo?: ImageAsset;
|
|
400
|
+
/**
|
|
401
|
+
* Override brand colors (hex strings).
|
|
402
|
+
*/
|
|
403
|
+
colors?: {
|
|
404
|
+
/**
|
|
405
|
+
* @pattern ^#[0-9a-fA-F]{6}$
|
|
406
|
+
*/
|
|
407
|
+
primary?: string;
|
|
408
|
+
/**
|
|
409
|
+
* @pattern ^#[0-9a-fA-F]{6}$
|
|
410
|
+
*/
|
|
411
|
+
secondary?: string;
|
|
412
|
+
/**
|
|
413
|
+
* @pattern ^#[0-9a-fA-F]{6}$
|
|
414
|
+
*/
|
|
415
|
+
accent?: string;
|
|
416
|
+
};
|
|
417
|
+
/**
|
|
418
|
+
* Override brand-voice description for surface-composed text/audio output.
|
|
419
|
+
*/
|
|
420
|
+
voice?: string;
|
|
421
|
+
/**
|
|
422
|
+
* Override tagline.
|
|
423
|
+
*/
|
|
424
|
+
tagline?: string;
|
|
425
|
+
};
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* 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.
|
|
430
|
+
*/
|
|
431
|
+
export interface BriefAsset {
|
|
432
|
+
/**
|
|
433
|
+
* Campaign or flight name for identification
|
|
434
|
+
*/
|
|
435
|
+
name: string;
|
|
436
|
+
/**
|
|
437
|
+
* Campaign objective that guides creative tone and call-to-action strategy
|
|
438
|
+
*/
|
|
439
|
+
objective?: 'awareness' | 'consideration' | 'conversion' | 'retention' | 'engagement';
|
|
440
|
+
/**
|
|
441
|
+
* Desired tone for this campaign, modulating the brand's base tone (e.g., 'playful and festive', 'premium and aspirational')
|
|
442
|
+
*/
|
|
443
|
+
tone?: string;
|
|
444
|
+
/**
|
|
445
|
+
* Target audience description for this campaign
|
|
446
|
+
*/
|
|
447
|
+
audience?: string;
|
|
448
|
+
/**
|
|
449
|
+
* Creative territory or positioning the campaign should occupy
|
|
450
|
+
*/
|
|
451
|
+
territory?: string;
|
|
452
|
+
/**
|
|
453
|
+
* Messaging framework for the campaign
|
|
454
|
+
*/
|
|
455
|
+
messaging?: {
|
|
456
|
+
/**
|
|
457
|
+
* Primary headline
|
|
458
|
+
*/
|
|
459
|
+
headline?: string;
|
|
460
|
+
/**
|
|
461
|
+
* Supporting tagline or sub-headline
|
|
462
|
+
*/
|
|
463
|
+
tagline?: string;
|
|
464
|
+
/**
|
|
465
|
+
* Call-to-action text
|
|
466
|
+
*/
|
|
467
|
+
cta?: string;
|
|
468
|
+
/**
|
|
469
|
+
* Key messages to communicate in priority order
|
|
470
|
+
*/
|
|
471
|
+
key_messages?: string[];
|
|
472
|
+
};
|
|
473
|
+
/**
|
|
474
|
+
* Visual and strategic reference materials such as mood boards, product shots, example creatives, and strategy documents
|
|
475
|
+
*/
|
|
476
|
+
reference_assets?: ReferenceAsset[];
|
|
477
|
+
/**
|
|
478
|
+
* Regulatory and legal compliance requirements for this campaign. Campaign-specific, regional, and product-based — distinct from brand-level disclaimers in brand.json.
|
|
479
|
+
*/
|
|
480
|
+
compliance?: {
|
|
481
|
+
/**
|
|
482
|
+
* Disclosures that must appear in creatives for this campaign. Each disclosure specifies the text, where it should appear, and which jurisdictions require it.
|
|
483
|
+
*/
|
|
484
|
+
required_disclosures?: {
|
|
485
|
+
/**
|
|
486
|
+
* The disclosure text that must appear in the creative
|
|
487
|
+
*/
|
|
488
|
+
text: string;
|
|
489
|
+
position?: DisclosurePosition;
|
|
490
|
+
/**
|
|
491
|
+
* 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.
|
|
492
|
+
*/
|
|
493
|
+
jurisdictions?: string[];
|
|
494
|
+
/**
|
|
495
|
+
* The regulation or legal authority requiring this disclosure (e.g., 'SEC Rule 156', 'FCA COBS 4.5', 'FDA 21 CFR 202')
|
|
496
|
+
*/
|
|
497
|
+
regulation?: string;
|
|
498
|
+
/**
|
|
499
|
+
* 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.
|
|
500
|
+
*/
|
|
501
|
+
min_duration_ms?: number;
|
|
502
|
+
/**
|
|
503
|
+
* 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.
|
|
504
|
+
*/
|
|
505
|
+
language?: string;
|
|
506
|
+
persistence?: DisclosurePersistence;
|
|
507
|
+
}[];
|
|
508
|
+
/**
|
|
509
|
+
* Claims that must not appear in creatives for this campaign. Creative agents should ensure generated content avoids these claims.
|
|
510
|
+
*/
|
|
511
|
+
prohibited_claims?: string[];
|
|
512
|
+
};
|
|
513
|
+
/**
|
|
514
|
+
* Discriminator identifying this as a brief asset. See /schemas/creative/asset-types for the registry.
|
|
515
|
+
*/
|
|
516
|
+
asset_type: 'brief';
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
/**
|
|
520
|
+
* Multi-format success response. Returned when the request used target_format_ids. Contains one manifest per requested format. Multi-format requests are atomic — all formats must succeed or the entire request fails with an error response. Array order corresponds to the target_format_ids request order.
|
|
521
|
+
*/
|
|
522
|
+
export interface BuildCreativeMultiSuccess {
|
|
523
|
+
/**
|
|
524
|
+
* Array of generated creative manifests, one per requested format. Each manifest contains its own format_id identifying which format it was generated for.
|
|
525
|
+
*/
|
|
526
|
+
creative_manifests: CreativeManifest[];
|
|
527
|
+
/**
|
|
528
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
529
|
+
*/
|
|
530
|
+
sandbox?: boolean;
|
|
531
|
+
/**
|
|
532
|
+
* ISO 8601 timestamp when the earliest generated asset URL expires across all manifests. Re-build after this time to get fresh URLs.
|
|
533
|
+
* @format date-time
|
|
534
|
+
*/
|
|
535
|
+
expires_at?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Preview renders included when the request set include_preview to true and the agent supports it. Contains one default preview per requested format. preview_inputs is ignored for multi-format requests.
|
|
538
|
+
*/
|
|
539
|
+
preview?: {
|
|
540
|
+
/**
|
|
541
|
+
* Array of preview entries, one per requested format. Array order matches creative_manifests. Each entry includes a format_id for explicit correlation.
|
|
542
|
+
*/
|
|
543
|
+
previews: {
|
|
544
|
+
/**
|
|
545
|
+
* Unique identifier for this preview
|
|
546
|
+
*/
|
|
547
|
+
preview_id: string;
|
|
548
|
+
format_id: FormatReferenceStructuredObject;
|
|
549
|
+
/**
|
|
550
|
+
* Array of rendered pieces for this format's preview. Most formats render as a single piece. Companion ad formats render as multiple pieces.
|
|
551
|
+
*/
|
|
552
|
+
renders: PreviewRender[];
|
|
553
|
+
/**
|
|
554
|
+
* The input parameters that generated this preview. For multi-format responses, this is always a default input.
|
|
555
|
+
*/
|
|
556
|
+
input: {
|
|
557
|
+
/**
|
|
558
|
+
* Human-readable name for this preview
|
|
559
|
+
*/
|
|
560
|
+
name: string;
|
|
561
|
+
/**
|
|
562
|
+
* Macro values applied to this preview
|
|
563
|
+
*/
|
|
564
|
+
macros?: {
|
|
565
|
+
[k: string]: string | undefined;
|
|
566
|
+
};
|
|
567
|
+
/**
|
|
568
|
+
* Context description applied to this preview
|
|
569
|
+
*/
|
|
570
|
+
context_description?: string;
|
|
571
|
+
};
|
|
572
|
+
}[];
|
|
573
|
+
/**
|
|
574
|
+
* Optional URL to an interactive testing page that shows all format previews with controls to switch between them.
|
|
575
|
+
*/
|
|
576
|
+
interactive_url?: string;
|
|
577
|
+
/**
|
|
578
|
+
* ISO 8601 timestamp when preview URLs expire. May differ from the manifest's expires_at.
|
|
579
|
+
* @format date-time
|
|
580
|
+
*/
|
|
581
|
+
expires_at: string;
|
|
582
|
+
};
|
|
583
|
+
preview_error?: Error;
|
|
584
|
+
/**
|
|
585
|
+
* Which rate card pricing option was applied for this build. Represents the total cost of the entire multi-format build call. Present when the creative agent charges for its services.
|
|
586
|
+
*/
|
|
587
|
+
pricing_option_id?: string;
|
|
588
|
+
/**
|
|
589
|
+
* Total cost incurred for this multi-format build, denominated in currency. May be 0 for CPM-priced creatives where cost accrues at serve time.
|
|
590
|
+
* @minimum 0
|
|
591
|
+
*/
|
|
592
|
+
vendor_cost?: number;
|
|
593
|
+
/**
|
|
594
|
+
* ISO 4217 currency code for vendor_cost.
|
|
595
|
+
* @pattern ^[A-Z]{3}$
|
|
596
|
+
*/
|
|
597
|
+
currency?: string;
|
|
598
|
+
consumption?: CreativeConsumption;
|
|
599
|
+
context?: ContextObject;
|
|
600
|
+
ext?: ExtensionObject;
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
/**
|
|
604
|
+
* C2PA action classification for this watermark
|
|
605
|
+
*/
|
|
606
|
+
export type C2PAWatermarkAction = 'c2pa.watermarked.bound' | 'c2pa.watermarked.unbound';
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* CSS stylesheet asset
|
|
610
|
+
*/
|
|
611
|
+
export interface CSSAsset {
|
|
612
|
+
/**
|
|
613
|
+
* Discriminator identifying this as a CSS asset. See /schemas/creative/asset-types for the registry.
|
|
614
|
+
*/
|
|
615
|
+
asset_type: 'css';
|
|
616
|
+
/**
|
|
617
|
+
* CSS content
|
|
618
|
+
*/
|
|
619
|
+
content: string;
|
|
620
|
+
/**
|
|
621
|
+
* CSS media query context (e.g., 'screen', 'print')
|
|
622
|
+
*/
|
|
623
|
+
media?: string;
|
|
624
|
+
provenance?: Provenance;
|
|
625
|
+
}
|
|
626
|
+
|
|
627
|
+
/**
|
|
628
|
+
* 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`).
|
|
629
|
+
*/
|
|
630
|
+
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';
|
|
631
|
+
|
|
632
|
+
/**
|
|
633
|
+
* 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"`).
|
|
634
|
+
*
|
|
635
|
+
* 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`.
|
|
636
|
+
*
|
|
637
|
+
* 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.
|
|
638
|
+
*/
|
|
639
|
+
export interface CardAsset {
|
|
640
|
+
/**
|
|
641
|
+
* Discriminator identifying this as a card asset. See /schemas/creative/asset-types for the registry.
|
|
642
|
+
*/
|
|
643
|
+
asset_type: 'card';
|
|
644
|
+
/**
|
|
645
|
+
* The card's primary visual asset. Either an `image` or `video` asset, matching the parent format's `allowed_card_media_asset_types` parameter.
|
|
646
|
+
*/
|
|
647
|
+
media: ImageAsset | VideoAsset;
|
|
648
|
+
/**
|
|
649
|
+
* 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.
|
|
650
|
+
*/
|
|
651
|
+
headline?: string;
|
|
652
|
+
/**
|
|
653
|
+
* 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.
|
|
654
|
+
*/
|
|
655
|
+
description?: string;
|
|
656
|
+
/**
|
|
657
|
+
* 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.
|
|
658
|
+
*/
|
|
659
|
+
cta?: string;
|
|
660
|
+
landing_page_url?: URLAsset;
|
|
661
|
+
/**
|
|
662
|
+
* 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.
|
|
663
|
+
*/
|
|
664
|
+
platform_extensions?: PlatformExtensionReference[];
|
|
665
|
+
provenance?: Provenance;
|
|
666
|
+
}
|
|
667
|
+
|
|
668
|
+
/**
|
|
669
|
+
* A typed data feed as a creative asset. Carries catalog context (products, stores, jobs, etc.) within the manifest's assets map.
|
|
670
|
+
*/
|
|
671
|
+
export interface CatalogAsset {
|
|
672
|
+
/**
|
|
673
|
+
* Buyer's identifier for this catalog. Required when syncing via sync_catalogs. When used in creatives, references a previously synced catalog on the account.
|
|
674
|
+
*/
|
|
675
|
+
catalog_id?: string;
|
|
676
|
+
/**
|
|
677
|
+
* Human-readable name for this catalog (e.g., 'Summer Products 2025', 'Amsterdam Store Locations').
|
|
678
|
+
*/
|
|
679
|
+
name?: string;
|
|
680
|
+
type: CatalogType;
|
|
681
|
+
/**
|
|
682
|
+
* 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.
|
|
683
|
+
*/
|
|
684
|
+
url?: string;
|
|
685
|
+
feed_format?: FeedFormat;
|
|
686
|
+
update_frequency?: UpdateFrequency;
|
|
687
|
+
/**
|
|
688
|
+
* 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.
|
|
689
|
+
*/
|
|
690
|
+
items?: {}[];
|
|
691
|
+
/**
|
|
692
|
+
* Filter catalog to specific item IDs. For offering-type catalogs, these are offering_id values. For product-type catalogs, these are SKU identifiers.
|
|
693
|
+
*/
|
|
694
|
+
ids?: string[];
|
|
695
|
+
/**
|
|
696
|
+
* 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'.
|
|
697
|
+
*/
|
|
698
|
+
gtins?: string[];
|
|
699
|
+
/**
|
|
700
|
+
* Filter catalog to items with these tags. Tags are matched using OR logic — items matching any tag are included.
|
|
701
|
+
*/
|
|
702
|
+
tags?: string[];
|
|
703
|
+
/**
|
|
704
|
+
* Filter catalog to items in this category (e.g., 'beverages/soft-drinks', 'chef-positions').
|
|
705
|
+
*/
|
|
706
|
+
category?: string;
|
|
707
|
+
/**
|
|
708
|
+
* Natural language filter for catalog items (e.g., 'all pasta sauces under $5', 'amsterdam vacancies').
|
|
709
|
+
*/
|
|
710
|
+
query?: string;
|
|
711
|
+
/**
|
|
712
|
+
* 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.
|
|
713
|
+
*/
|
|
714
|
+
conversion_events?: EventType[];
|
|
715
|
+
content_id_type?: ContentIDType;
|
|
716
|
+
/**
|
|
717
|
+
* 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.
|
|
718
|
+
*/
|
|
719
|
+
feed_field_mappings?: CatalogFieldMapping[];
|
|
720
|
+
/**
|
|
721
|
+
* Discriminator identifying this as a catalog asset. See /schemas/creative/asset-types for the registry.
|
|
722
|
+
*/
|
|
723
|
+
asset_type: 'catalog';
|
|
724
|
+
}
|
|
725
|
+
|
|
726
|
+
/**
|
|
727
|
+
* 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).
|
|
728
|
+
*/
|
|
729
|
+
export interface CatalogFieldMapping {
|
|
730
|
+
/**
|
|
731
|
+
* Field name in the external feed record. Omit when injecting a static literal value (use the value property instead).
|
|
732
|
+
*/
|
|
733
|
+
feed_field?: string;
|
|
734
|
+
/**
|
|
735
|
+
* 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.
|
|
736
|
+
*/
|
|
737
|
+
catalog_field?: string;
|
|
738
|
+
/**
|
|
739
|
+
* 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.
|
|
740
|
+
*/
|
|
741
|
+
asset_group_id?: string;
|
|
742
|
+
/**
|
|
743
|
+
* 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).
|
|
744
|
+
*/
|
|
745
|
+
value?: unknown;
|
|
746
|
+
/**
|
|
747
|
+
* Named transform to apply to the feed field value before writing to the catalog schema. See transform-specific parameters (format, timezone, by, separator).
|
|
748
|
+
*/
|
|
749
|
+
transform?: 'date' | 'divide' | 'boolean' | 'split';
|
|
750
|
+
/**
|
|
751
|
+
* 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.
|
|
752
|
+
*/
|
|
753
|
+
format?: string;
|
|
754
|
+
/**
|
|
755
|
+
* 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.
|
|
756
|
+
*/
|
|
757
|
+
timezone?: string;
|
|
758
|
+
/**
|
|
759
|
+
* For transform 'divide': the divisor to apply (e.g., 100 to convert integer cents to decimal dollars).
|
|
760
|
+
*/
|
|
761
|
+
by?: number;
|
|
762
|
+
/**
|
|
763
|
+
* For transform 'split': the separator character or string to split on. Defaults to ','.
|
|
764
|
+
*/
|
|
765
|
+
separator?: string;
|
|
766
|
+
/**
|
|
767
|
+
* 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.
|
|
768
|
+
*/
|
|
769
|
+
default?: unknown;
|
|
770
|
+
ext?: ExtensionObject;
|
|
771
|
+
}
|
|
772
|
+
|
|
773
|
+
/**
|
|
774
|
+
* 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.
|
|
775
|
+
*/
|
|
776
|
+
export type CatalogType = 'offering' | 'product' | 'inventory' | 'store' | 'promotion' | 'hotel' | 'flight' | 'job' | 'vehicle' | 'real_estate' | 'education' | 'destination' | 'app';
|
|
777
|
+
|
|
778
|
+
/**
|
|
779
|
+
* 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.
|
|
780
|
+
*/
|
|
781
|
+
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';
|
|
782
|
+
|
|
783
|
+
/**
|
|
784
|
+
* 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.
|
|
785
|
+
*/
|
|
786
|
+
export interface ContextObject {
|
|
787
|
+
}
|
|
788
|
+
|
|
789
|
+
/**
|
|
790
|
+
* Structured consumption details for this build. Informational — lets the buyer verify that vendor_cost is consistent with the rate card. vendor_cost is the billing source of truth.
|
|
791
|
+
*/
|
|
792
|
+
export interface CreativeConsumption {
|
|
793
|
+
/**
|
|
794
|
+
* LLM or generation tokens consumed during creative generation.
|
|
795
|
+
* @minimum 0
|
|
796
|
+
*/
|
|
797
|
+
tokens?: number;
|
|
798
|
+
/**
|
|
799
|
+
* Number of images produced during generation.
|
|
800
|
+
* @minimum 0
|
|
801
|
+
*/
|
|
802
|
+
images_generated?: number;
|
|
803
|
+
/**
|
|
804
|
+
* Number of render passes performed (video, animation).
|
|
805
|
+
* @minimum 0
|
|
806
|
+
*/
|
|
807
|
+
renders?: number;
|
|
808
|
+
/**
|
|
809
|
+
* Processing time billed, in seconds. For compute-time pricing models.
|
|
810
|
+
* @minimum 0
|
|
811
|
+
*/
|
|
812
|
+
duration_seconds?: number;
|
|
813
|
+
}
|
|
814
|
+
|
|
815
|
+
/**
|
|
816
|
+
* 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.
|
|
817
|
+
*/
|
|
818
|
+
export type CreativeIdentifierType = 'ad_id' | 'isci' | 'clearcast_clock';
|
|
819
|
+
|
|
820
|
+
/**
|
|
821
|
+
* Creative manifest to transform or generate from. For pure generation, this should include the target format_id and any required input assets. For transformation (e.g., resizing, reformatting), this is the complete creative to adapt. When creative_id is provided, the agent resolves the creative from its library and this field is ignored.
|
|
822
|
+
*/
|
|
823
|
+
export type CreativeManifest = {
|
|
824
|
+
format_id?: FormatReferenceStructuredObject;
|
|
825
|
+
format_kind?: CanonicalFormatKind;
|
|
826
|
+
/**
|
|
827
|
+
* v2 path, optional. Stable identifier matching one of the seller's product `format_options[i].capability_id` values. REQUIRED when the target product carries multiple `format_options` entries sharing the same `format_kind` (the buyer must disambiguate which option this manifest matches). When the product's `format_options` has a single entry — or multiple entries with distinct `format_kind` values — `capability_id` is OPTIONAL because `format_kind` alone routes the manifest to the right declaration.
|
|
828
|
+
*/
|
|
829
|
+
capability_id?: string;
|
|
830
|
+
/**
|
|
831
|
+
* Map of slot keys to actual asset content. v1 path: each key matches an `asset_id` from the format's `assets` array (e.g., 'banner_image', 'clickthrough_url', 'video_file', 'vast_tag'). v2 path: each key matches an `asset_group_id` from the format's `slots` declaration drawn from the canonical vocabulary registry (e.g., 'images_landscape', 'video', 'landing_page_url', 'vast_tag', 'script', 'creative_brief'). Either path produces the same envelope shape; only the slot-key vocabulary differs.
|
|
832
|
+
*
|
|
833
|
+
* Each slot value is **either** a single asset object (most slots — image, video, vast_tag, landing_page_url, etc.) **or** an array of asset objects (slots with `min`/`max` counts on the format declaration — `cards` on `image_carousel`, `headlines` / `descriptions` / `images_landscape` on `responsive_creative`, etc.). Single-vs-array shape is governed by the format's `slots[].min` and `slots[].max` parameters: when `max > 1` (or when the slot is conceptually a pool), the value MUST be an array; when the slot is single-valued, the value MUST be a single object. Each asset value (single or array element) carries an `asset_type` discriminator (image, video, audio, vast, daast, text, markdown, url, html, css, webhook, javascript, brief, catalog, zip, card) that selects the matching asset schema. Validators with OpenAPI-style discriminator support use `asset_type` to report errors against only the selected branch instead of all branches.
|
|
834
|
+
*/
|
|
835
|
+
assets: {
|
|
836
|
+
/**
|
|
837
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
838
|
+
* via the `patternProperty` "^[a-z0-9_]+$".
|
|
839
|
+
*/
|
|
840
|
+
[k: string]: AssetVariant | AssetVariant[];
|
|
841
|
+
};
|
|
842
|
+
brand?: BrandReference;
|
|
843
|
+
/**
|
|
844
|
+
* Rights constraints attached to this creative. Each entry represents constraints from a single rights holder. A creative may combine multiple rights constraints (e.g., talent likeness + music license). For v1, rights constraints are informational metadata — the buyer/orchestrator manages creative lifecycle against these terms.
|
|
845
|
+
*/
|
|
846
|
+
rights?: RightsConstraint[];
|
|
847
|
+
/**
|
|
848
|
+
* Industry-standard identifiers for this specific manifest (e.g., Ad-ID, ISCI, Clearcast clock number). When present, overrides creative-level identifiers. Use when different format versions of the same source creative have distinct Ad-IDs (e.g., the :15 and :30 cuts).
|
|
849
|
+
*/
|
|
850
|
+
industry_identifiers?: IndustryIdentifier[];
|
|
851
|
+
provenance?: Provenance;
|
|
852
|
+
ext?: ExtensionObject;
|
|
853
|
+
} & (V1ManifestNamedFormatReference | V2ManifestCanonicalFormatKind);
|
|
854
|
+
|
|
855
|
+
/**
|
|
856
|
+
* Quality tier for generation. 'draft' produces fast, lower-fidelity output for iteration and review. 'production' produces full-quality output for final delivery. If omitted, the creative agent uses its own default. For non-generative transforms (e.g., format resizing), creative agents MAY ignore this field.
|
|
857
|
+
*/
|
|
858
|
+
export type CreativeQuality = 'draft' | 'production';
|
|
859
|
+
|
|
860
|
+
/**
|
|
861
|
+
* DAAST (Digital Audio Ad Serving Template) tag for third-party audio ad serving
|
|
862
|
+
*/
|
|
863
|
+
export type DAASTAsset = {
|
|
864
|
+
/**
|
|
865
|
+
* Discriminator identifying this as a DAAST asset. See /schemas/creative/asset-types for the registry.
|
|
866
|
+
*/
|
|
867
|
+
asset_type: 'daast';
|
|
868
|
+
daast_version?: DAASTVersion;
|
|
869
|
+
/**
|
|
870
|
+
* Expected audio duration in milliseconds (if known)
|
|
871
|
+
* @minimum 0
|
|
872
|
+
*/
|
|
873
|
+
duration_ms?: number;
|
|
874
|
+
/**
|
|
875
|
+
* Tracking events supported by this DAAST tag
|
|
876
|
+
*/
|
|
877
|
+
tracking_events?: DAASTTrackingEvent[];
|
|
878
|
+
/**
|
|
879
|
+
* Whether companion display ads are included
|
|
880
|
+
*/
|
|
881
|
+
companion_ads?: boolean;
|
|
882
|
+
/**
|
|
883
|
+
* URL to text transcript of the audio content
|
|
884
|
+
*/
|
|
885
|
+
transcript_url?: string;
|
|
886
|
+
provenance?: Provenance;
|
|
887
|
+
} & ({
|
|
888
|
+
/**
|
|
889
|
+
* Discriminator indicating DAAST is delivered via URL endpoint
|
|
890
|
+
*/
|
|
891
|
+
delivery_type: 'url';
|
|
892
|
+
/**
|
|
893
|
+
* URL endpoint that returns DAAST XML
|
|
894
|
+
*/
|
|
895
|
+
url: string;
|
|
896
|
+
} | {
|
|
897
|
+
/**
|
|
898
|
+
* Discriminator indicating DAAST is delivered as inline XML content
|
|
899
|
+
*/
|
|
900
|
+
delivery_type: 'inline';
|
|
901
|
+
/**
|
|
902
|
+
* Inline DAAST XML content
|
|
903
|
+
*/
|
|
904
|
+
content: string;
|
|
905
|
+
});
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* 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`.
|
|
909
|
+
*/
|
|
910
|
+
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';
|
|
911
|
+
|
|
912
|
+
/**
|
|
913
|
+
* DAAST specification version
|
|
914
|
+
*/
|
|
915
|
+
export type DAASTVersion = '1.0' | '1.1';
|
|
916
|
+
|
|
917
|
+
/**
|
|
918
|
+
* IPTC-aligned classification of AI involvement in producing this content
|
|
919
|
+
*/
|
|
920
|
+
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';
|
|
921
|
+
|
|
922
|
+
/**
|
|
923
|
+
* How long the disclosure must persist during content playback or display
|
|
924
|
+
*/
|
|
925
|
+
export type DisclosurePersistence = 'continuous' | 'initial' | 'flexible';
|
|
926
|
+
|
|
927
|
+
/**
|
|
928
|
+
* 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.
|
|
929
|
+
*/
|
|
930
|
+
export type DisclosurePosition = 'prominent' | 'footer' | 'audio' | 'subtitle' | 'overlay' | 'end_card' | 'pre_roll' | 'companion';
|
|
931
|
+
|
|
932
|
+
/**
|
|
933
|
+
* How provenance data is carried within the content
|
|
934
|
+
*/
|
|
935
|
+
export type EmbeddedProvenanceMethod = 'manifest_wrapper' | 'provenance_markers';
|
|
936
|
+
|
|
937
|
+
/**
|
|
938
|
+
* Standard marketing event types for event logging, aligned with IAB ECAPI
|
|
939
|
+
*/
|
|
940
|
+
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';
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* 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.
|
|
944
|
+
*/
|
|
945
|
+
export interface ExtensionObject {
|
|
946
|
+
}
|
|
947
|
+
|
|
948
|
+
/**
|
|
949
|
+
* 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.
|
|
950
|
+
*/
|
|
951
|
+
export type FeedFormat = 'google_merchant_center' | 'facebook_catalog' | 'shopify' | 'linkedin_jobs' | 'custom';
|
|
952
|
+
|
|
953
|
+
/**
|
|
954
|
+
* 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.
|
|
955
|
+
*/
|
|
956
|
+
export interface FormatReferenceStructuredObject {
|
|
957
|
+
/**
|
|
958
|
+
* 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.
|
|
959
|
+
*/
|
|
960
|
+
agent_url: string;
|
|
961
|
+
/**
|
|
962
|
+
* 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.
|
|
963
|
+
* @pattern ^[a-zA-Z0-9_-]+$
|
|
964
|
+
*/
|
|
965
|
+
id: string;
|
|
966
|
+
/**
|
|
967
|
+
* 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.
|
|
968
|
+
* @minimum 1
|
|
969
|
+
*/
|
|
970
|
+
width?: number;
|
|
971
|
+
/**
|
|
972
|
+
* 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.
|
|
973
|
+
* @minimum 1
|
|
974
|
+
*/
|
|
975
|
+
height?: number;
|
|
976
|
+
/**
|
|
977
|
+
* Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
|
|
978
|
+
* @minimum 1
|
|
979
|
+
*/
|
|
980
|
+
duration_ms?: number;
|
|
981
|
+
}
|
|
982
|
+
|
|
983
|
+
/**
|
|
984
|
+
* Whether the video uses a constant or variable frame rate. Broadcast and SSAI contexts require constant frame rate for seamless splicing.
|
|
985
|
+
*/
|
|
986
|
+
export type FrameRateType = 'constant' | 'variable';
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* Group of Pictures structure. SSAI and broadcast require closed GOPs for clean splice points; open GOPs may produce artifacts at ad boundaries.
|
|
990
|
+
*/
|
|
991
|
+
export type GOPType = 'closed' | 'open';
|
|
992
|
+
|
|
993
|
+
/**
|
|
994
|
+
* 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.
|
|
995
|
+
*/
|
|
996
|
+
export interface HTMLAsset {
|
|
997
|
+
/**
|
|
998
|
+
* Discriminator identifying this as an HTML asset. See /schemas/creative/asset-types for the registry.
|
|
999
|
+
*/
|
|
1000
|
+
asset_type: 'html';
|
|
1001
|
+
/**
|
|
1002
|
+
* HTML content
|
|
1003
|
+
*/
|
|
1004
|
+
content: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* HTML version (e.g., 'HTML5')
|
|
1007
|
+
*/
|
|
1008
|
+
version?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* Self-declared accessibility properties for this opaque creative
|
|
1011
|
+
*/
|
|
1012
|
+
accessibility?: {
|
|
1013
|
+
/**
|
|
1014
|
+
* Text alternative describing the creative content
|
|
1015
|
+
*/
|
|
1016
|
+
alt_text?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* Whether the creative can be fully operated via keyboard
|
|
1019
|
+
*/
|
|
1020
|
+
keyboard_navigable?: boolean;
|
|
1021
|
+
/**
|
|
1022
|
+
* Whether the creative respects prefers-reduced-motion or provides pause/stop controls
|
|
1023
|
+
*/
|
|
1024
|
+
motion_control?: boolean;
|
|
1025
|
+
/**
|
|
1026
|
+
* Whether the creative has been tested with screen readers
|
|
1027
|
+
*/
|
|
1028
|
+
screen_reader_tested?: boolean;
|
|
1029
|
+
};
|
|
1030
|
+
provenance?: Provenance;
|
|
1031
|
+
}
|
|
1032
|
+
|
|
1033
|
+
/**
|
|
1034
|
+
* HTTP method
|
|
1035
|
+
*/
|
|
1036
|
+
export type HTTPMethod = 'GET' | 'POST';
|
|
1037
|
+
|
|
1038
|
+
/**
|
|
1039
|
+
* Override logo asset.
|
|
1040
|
+
*/
|
|
1041
|
+
export interface ImageAsset {
|
|
1042
|
+
/**
|
|
1043
|
+
* Discriminator identifying this as an image asset. See /schemas/creative/asset-types for the registry.
|
|
1044
|
+
*/
|
|
1045
|
+
asset_type: 'image';
|
|
1046
|
+
/**
|
|
1047
|
+
* URL to the image asset
|
|
1048
|
+
*/
|
|
1049
|
+
url: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* Width in pixels
|
|
1052
|
+
* @minimum 1
|
|
1053
|
+
*/
|
|
1054
|
+
width: number;
|
|
1055
|
+
/**
|
|
1056
|
+
* Height in pixels
|
|
1057
|
+
* @minimum 1
|
|
1058
|
+
*/
|
|
1059
|
+
height: number;
|
|
1060
|
+
/**
|
|
1061
|
+
* Image file format (jpg, png, gif, webp, etc.)
|
|
1062
|
+
*/
|
|
1063
|
+
format?: string;
|
|
1064
|
+
/**
|
|
1065
|
+
* Alternative text for accessibility
|
|
1066
|
+
*/
|
|
1067
|
+
alt_text?: string;
|
|
1068
|
+
provenance?: Provenance;
|
|
1069
|
+
}
|
|
1070
|
+
|
|
1071
|
+
/**
|
|
1072
|
+
* 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.
|
|
1073
|
+
*/
|
|
1074
|
+
export interface IndustryIdentifier {
|
|
1075
|
+
type: CreativeIdentifierType;
|
|
1076
|
+
/**
|
|
1077
|
+
* The identifier value (e.g., 'ABCD1234000H' for Ad-ID)
|
|
1078
|
+
* @maxLength 64
|
|
1079
|
+
*/
|
|
1080
|
+
value: string;
|
|
1081
|
+
}
|
|
1082
|
+
|
|
1083
|
+
/**
|
|
1084
|
+
* 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.
|
|
1085
|
+
*/
|
|
1086
|
+
export interface JavaScriptAsset {
|
|
1087
|
+
/**
|
|
1088
|
+
* Discriminator identifying this as a JavaScript asset. See /schemas/creative/asset-types for the registry.
|
|
1089
|
+
*/
|
|
1090
|
+
asset_type: 'javascript';
|
|
1091
|
+
/**
|
|
1092
|
+
* JavaScript content
|
|
1093
|
+
*/
|
|
1094
|
+
content: string;
|
|
1095
|
+
module_type?: JavaScriptModuleType;
|
|
1096
|
+
/**
|
|
1097
|
+
* Self-declared accessibility properties for this opaque creative
|
|
1098
|
+
*/
|
|
1099
|
+
accessibility?: {
|
|
1100
|
+
/**
|
|
1101
|
+
* Text alternative describing the creative content
|
|
1102
|
+
*/
|
|
1103
|
+
alt_text?: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* Whether the creative can be fully operated via keyboard
|
|
1106
|
+
*/
|
|
1107
|
+
keyboard_navigable?: boolean;
|
|
1108
|
+
/**
|
|
1109
|
+
* Whether the creative respects prefers-reduced-motion or provides pause/stop controls
|
|
1110
|
+
*/
|
|
1111
|
+
motion_control?: boolean;
|
|
1112
|
+
/**
|
|
1113
|
+
* Whether the creative has been tested with screen readers
|
|
1114
|
+
*/
|
|
1115
|
+
screen_reader_tested?: boolean;
|
|
1116
|
+
};
|
|
1117
|
+
provenance?: Provenance;
|
|
1118
|
+
}
|
|
1119
|
+
|
|
1120
|
+
/**
|
|
1121
|
+
* JavaScript module type
|
|
1122
|
+
*/
|
|
1123
|
+
export type JavaScriptModuleType = 'esm' | 'commonjs' | 'script';
|
|
1124
|
+
|
|
1125
|
+
/**
|
|
1126
|
+
* Markdown-formatted text content following CommonMark specification
|
|
1127
|
+
*/
|
|
1128
|
+
export interface MarkdownAsset {
|
|
1129
|
+
/**
|
|
1130
|
+
* Discriminator identifying this as a markdown asset. See /schemas/creative/asset-types for the registry.
|
|
1131
|
+
*/
|
|
1132
|
+
asset_type: 'markdown';
|
|
1133
|
+
/**
|
|
1134
|
+
* Markdown content following CommonMark spec with optional GitHub Flavored Markdown extensions
|
|
1135
|
+
*/
|
|
1136
|
+
content: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* Language code (e.g., 'en', 'es', 'fr')
|
|
1139
|
+
*/
|
|
1140
|
+
language?: string;
|
|
1141
|
+
markdown_flavor?: MarkdownFlavor;
|
|
1142
|
+
/**
|
|
1143
|
+
* Whether raw HTML blocks are allowed in the markdown. False recommended for security.
|
|
1144
|
+
*/
|
|
1145
|
+
allow_raw_html?: boolean;
|
|
1146
|
+
}
|
|
1147
|
+
|
|
1148
|
+
/**
|
|
1149
|
+
* Markdown flavor used. CommonMark for strict compatibility, GFM for tables/task lists/strikethrough.
|
|
1150
|
+
*/
|
|
1151
|
+
export type MarkdownFlavor = 'commonmark' | 'gfm';
|
|
1152
|
+
|
|
1153
|
+
/**
|
|
1154
|
+
* Position of the moov atom in an MP4 container. 'start' enables progressive download without buffering the entire file; required for streaming ad delivery.
|
|
1155
|
+
*/
|
|
1156
|
+
export type MoovAtomPosition = 'start' | 'end';
|
|
1157
|
+
|
|
1158
|
+
/**
|
|
1159
|
+
* 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.
|
|
1160
|
+
*
|
|
1161
|
+
* **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.
|
|
1162
|
+
*
|
|
1163
|
+
* - **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`).
|
|
1164
|
+
* - **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.
|
|
1165
|
+
* - **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.
|
|
1166
|
+
* - **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.
|
|
1167
|
+
* - **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).
|
|
1168
|
+
* - **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).
|
|
1169
|
+
* - **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.
|
|
1170
|
+
* - **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.
|
|
1171
|
+
* - **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.
|
|
1172
|
+
* - **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.
|
|
1173
|
+
* - **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.
|
|
1174
|
+
*/
|
|
1175
|
+
export interface PlatformExtensionReference {
|
|
1176
|
+
/**
|
|
1177
|
+
* 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.
|
|
1178
|
+
* @pattern ^https:\/\/
|
|
1179
|
+
*/
|
|
1180
|
+
uri: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* 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.
|
|
1183
|
+
* @pattern ^sha256:[a-f0-9]{64}$
|
|
1184
|
+
*/
|
|
1185
|
+
digest: string;
|
|
1186
|
+
}
|
|
1187
|
+
|
|
1188
|
+
/**
|
|
1189
|
+
* Output format for preview renders when include_preview is true. 'url' returns preview_url (iframe-embeddable URL), 'html' returns preview_html (raw HTML). Ignored when include_preview is false or omitted.
|
|
1190
|
+
*/
|
|
1191
|
+
export type PreviewOutputFormat = 'url' | 'html';
|
|
1192
|
+
|
|
1193
|
+
/**
|
|
1194
|
+
* A single rendered piece of a creative preview with discriminated output format
|
|
1195
|
+
*/
|
|
1196
|
+
export type PreviewRender = {
|
|
1197
|
+
/**
|
|
1198
|
+
* Unique identifier for this rendered piece within the variant
|
|
1199
|
+
*/
|
|
1200
|
+
render_id: string;
|
|
1201
|
+
/**
|
|
1202
|
+
* Discriminator indicating preview_url is provided
|
|
1203
|
+
*/
|
|
1204
|
+
output_format: 'url';
|
|
1205
|
+
/**
|
|
1206
|
+
* URL to an HTML page that renders this piece. Can be embedded in an iframe.
|
|
1207
|
+
*/
|
|
1208
|
+
preview_url: string;
|
|
1209
|
+
/**
|
|
1210
|
+
* Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles.
|
|
1211
|
+
*/
|
|
1212
|
+
role: string;
|
|
1213
|
+
/**
|
|
1214
|
+
* Dimensions for this rendered piece
|
|
1215
|
+
*/
|
|
1216
|
+
dimensions?: {
|
|
1217
|
+
/**
|
|
1218
|
+
* @minimum 0
|
|
1219
|
+
*/
|
|
1220
|
+
width: number;
|
|
1221
|
+
/**
|
|
1222
|
+
* @minimum 0
|
|
1223
|
+
*/
|
|
1224
|
+
height: number;
|
|
1225
|
+
};
|
|
1226
|
+
/**
|
|
1227
|
+
* Optional security and embedding metadata for safe iframe integration
|
|
1228
|
+
*/
|
|
1229
|
+
embedding?: {
|
|
1230
|
+
/**
|
|
1231
|
+
* Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')
|
|
1232
|
+
*/
|
|
1233
|
+
recommended_sandbox?: string;
|
|
1234
|
+
/**
|
|
1235
|
+
* Whether this output requires HTTPS for secure embedding
|
|
1236
|
+
*/
|
|
1237
|
+
requires_https?: boolean;
|
|
1238
|
+
/**
|
|
1239
|
+
* Whether this output supports fullscreen mode
|
|
1240
|
+
*/
|
|
1241
|
+
supports_fullscreen?: boolean;
|
|
1242
|
+
/**
|
|
1243
|
+
* Content Security Policy requirements for embedding
|
|
1244
|
+
*/
|
|
1245
|
+
csp_policy?: string;
|
|
1246
|
+
};
|
|
1247
|
+
} | {
|
|
1248
|
+
/**
|
|
1249
|
+
* Unique identifier for this rendered piece within the variant
|
|
1250
|
+
*/
|
|
1251
|
+
render_id: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* Discriminator indicating preview_html is provided
|
|
1254
|
+
*/
|
|
1255
|
+
output_format: 'html';
|
|
1256
|
+
/**
|
|
1257
|
+
* Raw HTML for this rendered piece. Can be embedded directly in the page without iframe. Security warning: Only use with trusted creative agents as this bypasses iframe sandboxing.
|
|
1258
|
+
*/
|
|
1259
|
+
preview_html: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles.
|
|
1262
|
+
*/
|
|
1263
|
+
role: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* Dimensions for this rendered piece
|
|
1266
|
+
*/
|
|
1267
|
+
dimensions?: {
|
|
1268
|
+
/**
|
|
1269
|
+
* @minimum 0
|
|
1270
|
+
*/
|
|
1271
|
+
width: number;
|
|
1272
|
+
/**
|
|
1273
|
+
* @minimum 0
|
|
1274
|
+
*/
|
|
1275
|
+
height: number;
|
|
1276
|
+
};
|
|
1277
|
+
/**
|
|
1278
|
+
* Optional security and embedding metadata
|
|
1279
|
+
*/
|
|
1280
|
+
embedding?: {
|
|
1281
|
+
/**
|
|
1282
|
+
* Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')
|
|
1283
|
+
*/
|
|
1284
|
+
recommended_sandbox?: string;
|
|
1285
|
+
/**
|
|
1286
|
+
* Whether this output requires HTTPS for secure embedding
|
|
1287
|
+
*/
|
|
1288
|
+
requires_https?: boolean;
|
|
1289
|
+
/**
|
|
1290
|
+
* Whether this output supports fullscreen mode
|
|
1291
|
+
*/
|
|
1292
|
+
supports_fullscreen?: boolean;
|
|
1293
|
+
/**
|
|
1294
|
+
* Content Security Policy requirements for embedding
|
|
1295
|
+
*/
|
|
1296
|
+
csp_policy?: string;
|
|
1297
|
+
};
|
|
1298
|
+
} | {
|
|
1299
|
+
/**
|
|
1300
|
+
* Unique identifier for this rendered piece within the variant
|
|
1301
|
+
*/
|
|
1302
|
+
render_id: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* Discriminator indicating both preview_url and preview_html are provided
|
|
1305
|
+
*/
|
|
1306
|
+
output_format: 'both';
|
|
1307
|
+
/**
|
|
1308
|
+
* URL to an HTML page that renders this piece. Can be embedded in an iframe.
|
|
1309
|
+
*/
|
|
1310
|
+
preview_url: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* Raw HTML for this rendered piece. Can be embedded directly in the page without iframe. Security warning: Only use with trusted creative agents as this bypasses iframe sandboxing.
|
|
1313
|
+
*/
|
|
1314
|
+
preview_html: string;
|
|
1315
|
+
/**
|
|
1316
|
+
* Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles.
|
|
1317
|
+
*/
|
|
1318
|
+
role: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* Dimensions for this rendered piece
|
|
1321
|
+
*/
|
|
1322
|
+
dimensions?: {
|
|
1323
|
+
/**
|
|
1324
|
+
* @minimum 0
|
|
1325
|
+
*/
|
|
1326
|
+
width: number;
|
|
1327
|
+
/**
|
|
1328
|
+
* @minimum 0
|
|
1329
|
+
*/
|
|
1330
|
+
height: number;
|
|
1331
|
+
};
|
|
1332
|
+
/**
|
|
1333
|
+
* Optional security and embedding metadata for safe iframe integration
|
|
1334
|
+
*/
|
|
1335
|
+
embedding?: {
|
|
1336
|
+
/**
|
|
1337
|
+
* Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')
|
|
1338
|
+
*/
|
|
1339
|
+
recommended_sandbox?: string;
|
|
1340
|
+
/**
|
|
1341
|
+
* Whether this output requires HTTPS for secure embedding
|
|
1342
|
+
*/
|
|
1343
|
+
requires_https?: boolean;
|
|
1344
|
+
/**
|
|
1345
|
+
* Whether this output supports fullscreen mode
|
|
1346
|
+
*/
|
|
1347
|
+
supports_fullscreen?: boolean;
|
|
1348
|
+
/**
|
|
1349
|
+
* Content Security Policy requirements for embedding
|
|
1350
|
+
*/
|
|
1351
|
+
csp_policy?: string;
|
|
1352
|
+
};
|
|
1353
|
+
};
|
|
1354
|
+
|
|
1355
|
+
/**
|
|
1356
|
+
* Provenance metadata for this asset, overrides manifest-level provenance
|
|
1357
|
+
*/
|
|
1358
|
+
export interface Provenance {
|
|
1359
|
+
digital_source_type?: DigitalSourceType;
|
|
1360
|
+
/**
|
|
1361
|
+
* AI system used to generate or modify this content. Aligns with IPTC 2025.1 AI metadata fields and C2PA claim_generator.
|
|
1362
|
+
*/
|
|
1363
|
+
ai_tool?: {
|
|
1364
|
+
/**
|
|
1365
|
+
* Name of the AI tool or model (e.g., 'DALL-E 3', 'Stable Diffusion XL', 'Gemini')
|
|
1366
|
+
*/
|
|
1367
|
+
name: string;
|
|
1368
|
+
/**
|
|
1369
|
+
* 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.
|
|
1370
|
+
*/
|
|
1371
|
+
version?: string;
|
|
1372
|
+
/**
|
|
1373
|
+
* Organization that provides the AI tool (e.g., 'OpenAI', 'Stability AI', 'Google')
|
|
1374
|
+
*/
|
|
1375
|
+
provider?: string;
|
|
1376
|
+
};
|
|
1377
|
+
/**
|
|
1378
|
+
* 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`.
|
|
1379
|
+
*/
|
|
1380
|
+
human_oversight?: 'none' | 'prompt_only' | 'selected' | 'edited' | 'directed';
|
|
1381
|
+
/**
|
|
1382
|
+
* Party declaring this provenance. Identifies who attached the provenance claim, enabling receiving parties to assess trust.
|
|
1383
|
+
*/
|
|
1384
|
+
declared_by?: {
|
|
1385
|
+
/**
|
|
1386
|
+
* URL of the agent or service that declared this provenance
|
|
1387
|
+
*/
|
|
1388
|
+
agent_url?: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* Role of the declaring party in the supply chain
|
|
1391
|
+
*/
|
|
1392
|
+
role: 'creator' | 'advertiser' | 'agency' | 'platform' | 'tool';
|
|
1393
|
+
};
|
|
1394
|
+
/**
|
|
1395
|
+
* 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.
|
|
1396
|
+
* @format date-time
|
|
1397
|
+
*/
|
|
1398
|
+
declared_at?: string;
|
|
1399
|
+
/**
|
|
1400
|
+
* When this content was created or generated (ISO 8601)
|
|
1401
|
+
* @format date-time
|
|
1402
|
+
*/
|
|
1403
|
+
created_time?: string;
|
|
1404
|
+
/**
|
|
1405
|
+
* 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.
|
|
1406
|
+
*/
|
|
1407
|
+
c2pa?: {
|
|
1408
|
+
/**
|
|
1409
|
+
* URL to the C2PA manifest store for this content
|
|
1410
|
+
*/
|
|
1411
|
+
manifest_url: string;
|
|
1412
|
+
};
|
|
1413
|
+
/**
|
|
1414
|
+
* 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`).
|
|
1415
|
+
*/
|
|
1416
|
+
embedded_provenance?: {
|
|
1417
|
+
method: EmbeddedProvenanceMethod;
|
|
1418
|
+
/**
|
|
1419
|
+
* Standard the embedding conforms to, if any (e.g., 'c2pa' for C2PA Section A.7 text manifest embedding)
|
|
1420
|
+
*/
|
|
1421
|
+
standard?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* Organization that performed the embedding (e.g., 'Encypher', 'Digimarc'). Display label and audit context — not a wire identifier.
|
|
1424
|
+
*/
|
|
1425
|
+
provider: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* 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).
|
|
1428
|
+
*/
|
|
1429
|
+
verify_agent?: {
|
|
1430
|
+
/**
|
|
1431
|
+
* 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.
|
|
1432
|
+
* @pattern ^https:\/\/
|
|
1433
|
+
*/
|
|
1434
|
+
agent_url: string;
|
|
1435
|
+
/**
|
|
1436
|
+
* 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.
|
|
1437
|
+
*/
|
|
1438
|
+
feature_id?: string;
|
|
1439
|
+
};
|
|
1440
|
+
/**
|
|
1441
|
+
* When the provenance data was embedded (ISO 8601)
|
|
1442
|
+
* @format date-time
|
|
1443
|
+
*/
|
|
1444
|
+
embedded_at?: string;
|
|
1445
|
+
}[];
|
|
1446
|
+
/**
|
|
1447
|
+
* 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`).
|
|
1448
|
+
*/
|
|
1449
|
+
watermarks?: {
|
|
1450
|
+
media_type: WatermarkMediaType;
|
|
1451
|
+
/**
|
|
1452
|
+
* Organization that applied the watermark (e.g., 'Imatag', 'Steg.AI', 'Encypher'). Display label and audit context — not a wire identifier.
|
|
1453
|
+
*/
|
|
1454
|
+
provider: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* 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).
|
|
1457
|
+
*/
|
|
1458
|
+
verify_agent?: {
|
|
1459
|
+
/**
|
|
1460
|
+
* 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.
|
|
1461
|
+
* @pattern ^https:\/\/
|
|
1462
|
+
*/
|
|
1463
|
+
agent_url: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* 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.
|
|
1466
|
+
*/
|
|
1467
|
+
feature_id?: string;
|
|
1468
|
+
};
|
|
1469
|
+
c2pa_action?: C2PAWatermarkAction;
|
|
1470
|
+
/**
|
|
1471
|
+
* When the watermark was applied (ISO 8601)
|
|
1472
|
+
* @format date-time
|
|
1473
|
+
*/
|
|
1474
|
+
embedded_at?: string;
|
|
1475
|
+
}[];
|
|
1476
|
+
/**
|
|
1477
|
+
* Regulatory disclosure requirements for this content. Indicates whether AI disclosure is required and under which jurisdictions.
|
|
1478
|
+
*/
|
|
1479
|
+
disclosure?: {
|
|
1480
|
+
/**
|
|
1481
|
+
* 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.
|
|
1482
|
+
*/
|
|
1483
|
+
required: boolean;
|
|
1484
|
+
/**
|
|
1485
|
+
* Jurisdictions where disclosure obligations apply
|
|
1486
|
+
*/
|
|
1487
|
+
jurisdictions?: {
|
|
1488
|
+
/**
|
|
1489
|
+
* ISO 3166-1 alpha-2 country code (e.g., 'US', 'DE', 'CN')
|
|
1490
|
+
*/
|
|
1491
|
+
country: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* Sub-national region code (e.g., 'CA' for California, 'BY' for Bavaria)
|
|
1494
|
+
*/
|
|
1495
|
+
region?: string;
|
|
1496
|
+
/**
|
|
1497
|
+
* Regulation identifier (e.g., 'eu_ai_act_article_50', 'ca_sb_942', 'cn_deep_synthesis')
|
|
1498
|
+
*/
|
|
1499
|
+
regulation: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* Required disclosure label text for this jurisdiction, in the local language
|
|
1502
|
+
*/
|
|
1503
|
+
label_text?: string;
|
|
1504
|
+
/**
|
|
1505
|
+
* 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.
|
|
1506
|
+
*/
|
|
1507
|
+
render_guidance?: {
|
|
1508
|
+
persistence?: DisclosurePersistence;
|
|
1509
|
+
/**
|
|
1510
|
+
* 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.
|
|
1511
|
+
* @minimum 1
|
|
1512
|
+
*/
|
|
1513
|
+
min_duration_ms?: number;
|
|
1514
|
+
/**
|
|
1515
|
+
* Preferred disclosure positions in priority order. The first position a format supports should be used.
|
|
1516
|
+
*/
|
|
1517
|
+
positions?: DisclosurePosition[];
|
|
1518
|
+
ext?: ExtensionObject;
|
|
1519
|
+
};
|
|
1520
|
+
}[];
|
|
1521
|
+
};
|
|
1522
|
+
/**
|
|
1523
|
+
* 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.
|
|
1524
|
+
*/
|
|
1525
|
+
verification?: {
|
|
1526
|
+
/**
|
|
1527
|
+
* Name of the verification service (e.g., 'DoubleVerify', 'Hive Moderation', 'Reality Defender')
|
|
1528
|
+
*/
|
|
1529
|
+
verified_by: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* When the verification was performed (ISO 8601)
|
|
1532
|
+
* @format date-time
|
|
1533
|
+
*/
|
|
1534
|
+
verified_time?: string;
|
|
1535
|
+
/**
|
|
1536
|
+
* Verification outcome
|
|
1537
|
+
*/
|
|
1538
|
+
result: 'authentic' | 'ai_generated' | 'ai_modified' | 'inconclusive';
|
|
1539
|
+
/**
|
|
1540
|
+
* Confidence score of the verification result (0.0 to 1.0)
|
|
1541
|
+
* @minimum 0
|
|
1542
|
+
* @maximum 1
|
|
1543
|
+
*/
|
|
1544
|
+
confidence?: number;
|
|
1545
|
+
/**
|
|
1546
|
+
* URL to the full verification report
|
|
1547
|
+
*/
|
|
1548
|
+
details_url?: string;
|
|
1549
|
+
}[];
|
|
1550
|
+
ext?: ExtensionObject;
|
|
1551
|
+
}
|
|
1552
|
+
|
|
1553
|
+
/**
|
|
1554
|
+
* 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.
|
|
1555
|
+
*/
|
|
1556
|
+
export interface PushNotificationConfig {
|
|
1557
|
+
/**
|
|
1558
|
+
* 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).
|
|
1559
|
+
*/
|
|
1560
|
+
url: string;
|
|
1561
|
+
/**
|
|
1562
|
+
* 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`.
|
|
1563
|
+
* @minLength 1
|
|
1564
|
+
* @maxLength 255
|
|
1565
|
+
* @pattern ^[A-Za-z0-9_.:-]{1,255}$
|
|
1566
|
+
*/
|
|
1567
|
+
operation_id?: string;
|
|
1568
|
+
/**
|
|
1569
|
+
* 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.
|
|
1570
|
+
* @minLength 16
|
|
1571
|
+
* @maxLength 4096
|
|
1572
|
+
*/
|
|
1573
|
+
token?: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* 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).
|
|
1576
|
+
*/
|
|
1577
|
+
authentication?: {
|
|
1578
|
+
/**
|
|
1579
|
+
* 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.
|
|
1580
|
+
*/
|
|
1581
|
+
schemes: AuthenticationScheme[];
|
|
1582
|
+
/**
|
|
1583
|
+
* 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.
|
|
1584
|
+
* @minLength 32
|
|
1585
|
+
*/
|
|
1586
|
+
credentials: string;
|
|
1587
|
+
};
|
|
1588
|
+
}
|
|
1589
|
+
|
|
1590
|
+
/**
|
|
1591
|
+
* 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.
|
|
1592
|
+
*/
|
|
1593
|
+
export interface ReferenceAsset {
|
|
1594
|
+
/**
|
|
1595
|
+
* URL to the reference asset (image, video, or document)
|
|
1596
|
+
*/
|
|
1597
|
+
url: string;
|
|
1598
|
+
/**
|
|
1599
|
+
* 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
|
|
1600
|
+
*/
|
|
1601
|
+
role: 'style_reference' | 'product_shot' | 'mood_board' | 'example_creative' | 'logo' | 'strategy_doc' | 'storyboard';
|
|
1602
|
+
/**
|
|
1603
|
+
* Human-readable description of the asset and how it should inform creative generation
|
|
1604
|
+
*/
|
|
1605
|
+
description?: string;
|
|
1606
|
+
}
|
|
1607
|
+
|
|
1608
|
+
/**
|
|
1609
|
+
* Type of rights (talent, music, etc.). Helps identify constraints when a creative combines multiple rights types.
|
|
1610
|
+
*/
|
|
1611
|
+
export type RightType = 'talent' | 'character' | 'brand_ip' | 'music' | 'stock_media';
|
|
1612
|
+
|
|
1613
|
+
/**
|
|
1614
|
+
* Types of rights usage that can be licensed through the brand protocol. Aligned with DDEX UseType direction for interoperability with music and media rights systems.
|
|
1615
|
+
*/
|
|
1616
|
+
export type RightUse = 'likeness' | 'voice' | 'name' | 'endorsement' | 'motion_capture' | 'signature' | 'catchphrase' | 'sync' | 'background_music' | 'editorial' | 'commercial' | 'ai_generated_image';
|
|
1617
|
+
|
|
1618
|
+
/**
|
|
1619
|
+
* Rights metadata attached to a creative manifest. Each entry represents constraints from a single rights holder. A creative may combine multiple rights constraints (e.g., talent likeness + music license). For v1, rights constraints are informational metadata — the buyer/orchestrator manages creative lifecycle against these terms.
|
|
1620
|
+
*/
|
|
1621
|
+
export interface RightsConstraint {
|
|
1622
|
+
/**
|
|
1623
|
+
* Rights grant identifier from the acquire_rights response
|
|
1624
|
+
*/
|
|
1625
|
+
rights_id: string;
|
|
1626
|
+
/**
|
|
1627
|
+
* The agent that granted these rights
|
|
1628
|
+
*/
|
|
1629
|
+
rights_agent: {
|
|
1630
|
+
/**
|
|
1631
|
+
* MCP endpoint URL of the rights agent
|
|
1632
|
+
*/
|
|
1633
|
+
url: string;
|
|
1634
|
+
/**
|
|
1635
|
+
* Agent identifier
|
|
1636
|
+
*/
|
|
1637
|
+
id: string;
|
|
1638
|
+
};
|
|
1639
|
+
/**
|
|
1640
|
+
* Start of the rights validity period
|
|
1641
|
+
* @format date-time
|
|
1642
|
+
*/
|
|
1643
|
+
valid_from?: string;
|
|
1644
|
+
/**
|
|
1645
|
+
* End of the rights validity period. Creative should not be served after this time.
|
|
1646
|
+
* @format date-time
|
|
1647
|
+
*/
|
|
1648
|
+
valid_until?: string;
|
|
1649
|
+
/**
|
|
1650
|
+
* Rights uses covered by this constraint
|
|
1651
|
+
*/
|
|
1652
|
+
uses: RightUse[];
|
|
1653
|
+
/**
|
|
1654
|
+
* Countries where this creative may be served under these rights (ISO 3166-1 alpha-2). If omitted, no country restriction. When both countries and excluded_countries are present, the effective set is countries minus excluded_countries.
|
|
1655
|
+
*/
|
|
1656
|
+
countries?: string[];
|
|
1657
|
+
/**
|
|
1658
|
+
* Countries excluded from rights availability (ISO 3166-1 alpha-2). Use when the grant is worldwide except specific markets.
|
|
1659
|
+
*/
|
|
1660
|
+
excluded_countries?: string[];
|
|
1661
|
+
/**
|
|
1662
|
+
* Maximum total impressions allowed for the full validity period (valid_from to valid_until). This is the absolute cap across all creatives using this rights grant, not a per-creative or per-period limit.
|
|
1663
|
+
* @minimum 1
|
|
1664
|
+
*/
|
|
1665
|
+
impression_cap?: number;
|
|
1666
|
+
right_type?: RightType;
|
|
1667
|
+
/**
|
|
1668
|
+
* Approval status from the rights holder at manifest creation time (snapshot, not a live value)
|
|
1669
|
+
*/
|
|
1670
|
+
approval_status?: 'pending' | 'approved' | 'rejected';
|
|
1671
|
+
/**
|
|
1672
|
+
* URL where downstream supply chain participants can verify this rights grant is active. Returns HTTP 200 with the current grant status, or 404 if revoked. Enables SSPs and verification vendors to confirm rights before serving.
|
|
1673
|
+
*/
|
|
1674
|
+
verification_url?: string;
|
|
1675
|
+
ext?: ExtensionObject;
|
|
1676
|
+
}
|
|
1677
|
+
|
|
1678
|
+
/**
|
|
1679
|
+
* Video scan method. Modern digital delivery requires progressive scan; interlaced is retained for broadcast legacy content.
|
|
1680
|
+
*/
|
|
1681
|
+
export type ScanType = 'progressive' | 'interlaced';
|
|
1682
|
+
|
|
1683
|
+
/**
|
|
1684
|
+
* 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.
|
|
1685
|
+
*/
|
|
1686
|
+
export type TaskStatus = 'submitted' | 'working' | 'input-required' | 'completed' | 'canceled' | 'failed' | 'rejected' | 'auth-required' | 'unknown';
|
|
1687
|
+
|
|
1688
|
+
/**
|
|
1689
|
+
* Text content asset
|
|
1690
|
+
*/
|
|
1691
|
+
export interface TextAsset {
|
|
1692
|
+
/**
|
|
1693
|
+
* Discriminator identifying this as a text asset. See /schemas/creative/asset-types for the registry.
|
|
1694
|
+
*/
|
|
1695
|
+
asset_type: 'text';
|
|
1696
|
+
/**
|
|
1697
|
+
* Text content
|
|
1698
|
+
*/
|
|
1699
|
+
content: string;
|
|
1700
|
+
/**
|
|
1701
|
+
* Language code (e.g., 'en', 'es', 'fr')
|
|
1702
|
+
*/
|
|
1703
|
+
language?: string;
|
|
1704
|
+
provenance?: Provenance;
|
|
1705
|
+
}
|
|
1706
|
+
|
|
1707
|
+
/**
|
|
1708
|
+
* 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.
|
|
1709
|
+
*/
|
|
1710
|
+
export interface URLAsset {
|
|
1711
|
+
/**
|
|
1712
|
+
* Discriminator identifying this as a URL asset. See /schemas/creative/asset-types for the registry.
|
|
1713
|
+
*/
|
|
1714
|
+
asset_type: 'url';
|
|
1715
|
+
/**
|
|
1716
|
+
* 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.
|
|
1717
|
+
*/
|
|
1718
|
+
url: string;
|
|
1719
|
+
url_type?: URLAssetType;
|
|
1720
|
+
/**
|
|
1721
|
+
* Description of what this URL points to
|
|
1722
|
+
*/
|
|
1723
|
+
description?: string;
|
|
1724
|
+
provenance?: Provenance;
|
|
1725
|
+
}
|
|
1726
|
+
|
|
1727
|
+
/**
|
|
1728
|
+
* 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.
|
|
1729
|
+
*/
|
|
1730
|
+
export type URLAssetType = 'clickthrough' | 'tracker_pixel' | 'tracker_script';
|
|
1731
|
+
|
|
1732
|
+
/**
|
|
1733
|
+
* 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.
|
|
1734
|
+
*/
|
|
1735
|
+
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';
|
|
1736
|
+
|
|
1737
|
+
/**
|
|
1738
|
+
* 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.
|
|
1739
|
+
*/
|
|
1740
|
+
export type UpdateFrequency = 'realtime' | 'hourly' | 'daily' | 'weekly';
|
|
1741
|
+
|
|
1742
|
+
/**
|
|
1743
|
+
* Manifest references a named format via the structured `format_id` object. The v1 path; remains supported through 4.x.
|
|
1744
|
+
*/
|
|
1745
|
+
export interface V1ManifestNamedFormatReference {
|
|
1746
|
+
format_id: FormatReferenceStructuredObject;
|
|
1747
|
+
/**
|
|
1748
|
+
* v2 path, optional. Stable identifier matching one of the seller's product `format_options[i].capability_id` values. REQUIRED when the target product carries multiple `format_options` entries sharing the same `format_kind` (the buyer must disambiguate which option this manifest matches). When the product's `format_options` has a single entry — or multiple entries with distinct `format_kind` values — `capability_id` is OPTIONAL because `format_kind` alone routes the manifest to the right declaration.
|
|
1749
|
+
*/
|
|
1750
|
+
capability_id?: string;
|
|
1751
|
+
/**
|
|
1752
|
+
* Map of slot keys to actual asset content. v1 path: each key matches an `asset_id` from the format's `assets` array (e.g., 'banner_image', 'clickthrough_url', 'video_file', 'vast_tag'). v2 path: each key matches an `asset_group_id` from the format's `slots` declaration drawn from the canonical vocabulary registry (e.g., 'images_landscape', 'video', 'landing_page_url', 'vast_tag', 'script', 'creative_brief'). Either path produces the same envelope shape; only the slot-key vocabulary differs.
|
|
1753
|
+
*
|
|
1754
|
+
* Each slot value is **either** a single asset object (most slots — image, video, vast_tag, landing_page_url, etc.) **or** an array of asset objects (slots with `min`/`max` counts on the format declaration — `cards` on `image_carousel`, `headlines` / `descriptions` / `images_landscape` on `responsive_creative`, etc.). Single-vs-array shape is governed by the format's `slots[].min` and `slots[].max` parameters: when `max > 1` (or when the slot is conceptually a pool), the value MUST be an array; when the slot is single-valued, the value MUST be a single object. Each asset value (single or array element) carries an `asset_type` discriminator (image, video, audio, vast, daast, text, markdown, url, html, css, webhook, javascript, brief, catalog, zip, card) that selects the matching asset schema. Validators with OpenAPI-style discriminator support use `asset_type` to report errors against only the selected branch instead of all branches.
|
|
1755
|
+
*/
|
|
1756
|
+
assets: {
|
|
1757
|
+
/**
|
|
1758
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
1759
|
+
* via the `patternProperty` "^[a-z0-9_]+$".
|
|
1760
|
+
*/
|
|
1761
|
+
[k: string]: AssetVariant | AssetVariant[];
|
|
1762
|
+
};
|
|
1763
|
+
brand?: BrandReference;
|
|
1764
|
+
/**
|
|
1765
|
+
* Rights constraints attached to this creative. Each entry represents constraints from a single rights holder. A creative may combine multiple rights constraints (e.g., talent likeness + music license). For v1, rights constraints are informational metadata — the buyer/orchestrator manages creative lifecycle against these terms.
|
|
1766
|
+
*/
|
|
1767
|
+
rights?: RightsConstraint[];
|
|
1768
|
+
/**
|
|
1769
|
+
* Industry-standard identifiers for this specific manifest (e.g., Ad-ID, ISCI, Clearcast clock number). When present, overrides creative-level identifiers. Use when different format versions of the same source creative have distinct Ad-IDs (e.g., the :15 and :30 cuts).
|
|
1770
|
+
*/
|
|
1771
|
+
industry_identifiers?: IndustryIdentifier[];
|
|
1772
|
+
provenance?: Provenance;
|
|
1773
|
+
ext?: ExtensionObject;
|
|
1774
|
+
}
|
|
1775
|
+
|
|
1776
|
+
/**
|
|
1777
|
+
* Manifest declares which canonical format it targets via `format_kind` (e.g., `image`). The v2 path introduced by RFC #3305.
|
|
1778
|
+
*/
|
|
1779
|
+
export interface V2ManifestCanonicalFormatKind {
|
|
1780
|
+
format_kind: CanonicalFormatKind;
|
|
1781
|
+
/**
|
|
1782
|
+
* v2 path, optional. Stable identifier matching one of the seller's product `format_options[i].capability_id` values. REQUIRED when the target product carries multiple `format_options` entries sharing the same `format_kind` (the buyer must disambiguate which option this manifest matches). When the product's `format_options` has a single entry — or multiple entries with distinct `format_kind` values — `capability_id` is OPTIONAL because `format_kind` alone routes the manifest to the right declaration.
|
|
1783
|
+
*/
|
|
1784
|
+
capability_id?: string;
|
|
1785
|
+
/**
|
|
1786
|
+
* Map of slot keys to actual asset content. v1 path: each key matches an `asset_id` from the format's `assets` array (e.g., 'banner_image', 'clickthrough_url', 'video_file', 'vast_tag'). v2 path: each key matches an `asset_group_id` from the format's `slots` declaration drawn from the canonical vocabulary registry (e.g., 'images_landscape', 'video', 'landing_page_url', 'vast_tag', 'script', 'creative_brief'). Either path produces the same envelope shape; only the slot-key vocabulary differs.
|
|
1787
|
+
*
|
|
1788
|
+
* Each slot value is **either** a single asset object (most slots — image, video, vast_tag, landing_page_url, etc.) **or** an array of asset objects (slots with `min`/`max` counts on the format declaration — `cards` on `image_carousel`, `headlines` / `descriptions` / `images_landscape` on `responsive_creative`, etc.). Single-vs-array shape is governed by the format's `slots[].min` and `slots[].max` parameters: when `max > 1` (or when the slot is conceptually a pool), the value MUST be an array; when the slot is single-valued, the value MUST be a single object. Each asset value (single or array element) carries an `asset_type` discriminator (image, video, audio, vast, daast, text, markdown, url, html, css, webhook, javascript, brief, catalog, zip, card) that selects the matching asset schema. Validators with OpenAPI-style discriminator support use `asset_type` to report errors against only the selected branch instead of all branches.
|
|
1789
|
+
*/
|
|
1790
|
+
assets: {
|
|
1791
|
+
/**
|
|
1792
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
1793
|
+
* via the `patternProperty` "^[a-z0-9_]+$".
|
|
1794
|
+
*/
|
|
1795
|
+
[k: string]: AssetVariant | AssetVariant[];
|
|
1796
|
+
};
|
|
1797
|
+
brand?: BrandReference;
|
|
1798
|
+
/**
|
|
1799
|
+
* Rights constraints attached to this creative. Each entry represents constraints from a single rights holder. A creative may combine multiple rights constraints (e.g., talent likeness + music license). For v1, rights constraints are informational metadata — the buyer/orchestrator manages creative lifecycle against these terms.
|
|
1800
|
+
*/
|
|
1801
|
+
rights?: RightsConstraint[];
|
|
1802
|
+
/**
|
|
1803
|
+
* Industry-standard identifiers for this specific manifest (e.g., Ad-ID, ISCI, Clearcast clock number). When present, overrides creative-level identifiers. Use when different format versions of the same source creative have distinct Ad-IDs (e.g., the :15 and :30 cuts).
|
|
1804
|
+
*/
|
|
1805
|
+
industry_identifiers?: IndustryIdentifier[];
|
|
1806
|
+
provenance?: Provenance;
|
|
1807
|
+
ext?: ExtensionObject;
|
|
1808
|
+
}
|
|
1809
|
+
|
|
1810
|
+
/**
|
|
1811
|
+
* VAST (Video Ad Serving Template) tag for third-party video ad serving
|
|
1812
|
+
*/
|
|
1813
|
+
export type VASTAsset = {
|
|
1814
|
+
/**
|
|
1815
|
+
* Discriminator identifying this as a VAST asset. See /schemas/creative/asset-types for the registry.
|
|
1816
|
+
*/
|
|
1817
|
+
asset_type: 'vast';
|
|
1818
|
+
vast_version?: VASTVersion;
|
|
1819
|
+
/**
|
|
1820
|
+
* Whether VPAID (Video Player-Ad Interface Definition) is supported
|
|
1821
|
+
*/
|
|
1822
|
+
vpaid_enabled?: boolean;
|
|
1823
|
+
/**
|
|
1824
|
+
* Expected video duration in milliseconds (if known)
|
|
1825
|
+
* @minimum 0
|
|
1826
|
+
*/
|
|
1827
|
+
duration_ms?: number;
|
|
1828
|
+
/**
|
|
1829
|
+
* Tracking events supported by this VAST tag
|
|
1830
|
+
*/
|
|
1831
|
+
tracking_events?: VASTTrackingEvent[];
|
|
1832
|
+
/**
|
|
1833
|
+
* URL to captions file (WebVTT, SRT, etc.)
|
|
1834
|
+
*/
|
|
1835
|
+
captions_url?: string;
|
|
1836
|
+
/**
|
|
1837
|
+
* URL to audio description track for visually impaired users
|
|
1838
|
+
*/
|
|
1839
|
+
audio_description_url?: string;
|
|
1840
|
+
provenance?: Provenance;
|
|
1841
|
+
} & ({
|
|
1842
|
+
/**
|
|
1843
|
+
* Discriminator indicating VAST is delivered via URL endpoint
|
|
1844
|
+
*/
|
|
1845
|
+
delivery_type: 'url';
|
|
1846
|
+
/**
|
|
1847
|
+
* URL endpoint that returns VAST XML
|
|
1848
|
+
*/
|
|
1849
|
+
url: string;
|
|
1850
|
+
} | {
|
|
1851
|
+
/**
|
|
1852
|
+
* Discriminator indicating VAST is delivered as inline XML content
|
|
1853
|
+
*/
|
|
1854
|
+
delivery_type: 'inline';
|
|
1855
|
+
/**
|
|
1856
|
+
* Inline VAST XML content
|
|
1857
|
+
*/
|
|
1858
|
+
content: string;
|
|
1859
|
+
});
|
|
1860
|
+
|
|
1861
|
+
/**
|
|
1862
|
+
* 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.
|
|
1863
|
+
*/
|
|
1864
|
+
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';
|
|
1865
|
+
|
|
1866
|
+
/**
|
|
1867
|
+
* VAST specification version
|
|
1868
|
+
*/
|
|
1869
|
+
export type VASTVersion = '2.0' | '3.0' | '4.0' | '4.1' | '4.2';
|
|
1870
|
+
|
|
1871
|
+
/**
|
|
1872
|
+
* Video asset with URL and technical specifications including audio track properties
|
|
1873
|
+
*/
|
|
1874
|
+
export interface VideoAsset {
|
|
1875
|
+
/**
|
|
1876
|
+
* Discriminator identifying this as a video asset. See /schemas/creative/asset-types for the registry.
|
|
1877
|
+
*/
|
|
1878
|
+
asset_type: 'video';
|
|
1879
|
+
/**
|
|
1880
|
+
* URL to the video asset
|
|
1881
|
+
*/
|
|
1882
|
+
url: string;
|
|
1883
|
+
/**
|
|
1884
|
+
* Width in pixels
|
|
1885
|
+
* @minimum 1
|
|
1886
|
+
*/
|
|
1887
|
+
width: number;
|
|
1888
|
+
/**
|
|
1889
|
+
* Height in pixels
|
|
1890
|
+
* @minimum 1
|
|
1891
|
+
*/
|
|
1892
|
+
height: number;
|
|
1893
|
+
/**
|
|
1894
|
+
* Video duration in milliseconds
|
|
1895
|
+
* @minimum 1
|
|
1896
|
+
*/
|
|
1897
|
+
duration_ms?: number;
|
|
1898
|
+
/**
|
|
1899
|
+
* File size in bytes
|
|
1900
|
+
* @minimum 1
|
|
1901
|
+
*/
|
|
1902
|
+
file_size_bytes?: number;
|
|
1903
|
+
/**
|
|
1904
|
+
* Video container format (mp4, webm, mov, etc.)
|
|
1905
|
+
*/
|
|
1906
|
+
container_format?: string;
|
|
1907
|
+
/**
|
|
1908
|
+
* Video codec used (h264, h265, vp9, av1, prores, etc.)
|
|
1909
|
+
*/
|
|
1910
|
+
video_codec?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* Video stream bitrate in kilobits per second
|
|
1913
|
+
* @minimum 1
|
|
1914
|
+
*/
|
|
1915
|
+
video_bitrate_kbps?: number;
|
|
1916
|
+
/**
|
|
1917
|
+
* Frame rate as string to preserve precision (e.g., '23.976', '29.97', '30')
|
|
1918
|
+
*/
|
|
1919
|
+
frame_rate?: string;
|
|
1920
|
+
frame_rate_type?: FrameRateType;
|
|
1921
|
+
scan_type?: ScanType;
|
|
1922
|
+
/**
|
|
1923
|
+
* Color space of the video
|
|
1924
|
+
*/
|
|
1925
|
+
color_space?: 'rec709' | 'rec2020' | 'rec2100' | 'srgb' | 'dci_p3';
|
|
1926
|
+
/**
|
|
1927
|
+
* HDR format if applicable, or 'sdr' for standard dynamic range
|
|
1928
|
+
*/
|
|
1929
|
+
hdr_format?: 'sdr' | 'hdr10' | 'hdr10_plus' | 'hlg' | 'dolby_vision';
|
|
1930
|
+
/**
|
|
1931
|
+
* Chroma subsampling format
|
|
1932
|
+
*/
|
|
1933
|
+
chroma_subsampling?: '4:2:0' | '4:2:2' | '4:4:4';
|
|
1934
|
+
/**
|
|
1935
|
+
* Video bit depth
|
|
1936
|
+
*/
|
|
1937
|
+
video_bit_depth?: 8 | 10 | 12;
|
|
1938
|
+
/**
|
|
1939
|
+
* GOP/keyframe interval in seconds
|
|
1940
|
+
*/
|
|
1941
|
+
gop_interval_seconds?: number;
|
|
1942
|
+
gop_type?: GOPType;
|
|
1943
|
+
moov_atom_position?: MoovAtomPosition;
|
|
1944
|
+
/**
|
|
1945
|
+
* Whether the video contains an audio track
|
|
1946
|
+
*/
|
|
1947
|
+
has_audio?: boolean;
|
|
1948
|
+
/**
|
|
1949
|
+
* Audio codec used (aac, aac_lc, he_aac, pcm, mp3, ac3, eac3, etc.)
|
|
1950
|
+
*/
|
|
1951
|
+
audio_codec?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* Audio sampling rate in Hz (e.g., 44100, 48000)
|
|
1954
|
+
*/
|
|
1955
|
+
audio_sampling_rate_hz?: number;
|
|
1956
|
+
audio_channels?: AudioChannelLayout;
|
|
1957
|
+
/**
|
|
1958
|
+
* Audio bit depth
|
|
1959
|
+
*/
|
|
1960
|
+
audio_bit_depth?: 16 | 24 | 32;
|
|
1961
|
+
/**
|
|
1962
|
+
* Audio bitrate in kilobits per second
|
|
1963
|
+
* @minimum 1
|
|
1964
|
+
*/
|
|
1965
|
+
audio_bitrate_kbps?: number;
|
|
1966
|
+
/**
|
|
1967
|
+
* Integrated loudness in LUFS
|
|
1968
|
+
*/
|
|
1969
|
+
audio_loudness_lufs?: number;
|
|
1970
|
+
/**
|
|
1971
|
+
* True peak level in dBFS
|
|
1972
|
+
*/
|
|
1973
|
+
audio_true_peak_dbfs?: number;
|
|
1974
|
+
/**
|
|
1975
|
+
* URL to captions file (WebVTT, SRT, etc.)
|
|
1976
|
+
*/
|
|
1977
|
+
captions_url?: string;
|
|
1978
|
+
/**
|
|
1979
|
+
* URL to text transcript of the video content
|
|
1980
|
+
*/
|
|
1981
|
+
transcript_url?: string;
|
|
1982
|
+
/**
|
|
1983
|
+
* URL to audio description track for visually impaired users
|
|
1984
|
+
*/
|
|
1985
|
+
audio_description_url?: string;
|
|
1986
|
+
provenance?: Provenance;
|
|
1987
|
+
}
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* Media category of the watermarked content
|
|
1991
|
+
*/
|
|
1992
|
+
export type WatermarkMediaType = 'audio' | 'image' | 'video' | 'text';
|
|
1993
|
+
|
|
1994
|
+
/**
|
|
1995
|
+
* Webhook for server-side dynamic content rendering (DCO)
|
|
1996
|
+
*/
|
|
1997
|
+
export interface WebhookAsset {
|
|
1998
|
+
/**
|
|
1999
|
+
* Discriminator identifying this as a webhook asset. See /schemas/creative/asset-types for the registry.
|
|
2000
|
+
*/
|
|
2001
|
+
asset_type: 'webhook';
|
|
2002
|
+
/**
|
|
2003
|
+
* Webhook URL to call for dynamic content
|
|
2004
|
+
*/
|
|
2005
|
+
url: string;
|
|
2006
|
+
method?: HTTPMethod;
|
|
2007
|
+
/**
|
|
2008
|
+
* Maximum time to wait for response in milliseconds
|
|
2009
|
+
* @minimum 10
|
|
2010
|
+
* @maximum 5000
|
|
2011
|
+
*/
|
|
2012
|
+
timeout_ms?: number;
|
|
2013
|
+
/**
|
|
2014
|
+
* Universal macros that can be passed to webhook (e.g., DEVICE_TYPE, COUNTRY). See docs/creative/universal-macros.mdx for full list.
|
|
2015
|
+
*/
|
|
2016
|
+
supported_macros?: (UniversalMacro | string)[];
|
|
2017
|
+
/**
|
|
2018
|
+
* Universal macros that must be provided for webhook to function
|
|
2019
|
+
*/
|
|
2020
|
+
required_macros?: (UniversalMacro | string)[];
|
|
2021
|
+
response_type: WebhookResponseType;
|
|
2022
|
+
/**
|
|
2023
|
+
* Security configuration for webhook calls
|
|
2024
|
+
*/
|
|
2025
|
+
security: {
|
|
2026
|
+
method: WebhookSecurityMethod;
|
|
2027
|
+
/**
|
|
2028
|
+
* Header name for HMAC signature (e.g., 'X-Signature')
|
|
2029
|
+
*/
|
|
2030
|
+
hmac_header?: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* Header name for API key (e.g., 'X-API-Key')
|
|
2033
|
+
*/
|
|
2034
|
+
api_key_header?: string;
|
|
2035
|
+
};
|
|
2036
|
+
provenance?: Provenance;
|
|
2037
|
+
}
|
|
2038
|
+
|
|
2039
|
+
/**
|
|
2040
|
+
* Expected content type of webhook response
|
|
2041
|
+
*/
|
|
2042
|
+
export type WebhookResponseType = 'html' | 'json' | 'xml' | 'javascript';
|
|
2043
|
+
|
|
2044
|
+
/**
|
|
2045
|
+
* Authentication method
|
|
2046
|
+
*/
|
|
2047
|
+
export type WebhookSecurityMethod = 'hmac_sha256' | 'api_key' | 'none';
|
|
2048
|
+
|
|
2049
|
+
/**
|
|
2050
|
+
* 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).
|
|
2051
|
+
*/
|
|
2052
|
+
export interface ZipAsset {
|
|
2053
|
+
/**
|
|
2054
|
+
* Discriminator identifying this as a zip-bundled asset. See /schemas/creative/asset-types for the registry.
|
|
2055
|
+
*/
|
|
2056
|
+
asset_type: 'zip';
|
|
2057
|
+
/**
|
|
2058
|
+
* URL where the zip archive is hosted. Must be HTTPS.
|
|
2059
|
+
*/
|
|
2060
|
+
url: string;
|
|
2061
|
+
/**
|
|
2062
|
+
* Maximum file size in kilobytes. Receivers should reject zips exceeding this.
|
|
2063
|
+
* @minimum 0
|
|
2064
|
+
*/
|
|
2065
|
+
max_file_size_kb?: number;
|
|
2066
|
+
/**
|
|
2067
|
+
* Relative path to the entry file within the zip (typically 'index.html'). Receivers default to 'index.html' if absent.
|
|
2068
|
+
*/
|
|
2069
|
+
entry_point?: string;
|
|
2070
|
+
/**
|
|
2071
|
+
* File extensions permitted inside the zip (e.g., ['html', 'css', 'js', 'png', 'jpg', 'svg', 'webp', 'json', 'woff2']). Receivers may reject zips containing other extensions.
|
|
2072
|
+
*/
|
|
2073
|
+
allowed_inner_extensions?: string[];
|
|
2074
|
+
/**
|
|
2075
|
+
* Fallback image URL for environments that cannot render the bundled creative (e.g., non-HTML5 endpoints, ad blockers). Recommended for HTML5 banners.
|
|
2076
|
+
*/
|
|
2077
|
+
backup_image_url?: string;
|
|
2078
|
+
/**
|
|
2079
|
+
* Optional SHA-256 content digest of the zip archive (sha256:<hex>) for integrity verification. Lets receivers detect tampered or stale archives.
|
|
2080
|
+
* @pattern ^sha256:[a-f0-9]{64}$
|
|
2081
|
+
*/
|
|
2082
|
+
digest?: string;
|
|
2083
|
+
/**
|
|
2084
|
+
* Self-declared accessibility properties for this opaque creative
|
|
2085
|
+
*/
|
|
2086
|
+
accessibility?: {
|
|
2087
|
+
/**
|
|
2088
|
+
* Text alternative describing the creative content
|
|
2089
|
+
*/
|
|
2090
|
+
alt_text?: string;
|
|
2091
|
+
/**
|
|
2092
|
+
* Whether the creative can be fully operated via keyboard
|
|
2093
|
+
*/
|
|
2094
|
+
keyboard_navigable?: boolean;
|
|
2095
|
+
/**
|
|
2096
|
+
* Whether the creative respects prefers-reduced-motion or provides pause/stop controls
|
|
2097
|
+
*/
|
|
2098
|
+
motion_control?: boolean;
|
|
2099
|
+
/**
|
|
2100
|
+
* Whether the creative has been tested with screen readers
|
|
2101
|
+
*/
|
|
2102
|
+
screen_reader_tested?: boolean;
|
|
2103
|
+
};
|
|
2104
|
+
provenance?: Provenance;
|
|
2105
|
+
}
|