@adcp/sdk 8.1.0-beta.6 → 8.1.0-beta.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/dist/lib/conformance/oracle.d.ts.map +1 -1
- package/dist/lib/conformance/oracle.js +8 -1
- package/dist/lib/conformance/oracle.js.map +1 -1
- package/dist/lib/conformance/schemaArbitrary.js +135 -9
- package/dist/lib/conformance/schemaArbitrary.js.map +1 -1
- package/dist/lib/schemas-data/v2.5/_provenance.json +1 -1
- package/dist/lib/server/create-adcp-server.d.ts +5 -0
- package/dist/lib/server/create-adcp-server.d.ts.map +1 -1
- package/dist/lib/server/create-adcp-server.js +41 -3
- package/dist/lib/server/create-adcp-server.js.map +1 -1
- package/dist/lib/server/decisioning/capabilities.d.ts +8 -0
- package/dist/lib/server/decisioning/capabilities.d.ts.map +1 -1
- package/dist/lib/server/decisioning/proposal/dispatch.d.ts.map +1 -1
- package/dist/lib/server/decisioning/proposal/dispatch.js +2 -0
- package/dist/lib/server/decisioning/proposal/dispatch.js.map +1 -1
- package/dist/lib/server/decisioning/runtime/from-platform.d.ts.map +1 -1
- package/dist/lib/server/decisioning/runtime/from-platform.js +14 -1
- package/dist/lib/server/decisioning/runtime/from-platform.js.map +1 -1
- package/dist/lib/server/responses.d.ts +1 -1
- package/dist/lib/server/responses.d.ts.map +1 -1
- package/dist/lib/server/responses.js +5 -2
- package/dist/lib/server/responses.js.map +1 -1
- package/dist/lib/signing/types.d.ts +6 -0
- package/dist/lib/signing/types.d.ts.map +1 -1
- package/dist/lib/signing/types.js.map +1 -1
- package/dist/lib/signing/verifier.d.ts.map +1 -1
- package/dist/lib/signing/verifier.js +33 -4
- package/dist/lib/signing/verifier.js.map +1 -1
- package/dist/lib/testing/storyboard/compliance.d.ts +1 -0
- package/dist/lib/testing/storyboard/compliance.d.ts.map +1 -1
- package/dist/lib/testing/storyboard/compliance.js +8 -2
- package/dist/lib/testing/storyboard/compliance.js.map +1 -1
- package/dist/lib/testing/storyboard/index.d.ts +1 -1
- package/dist/lib/testing/storyboard/index.d.ts.map +1 -1
- package/dist/lib/testing/storyboard/index.js +3 -2
- package/dist/lib/testing/storyboard/index.js.map +1 -1
- package/dist/lib/testing/storyboard/probes.d.ts.map +1 -1
- package/dist/lib/testing/storyboard/probes.js +3 -0
- package/dist/lib/testing/storyboard/probes.js.map +1 -1
- package/dist/lib/testing/storyboard/runner.d.ts.map +1 -1
- package/dist/lib/testing/storyboard/runner.js +294 -29
- package/dist/lib/testing/storyboard/runner.js.map +1 -1
- package/dist/lib/testing/storyboard/types.d.ts +59 -0
- package/dist/lib/testing/storyboard/types.d.ts.map +1 -1
- package/dist/lib/testing/storyboard/types.js.map +1 -1
- package/dist/lib/testing/storyboard/validations.d.ts +4 -3
- package/dist/lib/testing/storyboard/validations.d.ts.map +1 -1
- package/dist/lib/testing/storyboard/validations.js +26 -2
- package/dist/lib/testing/storyboard/validations.js.map +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/core.generated.d.ts +180 -252
- package/dist/lib/types/core.generated.d.ts.map +1 -1
- package/dist/lib/types/core.generated.js +1 -1
- 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/schemas.generated.d.ts +127279 -125067
- package/dist/lib/types/schemas.generated.d.ts.map +1 -1
- package/dist/lib/types/schemas.generated.js +221 -293
- package/dist/lib/types/schemas.generated.js.map +1 -1
- 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/utils/response-schemas.js +1 -1
- package/dist/lib/utils/response-schemas.js.map +1 -1
- package/dist/lib/utils/response-unwrapper.d.ts.map +1 -1
- package/dist/lib/utils/response-unwrapper.js +18 -3
- package/dist/lib/utils/response-unwrapper.js.map +1 -1
- package/dist/lib/version.d.ts +3 -3
- package/dist/lib/version.js +3 -3
- package/examples/error-compliant-server.ts +1 -1
- package/examples/hello_seller_adapter_guaranteed.ts +8 -3
- package/examples/hello_seller_adapter_multi_tenant.ts +27 -23
- package/examples/hello_seller_adapter_non_guaranteed.ts +7 -3
- package/examples/hello_seller_adapter_proposal_mode.ts +22 -6
- package/examples/hello_signals_adapter_marketplace.ts +34 -3
- package/package.json +9 -2
|
@@ -0,0 +1,2390 @@
|
|
|
1
|
+
// AUTO-GENERATED — DO NOT EDIT.
|
|
2
|
+
// Per-tool .d.ts slice for `list_creatives`. Built from the published
|
|
3
|
+
// `tools.generated.d.ts` + `core.generated.d.ts` + `enums.generated.d.ts`
|
|
4
|
+
// by `scripts/generate-per-tool-types.ts`.
|
|
5
|
+
//
|
|
6
|
+
// Self-contained: imports nothing from the broader SDK. Adopters who
|
|
7
|
+
// import only this slice pay a fraction of the tsc cost of pulling in
|
|
8
|
+
// `@adcp/sdk` root — useful when strict + skipLibCheck:false adopters
|
|
9
|
+
// hit memory pressure on the full surface.
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Request parameters for querying creative assets from a creative library with filtering, sorting, and pagination. Implemented by any agent that hosts a creative library — creative agents (ad servers, creative platforms) and sales agents that manage creatives.
|
|
13
|
+
*/
|
|
14
|
+
export interface ListCreativesRequest {
|
|
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
|
+
filters?: CreativeFilters;
|
|
24
|
+
/**
|
|
25
|
+
* Sorting parameters
|
|
26
|
+
*/
|
|
27
|
+
sort?: {
|
|
28
|
+
field?: CreativeSortField;
|
|
29
|
+
direction?: SortDirection;
|
|
30
|
+
};
|
|
31
|
+
pagination?: PaginationRequest;
|
|
32
|
+
/**
|
|
33
|
+
* Include package assignment information in response
|
|
34
|
+
*/
|
|
35
|
+
include_assignments?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Include a lightweight delivery snapshot per creative (lifetime impressions and last-served date). For detailed performance analytics, use get_creative_delivery.
|
|
38
|
+
*/
|
|
39
|
+
include_snapshot?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* Include items for multi-asset formats like carousels and native ads
|
|
42
|
+
*/
|
|
43
|
+
include_items?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* Include dynamic content variable definitions (DCO slots) for each creative
|
|
46
|
+
*/
|
|
47
|
+
include_variables?: boolean;
|
|
48
|
+
/**
|
|
49
|
+
* Include pricing_options on each creative. Requires account to be provided. When false or omitted, pricing is not computed.
|
|
50
|
+
*/
|
|
51
|
+
include_pricing?: boolean;
|
|
52
|
+
/**
|
|
53
|
+
* Include soft-purged creative tombstones in the result set. When true, creatives destroyed via `creative.purged` with `purge_kind: soft` surface as tombstone records carrying `purged: true`, `purged_at`, and the purge reason — within the seller's webhook activity retention window (30 days from `purged_at`, MUST match `webhook-activity-record` retention). Hard-purged creatives MUST NOT appear regardless of this flag. When false or omitted, the result set excludes all purged creatives — same default as today.
|
|
54
|
+
*/
|
|
55
|
+
include_purged?: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* Include recent webhook activity per creative. When true, each returned creative carries a `webhook_activity[]` array of the most recent fires scoped to that creative — `creative.status_changed` and `creative.purged` deliveries. Adoption of the `webhook_activity[]` pattern per `snapshot-and-log.mdx § Webhook activity log pattern`. Retention is 30 days from `completed_at` (MUST). Three-state presence applies: omitted = seller does not surface; `[]` = persists but no recent fires; non-empty = actual records.
|
|
58
|
+
*/
|
|
59
|
+
include_webhook_activity?: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Maximum number of `webhook_activity[]` records to return per creative. Only meaningful when `include_webhook_activity: true`. Sellers MUST respect the cap; structural enforcement is provided by the response schema's `maxItems: 200` on the array.
|
|
62
|
+
* @minimum 1
|
|
63
|
+
* @maximum 200
|
|
64
|
+
*/
|
|
65
|
+
webhook_activity_limit?: number;
|
|
66
|
+
account?: AccountReference;
|
|
67
|
+
/**
|
|
68
|
+
* Specific fields to include in response (omit for all fields). The 'concept' value returns both concept_id and concept_name.
|
|
69
|
+
*/
|
|
70
|
+
fields?: ('creative_id' | 'name' | 'format_id' | 'status' | 'created_date' | 'updated_date' | 'tags' | 'assignments' | 'snapshot' | 'items' | 'variables' | 'concept' | 'pricing_options')[];
|
|
71
|
+
context?: ContextObject;
|
|
72
|
+
ext?: ExtensionObject;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Response from creative library query with filtered results, metadata, and optional enriched data
|
|
77
|
+
*/
|
|
78
|
+
export interface ListCreativesResponse {
|
|
79
|
+
/**
|
|
80
|
+
* 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).
|
|
81
|
+
*/
|
|
82
|
+
context_id?: string;
|
|
83
|
+
context?: ContextObject;
|
|
84
|
+
/**
|
|
85
|
+
* Unique identifier for tracking asynchronous operations. Present when a task requires extended processing time. Used to query task status and retrieve results when complete.
|
|
86
|
+
*/
|
|
87
|
+
task_id?: string;
|
|
88
|
+
status: TaskStatus;
|
|
89
|
+
/**
|
|
90
|
+
* 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.
|
|
91
|
+
*/
|
|
92
|
+
message?: string;
|
|
93
|
+
/**
|
|
94
|
+
* ISO 8601 timestamp when the response was generated. Useful for debugging, logging, cache validation, and tracking async operation progress.
|
|
95
|
+
*/
|
|
96
|
+
timestamp?: string;
|
|
97
|
+
/**
|
|
98
|
+
* 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.
|
|
99
|
+
*/
|
|
100
|
+
replayed?: boolean;
|
|
101
|
+
adcp_error?: Error;
|
|
102
|
+
push_notification_config?: PushNotificationConfig;
|
|
103
|
+
/**
|
|
104
|
+
* 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.
|
|
105
|
+
*
|
|
106
|
+
* 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.
|
|
107
|
+
*
|
|
108
|
+
* This is the primary correlation key for audit and reporting across the governance lifecycle.
|
|
109
|
+
*/
|
|
110
|
+
governance_context?: string;
|
|
111
|
+
/**
|
|
112
|
+
* 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.
|
|
113
|
+
*/
|
|
114
|
+
payload?: {};
|
|
115
|
+
/**
|
|
116
|
+
* 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.
|
|
117
|
+
*/
|
|
118
|
+
adcp_version?: string;
|
|
119
|
+
/**
|
|
120
|
+
* 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.
|
|
121
|
+
*/
|
|
122
|
+
adcp_major_version?: number;
|
|
123
|
+
/**
|
|
124
|
+
* Summary of the query that was executed
|
|
125
|
+
*/
|
|
126
|
+
query_summary: {
|
|
127
|
+
/**
|
|
128
|
+
* Total number of creatives matching filters (across all pages)
|
|
129
|
+
* @minimum 0
|
|
130
|
+
*/
|
|
131
|
+
total_matching: number;
|
|
132
|
+
/**
|
|
133
|
+
* Number of creatives returned in this response
|
|
134
|
+
* @minimum 0
|
|
135
|
+
*/
|
|
136
|
+
returned: number;
|
|
137
|
+
/**
|
|
138
|
+
* List of filters that were applied to the query
|
|
139
|
+
*/
|
|
140
|
+
filters_applied?: string[];
|
|
141
|
+
/**
|
|
142
|
+
* Sort order that was applied
|
|
143
|
+
*/
|
|
144
|
+
sort_applied?: {
|
|
145
|
+
field?: string;
|
|
146
|
+
direction?: SortDirection;
|
|
147
|
+
};
|
|
148
|
+
};
|
|
149
|
+
pagination: PaginationResponse;
|
|
150
|
+
/**
|
|
151
|
+
* Array of creative assets matching the query
|
|
152
|
+
*/
|
|
153
|
+
creatives: {
|
|
154
|
+
/**
|
|
155
|
+
* Unique identifier for the creative
|
|
156
|
+
*/
|
|
157
|
+
creative_id: string;
|
|
158
|
+
account?: Account;
|
|
159
|
+
/**
|
|
160
|
+
* Human-readable creative name
|
|
161
|
+
*/
|
|
162
|
+
name: string;
|
|
163
|
+
format_id: FormatReferenceStructuredObject;
|
|
164
|
+
status: CreativeStatus;
|
|
165
|
+
/**
|
|
166
|
+
* When the creative was created
|
|
167
|
+
* @format date-time
|
|
168
|
+
*/
|
|
169
|
+
created_date: string;
|
|
170
|
+
/**
|
|
171
|
+
* When the creative was last modified
|
|
172
|
+
* @format date-time
|
|
173
|
+
*/
|
|
174
|
+
updated_date: string;
|
|
175
|
+
/**
|
|
176
|
+
* Assets for this creative, keyed by asset_id. Each slot value is either a single asset object or an array of asset objects (for slots with `min`/`max > 1`). Each asset value carries an `asset_type` discriminator that selects the matching asset schema.
|
|
177
|
+
*/
|
|
178
|
+
assets?: {
|
|
179
|
+
/**
|
|
180
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
181
|
+
* via the `patternProperty` "^[a-z0-9_]+$".
|
|
182
|
+
*/
|
|
183
|
+
[k: string]: AssetVariant | AssetVariant[];
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* User-defined tags for organization and searchability
|
|
187
|
+
*/
|
|
188
|
+
tags?: string[];
|
|
189
|
+
/**
|
|
190
|
+
* Creative concept this creative belongs to. Concepts group related creatives across sizes and formats.
|
|
191
|
+
*/
|
|
192
|
+
concept_id?: string;
|
|
193
|
+
/**
|
|
194
|
+
* Human-readable concept name
|
|
195
|
+
*/
|
|
196
|
+
concept_name?: string;
|
|
197
|
+
/**
|
|
198
|
+
* Dynamic content variables (DCO slots) for this creative. Included when include_variables=true.
|
|
199
|
+
*/
|
|
200
|
+
variables?: CreativeVariable[];
|
|
201
|
+
/**
|
|
202
|
+
* Current package assignments (included when include_assignments=true)
|
|
203
|
+
*/
|
|
204
|
+
assignments?: {
|
|
205
|
+
/**
|
|
206
|
+
* Total number of active package assignments
|
|
207
|
+
* @minimum 0
|
|
208
|
+
*/
|
|
209
|
+
assignment_count: number;
|
|
210
|
+
/**
|
|
211
|
+
* List of packages this creative is assigned to
|
|
212
|
+
*/
|
|
213
|
+
assigned_packages?: {
|
|
214
|
+
/**
|
|
215
|
+
* Package identifier
|
|
216
|
+
*/
|
|
217
|
+
package_id: string;
|
|
218
|
+
/**
|
|
219
|
+
* When this assignment was created
|
|
220
|
+
* @format date-time
|
|
221
|
+
*/
|
|
222
|
+
assigned_date: string;
|
|
223
|
+
}[];
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* Lightweight delivery snapshot (included when include_snapshot=true). For detailed performance analytics, use get_creative_delivery.
|
|
227
|
+
*/
|
|
228
|
+
snapshot?: {
|
|
229
|
+
/**
|
|
230
|
+
* When this snapshot was captured by the platform
|
|
231
|
+
* @format date-time
|
|
232
|
+
*/
|
|
233
|
+
as_of: string;
|
|
234
|
+
/**
|
|
235
|
+
* Maximum age of this data in seconds. For example, 3600 means the data may be up to 1 hour old.
|
|
236
|
+
* @minimum 0
|
|
237
|
+
*/
|
|
238
|
+
staleness_seconds: number;
|
|
239
|
+
/**
|
|
240
|
+
* Lifetime impressions across all assignments. Not scoped to any date range.
|
|
241
|
+
* @minimum 0
|
|
242
|
+
*/
|
|
243
|
+
impressions: number;
|
|
244
|
+
/**
|
|
245
|
+
* Last time this creative served an impression. Absent when the creative has never served.
|
|
246
|
+
* @format date-time
|
|
247
|
+
*/
|
|
248
|
+
last_served?: string;
|
|
249
|
+
};
|
|
250
|
+
snapshot_unavailable_reason?: SnapshotUnavailableReason;
|
|
251
|
+
/**
|
|
252
|
+
* Items for multi-asset formats like carousels and native ads (included when include_items=true)
|
|
253
|
+
*/
|
|
254
|
+
items?: CreativeItem[];
|
|
255
|
+
/**
|
|
256
|
+
* Pricing options for using this creative (serving, delivery). Used by ad servers and library agents. Transformation agents expose format-level pricing on list_creative_formats instead. Present when include_pricing=true and account provided. The buyer passes the applied pricing_option_id in report_usage.
|
|
257
|
+
*/
|
|
258
|
+
pricing_options?: VendorPricingOption[];
|
|
259
|
+
/**
|
|
260
|
+
* Tombstone block — present only when this record is a soft-purged creative surfaced via `include_purged: true`. The record's `status` field reflects the last status before purge (frozen — buyers MUST treat the creative as gone; assignments, snapshot, and serving operations no longer apply). Tombstones surface for the seller's webhook activity retention window (30 days from `purge.at`). Hard purges (`purge_kind: hard` on the webhook) do not surface on this read — the [`creative.purged`](https://adcontextprotocol.org/schemas/v3/creative/creative-purged-webhook.json) webhook is the only signal.
|
|
261
|
+
*/
|
|
262
|
+
purge?: {
|
|
263
|
+
/**
|
|
264
|
+
* Always `soft` on tombstones — hard purges do not surface on this read.
|
|
265
|
+
*/
|
|
266
|
+
kind: 'soft';
|
|
267
|
+
/**
|
|
268
|
+
* ISO 8601 timestamp when the creative was destroyed. Matches the `purged_at` field on the corresponding `creative.purged` webhook fire.
|
|
269
|
+
* @format date-time
|
|
270
|
+
*/
|
|
271
|
+
at: string;
|
|
272
|
+
reason_code: CreativeEventReasonCode;
|
|
273
|
+
};
|
|
274
|
+
/**
|
|
275
|
+
* Recent webhook fires scoped to this creative — `creative.status_changed` and `creative.purged` deliveries. Present only when the request set `include_webhook_activity: true`. Each item is a `webhook-activity-record`; the `notification_type` field discriminates between status changes and purges. The `ext.creative_id` slot MAY be populated on records nested inside larger reads where the parent does not already key the array; on `list_creatives` the parent creative_id is unambiguous and `ext.creative_id` MAY be omitted. Retention: 30 days from `completed_at` (MUST). See `snapshot-and-log.mdx § Webhook activity log pattern` for the full normative contract.
|
|
276
|
+
*/
|
|
277
|
+
webhook_activity?: WebhookActivityRecord[];
|
|
278
|
+
}[];
|
|
279
|
+
/**
|
|
280
|
+
* Breakdown of creatives by format. Keys are agent-defined format identifiers, optionally including dimensions (e.g., 'display_static_300x250', 'video_30s_vast'). Key construction is platform-specific — there is no required format.
|
|
281
|
+
*/
|
|
282
|
+
format_summary?: {
|
|
283
|
+
/**
|
|
284
|
+
* Number of creatives with this format
|
|
285
|
+
* @minimum 0
|
|
286
|
+
*
|
|
287
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
288
|
+
* via the `patternProperty` "^[a-zA-Z0-9_-]+$".
|
|
289
|
+
*/
|
|
290
|
+
[k: string]: number | undefined;
|
|
291
|
+
};
|
|
292
|
+
/**
|
|
293
|
+
* Breakdown of creatives by status
|
|
294
|
+
*/
|
|
295
|
+
status_summary?: {
|
|
296
|
+
/**
|
|
297
|
+
* Number of creatives being processed
|
|
298
|
+
* @minimum 0
|
|
299
|
+
*/
|
|
300
|
+
processing?: number;
|
|
301
|
+
/**
|
|
302
|
+
* Number of approved creatives
|
|
303
|
+
* @minimum 0
|
|
304
|
+
*/
|
|
305
|
+
approved?: number;
|
|
306
|
+
/**
|
|
307
|
+
* Number of creatives pending review
|
|
308
|
+
* @minimum 0
|
|
309
|
+
*/
|
|
310
|
+
pending_review?: number;
|
|
311
|
+
/**
|
|
312
|
+
* Number of rejected creatives
|
|
313
|
+
* @minimum 0
|
|
314
|
+
*/
|
|
315
|
+
rejected?: number;
|
|
316
|
+
/**
|
|
317
|
+
* Number of archived creatives
|
|
318
|
+
* @minimum 0
|
|
319
|
+
*/
|
|
320
|
+
archived?: number;
|
|
321
|
+
};
|
|
322
|
+
/**
|
|
323
|
+
* Task-specific errors (e.g., invalid filters, account not found)
|
|
324
|
+
*/
|
|
325
|
+
errors?: Error[];
|
|
326
|
+
/**
|
|
327
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
328
|
+
*/
|
|
329
|
+
sandbox?: boolean;
|
|
330
|
+
ext?: ExtensionObject;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* Account billed for this media buy. Includes advertiser, billing proxy (if any), and rate card applied.
|
|
335
|
+
*/
|
|
336
|
+
export interface Account {
|
|
337
|
+
/**
|
|
338
|
+
* Unique identifier for this account
|
|
339
|
+
*/
|
|
340
|
+
account_id: string;
|
|
341
|
+
/**
|
|
342
|
+
* Human-readable account name (e.g., 'Acme', 'Acme c/o Pinnacle')
|
|
343
|
+
*/
|
|
344
|
+
name: string;
|
|
345
|
+
/**
|
|
346
|
+
* The advertiser whose rates apply to this account
|
|
347
|
+
*/
|
|
348
|
+
advertiser?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Optional intermediary who receives invoices on behalf of the advertiser (e.g., agency)
|
|
351
|
+
*/
|
|
352
|
+
billing_proxy?: string;
|
|
353
|
+
status: AccountStatus;
|
|
354
|
+
brand?: BrandReference;
|
|
355
|
+
/**
|
|
356
|
+
* Domain of the entity operating this account. When the brand operates directly, this is the brand's domain.
|
|
357
|
+
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
358
|
+
*/
|
|
359
|
+
operator?: string;
|
|
360
|
+
billing?: BillingParty;
|
|
361
|
+
billing_entity?: BusinessEntity;
|
|
362
|
+
/**
|
|
363
|
+
* Identifier for the rate card applied to this account
|
|
364
|
+
*/
|
|
365
|
+
rate_card?: string;
|
|
366
|
+
payment_terms?: PaymentTerms;
|
|
367
|
+
/**
|
|
368
|
+
* Maximum outstanding balance allowed
|
|
369
|
+
*/
|
|
370
|
+
credit_limit?: {
|
|
371
|
+
/**
|
|
372
|
+
* @minimum 0
|
|
373
|
+
*/
|
|
374
|
+
amount: number;
|
|
375
|
+
/**
|
|
376
|
+
* @pattern ^[A-Z]{3}$
|
|
377
|
+
*/
|
|
378
|
+
currency: string;
|
|
379
|
+
};
|
|
380
|
+
/**
|
|
381
|
+
* Present when status is 'pending_approval'. Contains next steps for completing account activation.
|
|
382
|
+
*/
|
|
383
|
+
setup?: {
|
|
384
|
+
/**
|
|
385
|
+
* URL where the human can complete the required action (credit application, legal agreement, add funds).
|
|
386
|
+
*/
|
|
387
|
+
url?: string;
|
|
388
|
+
/**
|
|
389
|
+
* Human-readable description of what's needed.
|
|
390
|
+
*/
|
|
391
|
+
message: string;
|
|
392
|
+
/**
|
|
393
|
+
* When this setup link expires.
|
|
394
|
+
* @format date-time
|
|
395
|
+
*/
|
|
396
|
+
expires_at?: string;
|
|
397
|
+
};
|
|
398
|
+
account_scope?: AccountScope;
|
|
399
|
+
/**
|
|
400
|
+
* Governance agent endpoint registered on this account. Exactly one entry per sync_governance's one-agent-per-account invariant. The array shape is preserved for wire compatibility with 3.0; `maxItems: 1` is load-bearing and mirrors the singular `governance_context` on the protocol envelope. Authentication credentials are write-only and not included in responses — use sync_governance to set or update credentials.
|
|
401
|
+
*/
|
|
402
|
+
governance_agents?: {
|
|
403
|
+
/**
|
|
404
|
+
* Governance agent endpoint URL. Must use HTTPS.
|
|
405
|
+
* @pattern ^https:\/\/
|
|
406
|
+
*/
|
|
407
|
+
url: string;
|
|
408
|
+
}[];
|
|
409
|
+
/**
|
|
410
|
+
* Cloud storage bucket where the seller delivers offline reporting files for this account. Seller provisions a dedicated bucket or a per-account prefix within a shared bucket, and grants the buyer read access out-of-band. Access MUST be scoped at the IAM layer so each account can only read its own prefix — bucket-wide grants are non-compliant even with per-account prefixes. Seller MUST revoke access when the account's status transitions to inactive, suspended, or closed. See security considerations for offline delivery in docs/media-buy/media-buys/optimization-reporting. Only present when the seller supports offline delivery (reporting_delivery_methods includes 'offline' in capabilities).
|
|
411
|
+
*/
|
|
412
|
+
reporting_bucket?: {
|
|
413
|
+
protocol: CloudStorageProtocol;
|
|
414
|
+
/**
|
|
415
|
+
* Bucket or container name
|
|
416
|
+
* @minLength 3
|
|
417
|
+
* @maxLength 63
|
|
418
|
+
* @pattern ^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$
|
|
419
|
+
*/
|
|
420
|
+
bucket: string;
|
|
421
|
+
/**
|
|
422
|
+
* Path prefix within the bucket. Seller appends date-based partitioning beneath this prefix.
|
|
423
|
+
* @maxLength 512
|
|
424
|
+
* @pattern ^[a-zA-Z0-9\/_.-]+$
|
|
425
|
+
*/
|
|
426
|
+
prefix?: string;
|
|
427
|
+
/**
|
|
428
|
+
* Cloud region for the bucket
|
|
429
|
+
* @maxLength 64
|
|
430
|
+
* @pattern ^[a-z0-9-]+$
|
|
431
|
+
*/
|
|
432
|
+
region?: string;
|
|
433
|
+
/**
|
|
434
|
+
* File format for delivered files. Parquet, Avro, and ORC use internal compression (the top-level compression field is ignored for these formats).
|
|
435
|
+
*/
|
|
436
|
+
format?: 'jsonl' | 'csv' | 'parquet' | 'avro' | 'orc';
|
|
437
|
+
/**
|
|
438
|
+
* Compression applied to delivered files
|
|
439
|
+
*/
|
|
440
|
+
compression?: 'gzip' | 'none';
|
|
441
|
+
/**
|
|
442
|
+
* How long reporting files are retained in the bucket before deletion. Buyers must read files within this window. Minimum recommended: 14 days.
|
|
443
|
+
* @minimum 1
|
|
444
|
+
*/
|
|
445
|
+
file_retention_days: number;
|
|
446
|
+
/**
|
|
447
|
+
* URL to documentation for configuring buyer read access to this bucket (IAM role, service account, etc.). Operator-facing documentation — buyer agents MUST NOT auto-fetch this URL; surface it to a human operator. If an implementation fetches it (for preview), apply webhook URL SSRF validation and do not pass the fetched content into an LLM context without indirect-prompt-injection guarding. See docs/media-buy/media-buys/optimization-reporting#security-considerations-for-offline-delivery.
|
|
448
|
+
* @pattern ^https:\/\/
|
|
449
|
+
*/
|
|
450
|
+
setup_instructions?: string;
|
|
451
|
+
};
|
|
452
|
+
/**
|
|
453
|
+
* When true, this is a sandbox account — no real platform calls, no real spend. For explicit accounts (require_operator_auth: true), sandbox accounts are pre-existing test accounts on the platform discovered via list_accounts. For implicit accounts, sandbox is part of the natural key: the same brand/operator pair can have both a production and sandbox account.
|
|
454
|
+
*/
|
|
455
|
+
sandbox?: boolean;
|
|
456
|
+
/**
|
|
457
|
+
* Account-level webhook subscriptions for notifications whose lifecycle outlives any single media buy (e.g., `creative.status_changed`, `creative.purged`, wholesale feed change payloads). Distinct from `push_notification_config` on individual operations, which anchors at a per-resource scope. Buyers register and update entries via `sync_accounts`; sellers echo the applied state here on `list_accounts` reads so buyers can verify what's active. `authentication.credentials` is write-only — sellers MUST NOT echo legacy auth credentials in this response. When two or more entries register the same `event_types`, each receives an independent fire — see #3009 multi-subscriber composition.
|
|
458
|
+
*/
|
|
459
|
+
notification_configs?: NotificationConfig[];
|
|
460
|
+
ext?: ExtensionObject;
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
/**
|
|
464
|
+
* Account for product lookup. Returns products with pricing specific to this account's rate card.
|
|
465
|
+
*/
|
|
466
|
+
export type AccountReference = {
|
|
467
|
+
/**
|
|
468
|
+
* Seller-assigned account identifier (from sync_accounts or list_accounts)
|
|
469
|
+
*/
|
|
470
|
+
account_id: string;
|
|
471
|
+
} | {
|
|
472
|
+
brand: BrandReference;
|
|
473
|
+
/**
|
|
474
|
+
* Domain of the entity operating on the brand's behalf. When the brand operates directly, this is the brand's domain.
|
|
475
|
+
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
476
|
+
*/
|
|
477
|
+
operator: string;
|
|
478
|
+
/**
|
|
479
|
+
* When true, references the sandbox account for this brand/operator pair. Defaults to false (production account).
|
|
480
|
+
*/
|
|
481
|
+
sandbox?: boolean;
|
|
482
|
+
};
|
|
483
|
+
|
|
484
|
+
/**
|
|
485
|
+
* How the seller scoped a billing account relative to the operator and brand dimensions.
|
|
486
|
+
*/
|
|
487
|
+
export type AccountScope = 'operator' | 'brand' | 'operator_brand' | 'agent';
|
|
488
|
+
|
|
489
|
+
/**
|
|
490
|
+
* Account lifecycle status. See the Accounts Protocol overview for the operations matrix showing which tasks are permitted in each state.
|
|
491
|
+
*/
|
|
492
|
+
export type AccountStatus = 'active' | 'pending_approval' | 'rejected' | 'payment_required' | 'suspended' | 'closed';
|
|
493
|
+
|
|
494
|
+
/**
|
|
495
|
+
* 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.
|
|
496
|
+
*/
|
|
497
|
+
export type AssetVariant = ImageAsset | VideoAsset | AudioAsset | VASTAsset | TextAsset | URLAsset | HTMLAsset | JavaScriptAsset | ZipAsset | WebhookAsset | CSSAsset | DAASTAsset | MarkdownAsset | BriefAsset | CatalogAsset | CardAsset;
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* Audio asset with URL and technical specifications
|
|
501
|
+
*/
|
|
502
|
+
export interface AudioAsset {
|
|
503
|
+
/**
|
|
504
|
+
* Discriminator identifying this as an audio asset. See /schemas/creative/asset-types for the registry.
|
|
505
|
+
*/
|
|
506
|
+
asset_type: 'audio';
|
|
507
|
+
/**
|
|
508
|
+
* URL to the audio asset
|
|
509
|
+
*/
|
|
510
|
+
url: string;
|
|
511
|
+
/**
|
|
512
|
+
* Audio duration in milliseconds
|
|
513
|
+
* @minimum 0
|
|
514
|
+
*/
|
|
515
|
+
duration_ms?: number;
|
|
516
|
+
/**
|
|
517
|
+
* File size in bytes
|
|
518
|
+
* @minimum 1
|
|
519
|
+
*/
|
|
520
|
+
file_size_bytes?: number;
|
|
521
|
+
/**
|
|
522
|
+
* Audio container/file format (mp3, m4a, aac, wav, ogg, flac, etc.)
|
|
523
|
+
*/
|
|
524
|
+
container_format?: string;
|
|
525
|
+
/**
|
|
526
|
+
* Audio codec used (aac, aac_lc, he_aac, pcm, mp3, vorbis, opus, flac, ac3, eac3, etc.)
|
|
527
|
+
*/
|
|
528
|
+
codec?: string;
|
|
529
|
+
/**
|
|
530
|
+
* Sampling rate in Hz (e.g., 44100, 48000, 96000)
|
|
531
|
+
*/
|
|
532
|
+
sampling_rate_hz?: number;
|
|
533
|
+
channels?: AudioChannelLayout;
|
|
534
|
+
/**
|
|
535
|
+
* Bit depth
|
|
536
|
+
*/
|
|
537
|
+
bit_depth?: 16 | 24 | 32;
|
|
538
|
+
/**
|
|
539
|
+
* Bitrate in kilobits per second
|
|
540
|
+
* @minimum 1
|
|
541
|
+
*/
|
|
542
|
+
bitrate_kbps?: number;
|
|
543
|
+
/**
|
|
544
|
+
* Integrated loudness in LUFS
|
|
545
|
+
*/
|
|
546
|
+
loudness_lufs?: number;
|
|
547
|
+
/**
|
|
548
|
+
* True peak level in dBFS
|
|
549
|
+
*/
|
|
550
|
+
true_peak_dbfs?: number;
|
|
551
|
+
/**
|
|
552
|
+
* URL to text transcript of the audio content
|
|
553
|
+
*/
|
|
554
|
+
transcript_url?: string;
|
|
555
|
+
provenance?: Provenance;
|
|
556
|
+
}
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* Audio channel configuration
|
|
560
|
+
*/
|
|
561
|
+
export type AudioChannelLayout = 'mono' | 'stereo' | '5.1' | '7.1';
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* 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.
|
|
565
|
+
*/
|
|
566
|
+
export type AuthenticationScheme = 'Bearer' | 'HMAC-SHA256';
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* Who is invoiced on this account. See billing_entity for the invoiced party's business details.
|
|
570
|
+
*/
|
|
571
|
+
export type BillingParty = 'operator' | 'agent' | 'advertiser';
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
* Brand identifier within the house portfolio. Optional for single-brand domains.
|
|
575
|
+
*/
|
|
576
|
+
export type BrandID = string;
|
|
577
|
+
|
|
578
|
+
/**
|
|
579
|
+
* Brand reference for product discovery context. Resolved to full brand identity at execution time.
|
|
580
|
+
*/
|
|
581
|
+
export interface BrandReference {
|
|
582
|
+
/**
|
|
583
|
+
* Domain where /.well-known/brand.json is hosted, or the brand's operating domain
|
|
584
|
+
* @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
|
|
585
|
+
*/
|
|
586
|
+
domain: string;
|
|
587
|
+
brand_id?: BrandID;
|
|
588
|
+
/**
|
|
589
|
+
* 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.
|
|
590
|
+
*/
|
|
591
|
+
industries?: string[];
|
|
592
|
+
/**
|
|
593
|
+
* 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.
|
|
594
|
+
*/
|
|
595
|
+
data_subject_contestation?: {
|
|
596
|
+
[k: string]: unknown | undefined;
|
|
597
|
+
};
|
|
598
|
+
/**
|
|
599
|
+
* 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.
|
|
600
|
+
*
|
|
601
|
+
* **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.
|
|
602
|
+
*/
|
|
603
|
+
brand_kit_override?: {
|
|
604
|
+
logo?: ImageAsset;
|
|
605
|
+
/**
|
|
606
|
+
* Override brand colors (hex strings).
|
|
607
|
+
*/
|
|
608
|
+
colors?: {
|
|
609
|
+
/**
|
|
610
|
+
* @pattern ^#[0-9a-fA-F]{6}$
|
|
611
|
+
*/
|
|
612
|
+
primary?: string;
|
|
613
|
+
/**
|
|
614
|
+
* @pattern ^#[0-9a-fA-F]{6}$
|
|
615
|
+
*/
|
|
616
|
+
secondary?: string;
|
|
617
|
+
/**
|
|
618
|
+
* @pattern ^#[0-9a-fA-F]{6}$
|
|
619
|
+
*/
|
|
620
|
+
accent?: string;
|
|
621
|
+
};
|
|
622
|
+
/**
|
|
623
|
+
* Override brand-voice description for surface-composed text/audio output.
|
|
624
|
+
*/
|
|
625
|
+
voice?: string;
|
|
626
|
+
/**
|
|
627
|
+
* Override tagline.
|
|
628
|
+
*/
|
|
629
|
+
tagline?: string;
|
|
630
|
+
};
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
/**
|
|
634
|
+
* 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.
|
|
635
|
+
*/
|
|
636
|
+
export interface BriefAsset {
|
|
637
|
+
/**
|
|
638
|
+
* Campaign or flight name for identification
|
|
639
|
+
*/
|
|
640
|
+
name: string;
|
|
641
|
+
/**
|
|
642
|
+
* Campaign objective that guides creative tone and call-to-action strategy
|
|
643
|
+
*/
|
|
644
|
+
objective?: 'awareness' | 'consideration' | 'conversion' | 'retention' | 'engagement';
|
|
645
|
+
/**
|
|
646
|
+
* Desired tone for this campaign, modulating the brand's base tone (e.g., 'playful and festive', 'premium and aspirational')
|
|
647
|
+
*/
|
|
648
|
+
tone?: string;
|
|
649
|
+
/**
|
|
650
|
+
* Target audience description for this campaign
|
|
651
|
+
*/
|
|
652
|
+
audience?: string;
|
|
653
|
+
/**
|
|
654
|
+
* Creative territory or positioning the campaign should occupy
|
|
655
|
+
*/
|
|
656
|
+
territory?: string;
|
|
657
|
+
/**
|
|
658
|
+
* Messaging framework for the campaign
|
|
659
|
+
*/
|
|
660
|
+
messaging?: {
|
|
661
|
+
/**
|
|
662
|
+
* Primary headline
|
|
663
|
+
*/
|
|
664
|
+
headline?: string;
|
|
665
|
+
/**
|
|
666
|
+
* Supporting tagline or sub-headline
|
|
667
|
+
*/
|
|
668
|
+
tagline?: string;
|
|
669
|
+
/**
|
|
670
|
+
* Call-to-action text
|
|
671
|
+
*/
|
|
672
|
+
cta?: string;
|
|
673
|
+
/**
|
|
674
|
+
* Key messages to communicate in priority order
|
|
675
|
+
*/
|
|
676
|
+
key_messages?: string[];
|
|
677
|
+
};
|
|
678
|
+
/**
|
|
679
|
+
* Visual and strategic reference materials such as mood boards, product shots, example creatives, and strategy documents
|
|
680
|
+
*/
|
|
681
|
+
reference_assets?: ReferenceAsset[];
|
|
682
|
+
/**
|
|
683
|
+
* Regulatory and legal compliance requirements for this campaign. Campaign-specific, regional, and product-based — distinct from brand-level disclaimers in brand.json.
|
|
684
|
+
*/
|
|
685
|
+
compliance?: {
|
|
686
|
+
/**
|
|
687
|
+
* Disclosures that must appear in creatives for this campaign. Each disclosure specifies the text, where it should appear, and which jurisdictions require it.
|
|
688
|
+
*/
|
|
689
|
+
required_disclosures?: {
|
|
690
|
+
/**
|
|
691
|
+
* The disclosure text that must appear in the creative
|
|
692
|
+
*/
|
|
693
|
+
text: string;
|
|
694
|
+
position?: DisclosurePosition;
|
|
695
|
+
/**
|
|
696
|
+
* 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.
|
|
697
|
+
*/
|
|
698
|
+
jurisdictions?: string[];
|
|
699
|
+
/**
|
|
700
|
+
* The regulation or legal authority requiring this disclosure (e.g., 'SEC Rule 156', 'FCA COBS 4.5', 'FDA 21 CFR 202')
|
|
701
|
+
*/
|
|
702
|
+
regulation?: string;
|
|
703
|
+
/**
|
|
704
|
+
* 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.
|
|
705
|
+
*/
|
|
706
|
+
min_duration_ms?: number;
|
|
707
|
+
/**
|
|
708
|
+
* 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.
|
|
709
|
+
*/
|
|
710
|
+
language?: string;
|
|
711
|
+
persistence?: DisclosurePersistence;
|
|
712
|
+
}[];
|
|
713
|
+
/**
|
|
714
|
+
* Claims that must not appear in creatives for this campaign. Creative agents should ensure generated content avoids these claims.
|
|
715
|
+
*/
|
|
716
|
+
prohibited_claims?: string[];
|
|
717
|
+
};
|
|
718
|
+
/**
|
|
719
|
+
* Discriminator identifying this as a brief asset. See /schemas/creative/asset-types for the registry.
|
|
720
|
+
*/
|
|
721
|
+
asset_type: 'brief';
|
|
722
|
+
}
|
|
723
|
+
|
|
724
|
+
/**
|
|
725
|
+
* Override the account's default billing entity for this specific buy. When provided, the seller invoices this entity instead. The seller MUST validate the invoice recipient is authorized for this account. When governance_agents are configured, the seller MUST include invoice_recipient in the check_governance request.
|
|
726
|
+
*/
|
|
727
|
+
export interface BusinessEntity {
|
|
728
|
+
/**
|
|
729
|
+
* Registered legal name of the business entity
|
|
730
|
+
* @maxLength 200
|
|
731
|
+
*/
|
|
732
|
+
legal_name: string;
|
|
733
|
+
/**
|
|
734
|
+
* VAT identification number (e.g., DE123456789 for Germany, FR12345678901 for France). Required for B2B invoicing in the EU. Must be normalized: no spaces, dots, or dashes.
|
|
735
|
+
* @pattern ^[A-Z]{2}[A-Z0-9]{2,13}$
|
|
736
|
+
*/
|
|
737
|
+
vat_id?: string;
|
|
738
|
+
/**
|
|
739
|
+
* Tax identification number for jurisdictions that do not use VAT (e.g., US EIN)
|
|
740
|
+
* @maxLength 30
|
|
741
|
+
*/
|
|
742
|
+
tax_id?: string;
|
|
743
|
+
/**
|
|
744
|
+
* Company registration number (e.g., HRB 12345 for German Handelsregister)
|
|
745
|
+
* @maxLength 50
|
|
746
|
+
*/
|
|
747
|
+
registration_number?: string;
|
|
748
|
+
/**
|
|
749
|
+
* Postal address for invoicing and legal correspondence
|
|
750
|
+
*/
|
|
751
|
+
address?: {
|
|
752
|
+
/**
|
|
753
|
+
* Street address including building number
|
|
754
|
+
* @maxLength 200
|
|
755
|
+
*/
|
|
756
|
+
street: string;
|
|
757
|
+
/**
|
|
758
|
+
* @maxLength 100
|
|
759
|
+
*/
|
|
760
|
+
city: string;
|
|
761
|
+
/**
|
|
762
|
+
* @maxLength 20
|
|
763
|
+
*/
|
|
764
|
+
postal_code: string;
|
|
765
|
+
/**
|
|
766
|
+
* State, province, or region
|
|
767
|
+
* @maxLength 100
|
|
768
|
+
*/
|
|
769
|
+
region?: string;
|
|
770
|
+
/**
|
|
771
|
+
* ISO 3166-1 alpha-2 country code
|
|
772
|
+
* @pattern ^[A-Z]{2}$
|
|
773
|
+
*/
|
|
774
|
+
country: string;
|
|
775
|
+
};
|
|
776
|
+
/**
|
|
777
|
+
* Contacts for billing, legal, and operational matters. Contains personal data subject to GDPR and equivalent regulations. Implementations MUST use this data only for invoicing and account management.
|
|
778
|
+
*/
|
|
779
|
+
contacts?: {
|
|
780
|
+
/**
|
|
781
|
+
* Contact's functional role in the business relationship
|
|
782
|
+
*/
|
|
783
|
+
role: 'billing' | 'legal' | 'creative' | 'general';
|
|
784
|
+
/**
|
|
785
|
+
* Full name of the contact
|
|
786
|
+
* @maxLength 200
|
|
787
|
+
*/
|
|
788
|
+
name?: string;
|
|
789
|
+
/**
|
|
790
|
+
* @maxLength 254
|
|
791
|
+
* @format email
|
|
792
|
+
*/
|
|
793
|
+
email?: string;
|
|
794
|
+
/**
|
|
795
|
+
* @maxLength 30
|
|
796
|
+
*/
|
|
797
|
+
phone?: string;
|
|
798
|
+
}[];
|
|
799
|
+
/**
|
|
800
|
+
* Bank account details for payment processing. Write-only: included in requests to provide payment coordinates, but MUST NOT be echoed in responses. Sellers store these details and confirm receipt without returning them.
|
|
801
|
+
*/
|
|
802
|
+
bank?: {
|
|
803
|
+
/**
|
|
804
|
+
* Name on the bank account
|
|
805
|
+
* @maxLength 200
|
|
806
|
+
*/
|
|
807
|
+
account_holder: string;
|
|
808
|
+
/**
|
|
809
|
+
* International Bank Account Number (SEPA markets)
|
|
810
|
+
* @pattern ^[A-Z]{2}[0-9]{2}[A-Z0-9]{4,30}$
|
|
811
|
+
*/
|
|
812
|
+
iban?: string;
|
|
813
|
+
/**
|
|
814
|
+
* Bank Identifier Code / SWIFT code (SEPA markets)
|
|
815
|
+
* @pattern ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$
|
|
816
|
+
*/
|
|
817
|
+
bic?: string;
|
|
818
|
+
/**
|
|
819
|
+
* Bank routing number for non-SEPA markets (e.g., US ABA routing number, Canadian transit/institution number)
|
|
820
|
+
* @maxLength 30
|
|
821
|
+
*/
|
|
822
|
+
routing_number?: string;
|
|
823
|
+
/**
|
|
824
|
+
* Bank account number for non-SEPA markets
|
|
825
|
+
* @maxLength 30
|
|
826
|
+
*/
|
|
827
|
+
account_number?: string;
|
|
828
|
+
};
|
|
829
|
+
ext?: ExtensionObject;
|
|
830
|
+
}
|
|
831
|
+
|
|
832
|
+
/**
|
|
833
|
+
* C2PA action classification for this watermark
|
|
834
|
+
*/
|
|
835
|
+
export type C2PAWatermarkAction = 'c2pa.watermarked.bound' | 'c2pa.watermarked.unbound';
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* CSS stylesheet asset
|
|
839
|
+
*/
|
|
840
|
+
export interface CSSAsset {
|
|
841
|
+
/**
|
|
842
|
+
* Discriminator identifying this as a CSS asset. See /schemas/creative/asset-types for the registry.
|
|
843
|
+
*/
|
|
844
|
+
asset_type: 'css';
|
|
845
|
+
/**
|
|
846
|
+
* CSS content
|
|
847
|
+
*/
|
|
848
|
+
content: string;
|
|
849
|
+
/**
|
|
850
|
+
* CSS media query context (e.g., 'screen', 'print')
|
|
851
|
+
*/
|
|
852
|
+
media?: string;
|
|
853
|
+
provenance?: Provenance;
|
|
854
|
+
}
|
|
855
|
+
|
|
856
|
+
/**
|
|
857
|
+
* 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"`).
|
|
858
|
+
*
|
|
859
|
+
* 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`.
|
|
860
|
+
*
|
|
861
|
+
* 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.
|
|
862
|
+
*/
|
|
863
|
+
export interface CardAsset {
|
|
864
|
+
/**
|
|
865
|
+
* Discriminator identifying this as a card asset. See /schemas/creative/asset-types for the registry.
|
|
866
|
+
*/
|
|
867
|
+
asset_type: 'card';
|
|
868
|
+
/**
|
|
869
|
+
* The card's primary visual asset. Either an `image` or `video` asset, matching the parent format's `allowed_card_media_asset_types` parameter.
|
|
870
|
+
*/
|
|
871
|
+
media: ImageAsset | VideoAsset;
|
|
872
|
+
/**
|
|
873
|
+
* 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.
|
|
874
|
+
*/
|
|
875
|
+
headline?: string;
|
|
876
|
+
/**
|
|
877
|
+
* 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.
|
|
878
|
+
*/
|
|
879
|
+
description?: string;
|
|
880
|
+
/**
|
|
881
|
+
* 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.
|
|
882
|
+
*/
|
|
883
|
+
cta?: string;
|
|
884
|
+
landing_page_url?: URLAsset;
|
|
885
|
+
/**
|
|
886
|
+
* 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.
|
|
887
|
+
*/
|
|
888
|
+
platform_extensions?: PlatformExtensionReference[];
|
|
889
|
+
provenance?: Provenance;
|
|
890
|
+
}
|
|
891
|
+
|
|
892
|
+
/**
|
|
893
|
+
* A typed data feed as a creative asset. Carries catalog context (products, stores, jobs, etc.) within the manifest's assets map.
|
|
894
|
+
*/
|
|
895
|
+
export interface CatalogAsset {
|
|
896
|
+
/**
|
|
897
|
+
* Buyer's identifier for this catalog. Required when syncing via sync_catalogs. When used in creatives, references a previously synced catalog on the account.
|
|
898
|
+
*/
|
|
899
|
+
catalog_id?: string;
|
|
900
|
+
/**
|
|
901
|
+
* Human-readable name for this catalog (e.g., 'Summer Products 2025', 'Amsterdam Store Locations').
|
|
902
|
+
*/
|
|
903
|
+
name?: string;
|
|
904
|
+
type: CatalogType;
|
|
905
|
+
/**
|
|
906
|
+
* 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.
|
|
907
|
+
*/
|
|
908
|
+
url?: string;
|
|
909
|
+
feed_format?: FeedFormat;
|
|
910
|
+
update_frequency?: UpdateFrequency;
|
|
911
|
+
/**
|
|
912
|
+
* 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.
|
|
913
|
+
*/
|
|
914
|
+
items?: {}[];
|
|
915
|
+
/**
|
|
916
|
+
* Filter catalog to specific item IDs. For offering-type catalogs, these are offering_id values. For product-type catalogs, these are SKU identifiers.
|
|
917
|
+
*/
|
|
918
|
+
ids?: string[];
|
|
919
|
+
/**
|
|
920
|
+
* 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'.
|
|
921
|
+
*/
|
|
922
|
+
gtins?: string[];
|
|
923
|
+
/**
|
|
924
|
+
* Filter catalog to items with these tags. Tags are matched using OR logic — items matching any tag are included.
|
|
925
|
+
*/
|
|
926
|
+
tags?: string[];
|
|
927
|
+
/**
|
|
928
|
+
* Filter catalog to items in this category (e.g., 'beverages/soft-drinks', 'chef-positions').
|
|
929
|
+
*/
|
|
930
|
+
category?: string;
|
|
931
|
+
/**
|
|
932
|
+
* Natural language filter for catalog items (e.g., 'all pasta sauces under $5', 'amsterdam vacancies').
|
|
933
|
+
*/
|
|
934
|
+
query?: string;
|
|
935
|
+
/**
|
|
936
|
+
* 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.
|
|
937
|
+
*/
|
|
938
|
+
conversion_events?: EventType[];
|
|
939
|
+
content_id_type?: ContentIDType;
|
|
940
|
+
/**
|
|
941
|
+
* 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.
|
|
942
|
+
*/
|
|
943
|
+
feed_field_mappings?: CatalogFieldMapping[];
|
|
944
|
+
/**
|
|
945
|
+
* Discriminator identifying this as a catalog asset. See /schemas/creative/asset-types for the registry.
|
|
946
|
+
*/
|
|
947
|
+
asset_type: 'catalog';
|
|
948
|
+
}
|
|
949
|
+
|
|
950
|
+
/**
|
|
951
|
+
* 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).
|
|
952
|
+
*/
|
|
953
|
+
export interface CatalogFieldMapping {
|
|
954
|
+
/**
|
|
955
|
+
* Field name in the external feed record. Omit when injecting a static literal value (use the value property instead).
|
|
956
|
+
*/
|
|
957
|
+
feed_field?: string;
|
|
958
|
+
/**
|
|
959
|
+
* 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.
|
|
960
|
+
*/
|
|
961
|
+
catalog_field?: string;
|
|
962
|
+
/**
|
|
963
|
+
* 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.
|
|
964
|
+
*/
|
|
965
|
+
asset_group_id?: string;
|
|
966
|
+
/**
|
|
967
|
+
* 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).
|
|
968
|
+
*/
|
|
969
|
+
value?: unknown;
|
|
970
|
+
/**
|
|
971
|
+
* Named transform to apply to the feed field value before writing to the catalog schema. See transform-specific parameters (format, timezone, by, separator).
|
|
972
|
+
*/
|
|
973
|
+
transform?: 'date' | 'divide' | 'boolean' | 'split';
|
|
974
|
+
/**
|
|
975
|
+
* 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.
|
|
976
|
+
*/
|
|
977
|
+
format?: string;
|
|
978
|
+
/**
|
|
979
|
+
* 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.
|
|
980
|
+
*/
|
|
981
|
+
timezone?: string;
|
|
982
|
+
/**
|
|
983
|
+
* For transform 'divide': the divisor to apply (e.g., 100 to convert integer cents to decimal dollars).
|
|
984
|
+
*/
|
|
985
|
+
by?: number;
|
|
986
|
+
/**
|
|
987
|
+
* For transform 'split': the separator character or string to split on. Defaults to ','.
|
|
988
|
+
*/
|
|
989
|
+
separator?: string;
|
|
990
|
+
/**
|
|
991
|
+
* 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.
|
|
992
|
+
*/
|
|
993
|
+
default?: unknown;
|
|
994
|
+
ext?: ExtensionObject;
|
|
995
|
+
}
|
|
996
|
+
|
|
997
|
+
/**
|
|
998
|
+
* 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.
|
|
999
|
+
*/
|
|
1000
|
+
export type CatalogType = 'offering' | 'product' | 'inventory' | 'store' | 'promotion' | 'hotel' | 'flight' | 'job' | 'vehicle' | 'real_estate' | 'education' | 'destination' | 'app';
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* Cloud storage protocol
|
|
1004
|
+
*/
|
|
1005
|
+
export type CloudStorageProtocol = 's3' | 'gcs' | 'azure_blob';
|
|
1006
|
+
|
|
1007
|
+
/**
|
|
1008
|
+
* 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.
|
|
1009
|
+
*/
|
|
1010
|
+
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';
|
|
1011
|
+
|
|
1012
|
+
/**
|
|
1013
|
+
* 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.
|
|
1014
|
+
*/
|
|
1015
|
+
export interface ContextObject {
|
|
1016
|
+
}
|
|
1017
|
+
|
|
1018
|
+
/**
|
|
1019
|
+
* Fixed cost per thousand impressions
|
|
1020
|
+
*/
|
|
1021
|
+
export interface CpmPricing {
|
|
1022
|
+
model: 'cpm';
|
|
1023
|
+
/**
|
|
1024
|
+
* Cost per thousand impressions
|
|
1025
|
+
* @minimum 0
|
|
1026
|
+
*/
|
|
1027
|
+
cpm: number;
|
|
1028
|
+
/**
|
|
1029
|
+
* ISO 4217 currency code
|
|
1030
|
+
* @pattern ^[A-Z]{3}$
|
|
1031
|
+
*/
|
|
1032
|
+
currency: string;
|
|
1033
|
+
ext?: ExtensionObject;
|
|
1034
|
+
}
|
|
1035
|
+
|
|
1036
|
+
/**
|
|
1037
|
+
* Categorical reason for the purge. Matches the value the seller emitted on the corresponding `creative.purged` webhook fire.
|
|
1038
|
+
*/
|
|
1039
|
+
export type CreativeEventReasonCode = 'review_passed' | 'review_failure' | 'processing_failure' | 'seller_rereview' | 'policy_revocation' | 'content_drift' | 'takedown_request' | 'advertiser_request' | 'seller_archive' | 'account_closed' | 'account_suspended' | 'retention_expired' | 'legal_erasure';
|
|
1040
|
+
|
|
1041
|
+
/**
|
|
1042
|
+
* Filter criteria for querying creatives from a creative library. By default, archived creatives are excluded from results. To include archived creatives, explicitly filter by status='archived' or include 'archived' in the statuses array.
|
|
1043
|
+
*/
|
|
1044
|
+
export interface CreativeFilters {
|
|
1045
|
+
/**
|
|
1046
|
+
* Filter creatives by owning accounts. Useful for agencies managing multiple client accounts.
|
|
1047
|
+
*/
|
|
1048
|
+
accounts?: AccountReference[];
|
|
1049
|
+
/**
|
|
1050
|
+
* Filter by creative approval statuses
|
|
1051
|
+
*/
|
|
1052
|
+
statuses?: CreativeStatus[];
|
|
1053
|
+
/**
|
|
1054
|
+
* Filter by creative tags (all tags must match)
|
|
1055
|
+
*/
|
|
1056
|
+
tags?: string[];
|
|
1057
|
+
/**
|
|
1058
|
+
* Filter by creative tags (any tag must match)
|
|
1059
|
+
*/
|
|
1060
|
+
tags_any?: string[];
|
|
1061
|
+
/**
|
|
1062
|
+
* Filter by creative names containing this text (case-insensitive)
|
|
1063
|
+
*/
|
|
1064
|
+
name_contains?: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* Filter by specific creative IDs
|
|
1067
|
+
*/
|
|
1068
|
+
creative_ids?: string[];
|
|
1069
|
+
/**
|
|
1070
|
+
* Filter creatives created after this date (ISO 8601)
|
|
1071
|
+
* @format date-time
|
|
1072
|
+
*/
|
|
1073
|
+
created_after?: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* Filter creatives created before this date (ISO 8601)
|
|
1076
|
+
* @format date-time
|
|
1077
|
+
*/
|
|
1078
|
+
created_before?: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* Filter creatives last updated after this date (ISO 8601)
|
|
1081
|
+
* @format date-time
|
|
1082
|
+
*/
|
|
1083
|
+
updated_after?: string;
|
|
1084
|
+
/**
|
|
1085
|
+
* Filter creatives last updated before this date (ISO 8601)
|
|
1086
|
+
* @format date-time
|
|
1087
|
+
*/
|
|
1088
|
+
updated_before?: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* Filter creatives assigned to any of these packages. Sales-agent-specific — standalone creative agents SHOULD ignore this filter.
|
|
1091
|
+
*/
|
|
1092
|
+
assigned_to_packages?: string[];
|
|
1093
|
+
/**
|
|
1094
|
+
* Filter creatives assigned to any of these media buys. Sales-agent-specific — standalone creative agents SHOULD ignore this filter.
|
|
1095
|
+
*/
|
|
1096
|
+
media_buy_ids?: string[];
|
|
1097
|
+
/**
|
|
1098
|
+
* Filter for unassigned creatives when true, assigned creatives when false. Sales-agent-specific — standalone creative agents SHOULD ignore this filter.
|
|
1099
|
+
*/
|
|
1100
|
+
unassigned?: boolean;
|
|
1101
|
+
/**
|
|
1102
|
+
* When true, return only creatives that have served at least one impression. When false, return only creatives that have never served.
|
|
1103
|
+
*/
|
|
1104
|
+
has_served?: boolean;
|
|
1105
|
+
/**
|
|
1106
|
+
* Filter by creative concept IDs. Concepts group related creatives across sizes and formats (e.g., Flashtalking concepts, Celtra campaign folders, CM360 creative groups).
|
|
1107
|
+
*/
|
|
1108
|
+
concept_ids?: string[];
|
|
1109
|
+
/**
|
|
1110
|
+
* Filter by structured format IDs. Returns creatives that match any of these formats.
|
|
1111
|
+
*/
|
|
1112
|
+
format_ids?: FormatReferenceStructuredObject[];
|
|
1113
|
+
/**
|
|
1114
|
+
* When true, return only creatives with dynamic variables (DCO). When false, return only static creatives.
|
|
1115
|
+
*/
|
|
1116
|
+
has_variables?: boolean;
|
|
1117
|
+
}
|
|
1118
|
+
|
|
1119
|
+
/**
|
|
1120
|
+
* Item within a multi-asset creative format. Used for carousel products, native ad components, and other formats composed of multiple distinct elements.
|
|
1121
|
+
*/
|
|
1122
|
+
export type CreativeItem = {
|
|
1123
|
+
/**
|
|
1124
|
+
* Discriminator indicating this is a media asset with content_uri
|
|
1125
|
+
*/
|
|
1126
|
+
asset_kind: 'media';
|
|
1127
|
+
/**
|
|
1128
|
+
* Type of asset. Common types: thumbnail_image, product_image, featured_image, logo
|
|
1129
|
+
*/
|
|
1130
|
+
asset_type: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* Unique identifier for the asset within the creative
|
|
1133
|
+
*/
|
|
1134
|
+
asset_id: string;
|
|
1135
|
+
/**
|
|
1136
|
+
* URL for media assets (images, videos, etc.)
|
|
1137
|
+
*/
|
|
1138
|
+
content_uri: string;
|
|
1139
|
+
} | {
|
|
1140
|
+
/**
|
|
1141
|
+
* Discriminator indicating this is a text asset with content
|
|
1142
|
+
*/
|
|
1143
|
+
asset_kind: 'text';
|
|
1144
|
+
/**
|
|
1145
|
+
* Type of asset. Common types: headline, body_text, cta_text, price_text, sponsor_name, author_name, click_url
|
|
1146
|
+
*/
|
|
1147
|
+
asset_type: string;
|
|
1148
|
+
/**
|
|
1149
|
+
* Unique identifier for the asset within the creative
|
|
1150
|
+
*/
|
|
1151
|
+
asset_id: string;
|
|
1152
|
+
/**
|
|
1153
|
+
* Text content for text-based assets like headlines, body text, CTA text, etc.
|
|
1154
|
+
*/
|
|
1155
|
+
content: string | string[];
|
|
1156
|
+
};
|
|
1157
|
+
|
|
1158
|
+
/**
|
|
1159
|
+
* Field to sort by
|
|
1160
|
+
*/
|
|
1161
|
+
export type CreativeSortField = 'created_date' | 'updated_date' | 'name' | 'status' | 'assignment_count';
|
|
1162
|
+
|
|
1163
|
+
/**
|
|
1164
|
+
* For generative creatives: set to 'approved' to finalize, 'rejected' to request regeneration with updated assets/message. Omit for non-generative creatives (system will set based on processing state).
|
|
1165
|
+
*/
|
|
1166
|
+
export type CreativeStatus = 'processing' | 'pending_review' | 'approved' | 'rejected' | 'archived';
|
|
1167
|
+
|
|
1168
|
+
/**
|
|
1169
|
+
* A dynamic content variable (DCO slot) on a creative. Variables represent content that can change at serve time — headlines, images, product data, etc.
|
|
1170
|
+
*/
|
|
1171
|
+
export interface CreativeVariable {
|
|
1172
|
+
/**
|
|
1173
|
+
* Variable identifier on the creative platform
|
|
1174
|
+
*/
|
|
1175
|
+
variable_id: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* Human-readable variable name
|
|
1178
|
+
*/
|
|
1179
|
+
name: string;
|
|
1180
|
+
/**
|
|
1181
|
+
* Data type of the variable. Each type represents a semantic content slot: text (headlines, body copy), image/video/audio (media URLs), url (clickthrough or tracking URLs), number (prices, counts), boolean (conditional flags like show_discount or is_raining), color (hex color values), date (ISO 8601 date-time for countdowns and offer expirations).
|
|
1182
|
+
*/
|
|
1183
|
+
variable_type: 'text' | 'image' | 'video' | 'audio' | 'url' | 'number' | 'boolean' | 'color' | 'date';
|
|
1184
|
+
/**
|
|
1185
|
+
* Default value used when no dynamic value is provided at serve time. All types are string-encoded: text/image/video/audio/url as literal strings, number as decimal (e.g., "42.99"), boolean as "true"/"false", color as "#RRGGBB", date as ISO 8601 (e.g., "2026-12-25T00:00:00Z").
|
|
1186
|
+
*/
|
|
1187
|
+
default_value?: string;
|
|
1188
|
+
/**
|
|
1189
|
+
* Whether this variable must have a value for the creative to serve
|
|
1190
|
+
*/
|
|
1191
|
+
required?: boolean;
|
|
1192
|
+
}
|
|
1193
|
+
|
|
1194
|
+
/**
|
|
1195
|
+
* Escape hatch for pricing constructs that do not fit cpm, percent_of_media, flat_fee, or per_unit. Use when a vendor prices via performance kickers, tiered volume, hybrid formulas, outcome-sharing, or any other model the standard forms cannot express. Requires a human-readable description and a structured metadata object that captures the parameters a buyer needs to reason about the charge. Buyers SHOULD route custom pricing through operator review before commitment — automatic selection is not recommended.
|
|
1196
|
+
*/
|
|
1197
|
+
export interface CustomPricing {
|
|
1198
|
+
model: 'custom';
|
|
1199
|
+
/**
|
|
1200
|
+
* Human-readable description of the custom pricing model. Buyers display this to the operator when requesting approval.
|
|
1201
|
+
* @minLength 1
|
|
1202
|
+
*/
|
|
1203
|
+
description: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* Structured parameters for the custom model. Keys follow lowercase_snake_case. Values may be primitives, arrays, or nested objects. Must be sufficient for a human to understand the pricing basis and for a downstream system to reconstruct the charge. Vendors SHOULD include a `summary_for_operator` string (one or two sentences, suitable for display in a buyer's operator-review UI) so reviewers across vendors see a consistent prompt. Required operator-review fields (approver role, dollar threshold for automatic approval, escalation contact) MAY be surfaced via additional keys the buyer's review surface recognizes.
|
|
1206
|
+
*/
|
|
1207
|
+
metadata: {
|
|
1208
|
+
/**
|
|
1209
|
+
* One or two sentences describing the pricing construct in plain language, displayed to the buyer's operator when requesting approval. Should not repeat the top-level `description` verbatim — summarize the charge mechanic instead (e.g., 'Base $12 CPM plus $0.50 per qualifying post-view conversion, capped at $45 CPM').
|
|
1210
|
+
* @minLength 1
|
|
1211
|
+
*/
|
|
1212
|
+
summary_for_operator?: string;
|
|
1213
|
+
};
|
|
1214
|
+
/**
|
|
1215
|
+
* ISO 4217 currency code. Present when the pricing resolves to a monetary charge in a specific currency.
|
|
1216
|
+
* @pattern ^[A-Z]{3}$
|
|
1217
|
+
*/
|
|
1218
|
+
currency?: string;
|
|
1219
|
+
ext?: ExtensionObject;
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
/**
|
|
1223
|
+
* DAAST (Digital Audio Ad Serving Template) tag for third-party audio ad serving
|
|
1224
|
+
*/
|
|
1225
|
+
export type DAASTAsset = {
|
|
1226
|
+
/**
|
|
1227
|
+
* Discriminator identifying this as a DAAST asset. See /schemas/creative/asset-types for the registry.
|
|
1228
|
+
*/
|
|
1229
|
+
asset_type: 'daast';
|
|
1230
|
+
daast_version?: DAASTVersion;
|
|
1231
|
+
/**
|
|
1232
|
+
* Expected audio duration in milliseconds (if known)
|
|
1233
|
+
* @minimum 0
|
|
1234
|
+
*/
|
|
1235
|
+
duration_ms?: number;
|
|
1236
|
+
/**
|
|
1237
|
+
* Tracking events supported by this DAAST tag
|
|
1238
|
+
*/
|
|
1239
|
+
tracking_events?: DAASTTrackingEvent[];
|
|
1240
|
+
/**
|
|
1241
|
+
* Whether companion display ads are included
|
|
1242
|
+
*/
|
|
1243
|
+
companion_ads?: boolean;
|
|
1244
|
+
/**
|
|
1245
|
+
* URL to text transcript of the audio content
|
|
1246
|
+
*/
|
|
1247
|
+
transcript_url?: string;
|
|
1248
|
+
provenance?: Provenance;
|
|
1249
|
+
} & ({
|
|
1250
|
+
/**
|
|
1251
|
+
* Discriminator indicating DAAST is delivered via URL endpoint
|
|
1252
|
+
*/
|
|
1253
|
+
delivery_type: 'url';
|
|
1254
|
+
/**
|
|
1255
|
+
* URL endpoint that returns DAAST XML
|
|
1256
|
+
*/
|
|
1257
|
+
url: string;
|
|
1258
|
+
} | {
|
|
1259
|
+
/**
|
|
1260
|
+
* Discriminator indicating DAAST is delivered as inline XML content
|
|
1261
|
+
*/
|
|
1262
|
+
delivery_type: 'inline';
|
|
1263
|
+
/**
|
|
1264
|
+
* Inline DAAST XML content
|
|
1265
|
+
*/
|
|
1266
|
+
content: string;
|
|
1267
|
+
});
|
|
1268
|
+
|
|
1269
|
+
/**
|
|
1270
|
+
* 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`.
|
|
1271
|
+
*/
|
|
1272
|
+
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';
|
|
1273
|
+
|
|
1274
|
+
/**
|
|
1275
|
+
* DAAST specification version
|
|
1276
|
+
*/
|
|
1277
|
+
export type DAASTVersion = '1.0' | '1.1';
|
|
1278
|
+
|
|
1279
|
+
/**
|
|
1280
|
+
* IPTC-aligned classification of AI involvement in producing this content
|
|
1281
|
+
*/
|
|
1282
|
+
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';
|
|
1283
|
+
|
|
1284
|
+
/**
|
|
1285
|
+
* How long the disclosure must persist during content playback or display
|
|
1286
|
+
*/
|
|
1287
|
+
export type DisclosurePersistence = 'continuous' | 'initial' | 'flexible';
|
|
1288
|
+
|
|
1289
|
+
/**
|
|
1290
|
+
* 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.
|
|
1291
|
+
*/
|
|
1292
|
+
export type DisclosurePosition = 'prominent' | 'footer' | 'audio' | 'subtitle' | 'overlay' | 'end_card' | 'pre_roll' | 'companion';
|
|
1293
|
+
|
|
1294
|
+
/**
|
|
1295
|
+
* How provenance data is carried within the content
|
|
1296
|
+
*/
|
|
1297
|
+
export type EmbeddedProvenanceMethod = 'manifest_wrapper' | 'provenance_markers';
|
|
1298
|
+
|
|
1299
|
+
/**
|
|
1300
|
+
* Standard marketing event types for event logging, aligned with IAB ECAPI
|
|
1301
|
+
*/
|
|
1302
|
+
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';
|
|
1303
|
+
|
|
1304
|
+
/**
|
|
1305
|
+
* 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.
|
|
1306
|
+
*/
|
|
1307
|
+
export interface ExtensionObject {
|
|
1308
|
+
}
|
|
1309
|
+
|
|
1310
|
+
/**
|
|
1311
|
+
* 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.
|
|
1312
|
+
*/
|
|
1313
|
+
export type FeedFormat = 'google_merchant_center' | 'facebook_catalog' | 'shopify' | 'linkedin_jobs' | 'custom';
|
|
1314
|
+
|
|
1315
|
+
/**
|
|
1316
|
+
* Fixed charge per billing period, regardless of impressions or spend. Used for licensed data bundles and audience subscriptions.
|
|
1317
|
+
*/
|
|
1318
|
+
export interface FlatFeePricing {
|
|
1319
|
+
model: 'flat_fee';
|
|
1320
|
+
/**
|
|
1321
|
+
* Fixed charge for the billing period
|
|
1322
|
+
* @minimum 0
|
|
1323
|
+
*/
|
|
1324
|
+
amount: number;
|
|
1325
|
+
/**
|
|
1326
|
+
* Billing period for the flat fee.
|
|
1327
|
+
*/
|
|
1328
|
+
period: 'monthly' | 'quarterly' | 'annual' | 'campaign';
|
|
1329
|
+
/**
|
|
1330
|
+
* ISO 4217 currency code
|
|
1331
|
+
* @pattern ^[A-Z]{3}$
|
|
1332
|
+
*/
|
|
1333
|
+
currency: string;
|
|
1334
|
+
ext?: ExtensionObject;
|
|
1335
|
+
}
|
|
1336
|
+
|
|
1337
|
+
/**
|
|
1338
|
+
* 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.
|
|
1339
|
+
*/
|
|
1340
|
+
export interface FormatReferenceStructuredObject {
|
|
1341
|
+
/**
|
|
1342
|
+
* 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.
|
|
1343
|
+
*/
|
|
1344
|
+
agent_url: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* 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.
|
|
1347
|
+
* @pattern ^[a-zA-Z0-9_-]+$
|
|
1348
|
+
*/
|
|
1349
|
+
id: string;
|
|
1350
|
+
/**
|
|
1351
|
+
* 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.
|
|
1352
|
+
* @minimum 1
|
|
1353
|
+
*/
|
|
1354
|
+
width?: number;
|
|
1355
|
+
/**
|
|
1356
|
+
* 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.
|
|
1357
|
+
* @minimum 1
|
|
1358
|
+
*/
|
|
1359
|
+
height?: number;
|
|
1360
|
+
/**
|
|
1361
|
+
* Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
|
|
1362
|
+
* @minimum 1
|
|
1363
|
+
*/
|
|
1364
|
+
duration_ms?: number;
|
|
1365
|
+
}
|
|
1366
|
+
|
|
1367
|
+
/**
|
|
1368
|
+
* Whether the video uses a constant or variable frame rate. Broadcast and SSAI contexts require constant frame rate for seamless splicing.
|
|
1369
|
+
*/
|
|
1370
|
+
export type FrameRateType = 'constant' | 'variable';
|
|
1371
|
+
|
|
1372
|
+
/**
|
|
1373
|
+
* Group of Pictures structure. SSAI and broadcast require closed GOPs for clean splice points; open GOPs may produce artifacts at ad boundaries.
|
|
1374
|
+
*/
|
|
1375
|
+
export type GOPType = 'closed' | 'open';
|
|
1376
|
+
|
|
1377
|
+
/**
|
|
1378
|
+
* 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.
|
|
1379
|
+
*/
|
|
1380
|
+
export interface HTMLAsset {
|
|
1381
|
+
/**
|
|
1382
|
+
* Discriminator identifying this as an HTML asset. See /schemas/creative/asset-types for the registry.
|
|
1383
|
+
*/
|
|
1384
|
+
asset_type: 'html';
|
|
1385
|
+
/**
|
|
1386
|
+
* HTML content
|
|
1387
|
+
*/
|
|
1388
|
+
content: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* HTML version (e.g., 'HTML5')
|
|
1391
|
+
*/
|
|
1392
|
+
version?: string;
|
|
1393
|
+
/**
|
|
1394
|
+
* Self-declared accessibility properties for this opaque creative
|
|
1395
|
+
*/
|
|
1396
|
+
accessibility?: {
|
|
1397
|
+
/**
|
|
1398
|
+
* Text alternative describing the creative content
|
|
1399
|
+
*/
|
|
1400
|
+
alt_text?: string;
|
|
1401
|
+
/**
|
|
1402
|
+
* Whether the creative can be fully operated via keyboard
|
|
1403
|
+
*/
|
|
1404
|
+
keyboard_navigable?: boolean;
|
|
1405
|
+
/**
|
|
1406
|
+
* Whether the creative respects prefers-reduced-motion or provides pause/stop controls
|
|
1407
|
+
*/
|
|
1408
|
+
motion_control?: boolean;
|
|
1409
|
+
/**
|
|
1410
|
+
* Whether the creative has been tested with screen readers
|
|
1411
|
+
*/
|
|
1412
|
+
screen_reader_tested?: boolean;
|
|
1413
|
+
};
|
|
1414
|
+
provenance?: Provenance;
|
|
1415
|
+
}
|
|
1416
|
+
|
|
1417
|
+
/**
|
|
1418
|
+
* HTTP method
|
|
1419
|
+
*/
|
|
1420
|
+
export type HTTPMethod = 'GET' | 'POST';
|
|
1421
|
+
|
|
1422
|
+
/**
|
|
1423
|
+
* Override logo asset.
|
|
1424
|
+
*/
|
|
1425
|
+
export interface ImageAsset {
|
|
1426
|
+
/**
|
|
1427
|
+
* Discriminator identifying this as an image asset. See /schemas/creative/asset-types for the registry.
|
|
1428
|
+
*/
|
|
1429
|
+
asset_type: 'image';
|
|
1430
|
+
/**
|
|
1431
|
+
* URL to the image asset
|
|
1432
|
+
*/
|
|
1433
|
+
url: string;
|
|
1434
|
+
/**
|
|
1435
|
+
* Width in pixels
|
|
1436
|
+
* @minimum 1
|
|
1437
|
+
*/
|
|
1438
|
+
width: number;
|
|
1439
|
+
/**
|
|
1440
|
+
* Height in pixels
|
|
1441
|
+
* @minimum 1
|
|
1442
|
+
*/
|
|
1443
|
+
height: number;
|
|
1444
|
+
/**
|
|
1445
|
+
* Image file format (jpg, png, gif, webp, etc.)
|
|
1446
|
+
*/
|
|
1447
|
+
format?: string;
|
|
1448
|
+
/**
|
|
1449
|
+
* Alternative text for accessibility
|
|
1450
|
+
*/
|
|
1451
|
+
alt_text?: string;
|
|
1452
|
+
provenance?: Provenance;
|
|
1453
|
+
}
|
|
1454
|
+
|
|
1455
|
+
/**
|
|
1456
|
+
* 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.
|
|
1457
|
+
*/
|
|
1458
|
+
export interface JavaScriptAsset {
|
|
1459
|
+
/**
|
|
1460
|
+
* Discriminator identifying this as a JavaScript asset. See /schemas/creative/asset-types for the registry.
|
|
1461
|
+
*/
|
|
1462
|
+
asset_type: 'javascript';
|
|
1463
|
+
/**
|
|
1464
|
+
* JavaScript content
|
|
1465
|
+
*/
|
|
1466
|
+
content: string;
|
|
1467
|
+
module_type?: JavaScriptModuleType;
|
|
1468
|
+
/**
|
|
1469
|
+
* Self-declared accessibility properties for this opaque creative
|
|
1470
|
+
*/
|
|
1471
|
+
accessibility?: {
|
|
1472
|
+
/**
|
|
1473
|
+
* Text alternative describing the creative content
|
|
1474
|
+
*/
|
|
1475
|
+
alt_text?: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* Whether the creative can be fully operated via keyboard
|
|
1478
|
+
*/
|
|
1479
|
+
keyboard_navigable?: boolean;
|
|
1480
|
+
/**
|
|
1481
|
+
* Whether the creative respects prefers-reduced-motion or provides pause/stop controls
|
|
1482
|
+
*/
|
|
1483
|
+
motion_control?: boolean;
|
|
1484
|
+
/**
|
|
1485
|
+
* Whether the creative has been tested with screen readers
|
|
1486
|
+
*/
|
|
1487
|
+
screen_reader_tested?: boolean;
|
|
1488
|
+
};
|
|
1489
|
+
provenance?: Provenance;
|
|
1490
|
+
}
|
|
1491
|
+
|
|
1492
|
+
/**
|
|
1493
|
+
* JavaScript module type
|
|
1494
|
+
*/
|
|
1495
|
+
export type JavaScriptModuleType = 'esm' | 'commonjs' | 'script';
|
|
1496
|
+
|
|
1497
|
+
/**
|
|
1498
|
+
* Markdown-formatted text content following CommonMark specification
|
|
1499
|
+
*/
|
|
1500
|
+
export interface MarkdownAsset {
|
|
1501
|
+
/**
|
|
1502
|
+
* Discriminator identifying this as a markdown asset. See /schemas/creative/asset-types for the registry.
|
|
1503
|
+
*/
|
|
1504
|
+
asset_type: 'markdown';
|
|
1505
|
+
/**
|
|
1506
|
+
* Markdown content following CommonMark spec with optional GitHub Flavored Markdown extensions
|
|
1507
|
+
*/
|
|
1508
|
+
content: string;
|
|
1509
|
+
/**
|
|
1510
|
+
* Language code (e.g., 'en', 'es', 'fr')
|
|
1511
|
+
*/
|
|
1512
|
+
language?: string;
|
|
1513
|
+
markdown_flavor?: MarkdownFlavor;
|
|
1514
|
+
/**
|
|
1515
|
+
* Whether raw HTML blocks are allowed in the markdown. False recommended for security.
|
|
1516
|
+
*/
|
|
1517
|
+
allow_raw_html?: boolean;
|
|
1518
|
+
}
|
|
1519
|
+
|
|
1520
|
+
/**
|
|
1521
|
+
* Markdown flavor used. CommonMark for strict compatibility, GFM for tables/task lists/strikethrough.
|
|
1522
|
+
*/
|
|
1523
|
+
export type MarkdownFlavor = 'commonmark' | 'gfm';
|
|
1524
|
+
|
|
1525
|
+
/**
|
|
1526
|
+
* Position of the moov atom in an MP4 container. 'start' enables progressive download without buffering the entire file; required for streaming ad delivery.
|
|
1527
|
+
*/
|
|
1528
|
+
export type MoovAtomPosition = 'start' | 'end';
|
|
1529
|
+
|
|
1530
|
+
/**
|
|
1531
|
+
* Account-level webhook subscription for notifications whose lifecycle outlives any single media buy — creative state changes, library purges, wholesale feed change webhooks, and future account-scoped events. Distinct from `push-notification-config.json`, which anchors at a per-resource operation (a single task or media buy). An account MAY register multiple notification configs to fan a single seller's events out to multiple buyer-side endpoints; each entry filters by `event_types`. As with push-notification-config, the default signing scheme is the AdCP RFC 9421 webhook profile against the seller's brand.json `agents[]` JWKS; the optional `authentication` block opts into the deprecated Bearer / HMAC-SHA256 fallback for compatibility. Credentials and shared secrets in `authentication.credentials` are write-only — sellers MUST NOT echo them back in `list_accounts` responses. Sellers MUST verify endpoint control before activating account-level notification configs for high-volume event families such as wholesale feed changes; delivery-time SSRF validation still applies to every fire.
|
|
1532
|
+
*/
|
|
1533
|
+
export interface NotificationConfig {
|
|
1534
|
+
/**
|
|
1535
|
+
* Buyer-supplied identifier for this subscription endpoint. Echoed on every webhook payload and on every `webhook_activity[]` record fired against this config so the buyer can attribute fires across multiple endpoints. MUST be unique within the account's `notification_configs[]` — uniqueness is enforced by the seller at registration time; duplicates are rejected with `errors[]`. Always required (even with a single subscriber) so the SDK contract is uniform — no conditional required-when-multiple rules to trip up implementations. Format is opaque — recommended values are short kebab-case slugs (`buyer-primary`, `audit-bus`, `dx-team`).
|
|
1536
|
+
* @minLength 1
|
|
1537
|
+
* @maxLength 64
|
|
1538
|
+
* @pattern ^[A-Za-z0-9_.:-]{1,64}$
|
|
1539
|
+
*/
|
|
1540
|
+
subscriber_id: string;
|
|
1541
|
+
/**
|
|
1542
|
+
* Webhook endpoint URL. Same wire contract as `push-notification-config.url` — `format: "uri"`, no destination-port allowlist enforced by the protocol, SSRF protection via the IP-range check defined in docs/building/by-layer/L1/security.mdx#webhook-url-validation-ssrf. For wholesale feed subscribers, sellers MUST complete an activation challenge or equivalent proof-of-control before treating the subscriber as active.
|
|
1543
|
+
*/
|
|
1544
|
+
url: string;
|
|
1545
|
+
/**
|
|
1546
|
+
* Notification types this subscriber wishes to receive on the registered `url`. The seller MUST NOT fire other types against this endpoint, and MUST NOT silently widen the filter when new types are added to `notification-type.json`. When omitted, the seller MUST default to a no-fire policy and surface an `errors[]` entry on `sync_accounts` so the buyer notices the missing filter. Values are drawn from `notification-type.json`, but only types whose contract anchors at the account scope are valid here — creative lifecycle events and wholesale feed change payloads are valid; media-buy-anchored types (`scheduled`, `final`, `delayed`, `adjusted`, `impairment`) belong on a media buy's `push_notification_config`, not on this surface; sellers MUST reject those entries as per-account validation failures with `INVALID_REQUEST` or `VALIDATION_ERROR` and `error.field` pointing at the invalid `event_types` entry rather than silently dropping them.
|
|
1547
|
+
*/
|
|
1548
|
+
event_types: NotificationType[];
|
|
1549
|
+
/**
|
|
1550
|
+
* Legacy authentication selector. Same precedence and semantics as `push-notification-config.authentication` — presence opts the seller into Bearer or HMAC-SHA256 signing; absence selects the default RFC 9421 webhook profile keyed off the seller's brand.json `agents[]` JWKS. The same signed-registration downgrade-resistance rules apply to accounts[].notification_configs[].authentication. Deprecated; removed in AdCP 4.0. Credentials are write-only and MUST NOT be echoed on `list_accounts` reads.
|
|
1551
|
+
*/
|
|
1552
|
+
authentication?: {
|
|
1553
|
+
schemes: AuthenticationScheme[];
|
|
1554
|
+
/**
|
|
1555
|
+
* Credentials for the legacy scheme. Bearer: token. HMAC-SHA256: shared secret. Minimum 32 characters. Exchanged out-of-band during onboarding. Write-only.
|
|
1556
|
+
* @minLength 32
|
|
1557
|
+
*/
|
|
1558
|
+
credentials: string;
|
|
1559
|
+
};
|
|
1560
|
+
/**
|
|
1561
|
+
* When false, the seller persists the configuration but suppresses fires. Use to pause a noisy subscriber without losing the registration. Sellers MUST NOT skip persisting the entry when `active: false` — the buyer's next `sync_accounts` MUST observe the same array, otherwise the buyer cannot distinguish pause from drop.
|
|
1562
|
+
*/
|
|
1563
|
+
active?: boolean;
|
|
1564
|
+
ext?: ExtensionObject;
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
/**
|
|
1568
|
+
* Type of push notification fired by a seller agent. Media-buy-anchored notifications (`scheduled`, `final`, `delayed`, `adjusted`, `impairment`) fire against a media buy's `push_notification_config`. Account-anchored notifications (`creative.status_changed`, `creative.purged`, `product.*`, `signal.*`, `wholesale_feed.bulk_change`) fire against an account's `notification_configs[]` entries whose `event_types` include the value — these outlive any single media buy and anchor at the account. Wholesale feed notifications carry the actual change payload in `/schemas/core/wholesale-feed-webhook.json`; receivers use `get_products` / `get_signals` with `if_wholesale_feed_version` to repair or reconcile. New notification types added to this enum MUST declare their anchor (media-buy or account) and per-type `notification_id` semantics in the enumDescription. Sellers MUST reject `notification_configs[]` entries whose `event_types` include any media-buy-anchored type, and MUST reject `push_notification_config` registrations for account-anchored types.
|
|
1569
|
+
*/
|
|
1570
|
+
export type NotificationType = 'scheduled' | 'final' | 'delayed' | 'adjusted' | 'impairment' | 'creative.status_changed' | 'creative.purged' | 'product.created' | 'product.updated' | 'product.priced' | 'product.removed' | 'signal.created' | 'signal.updated' | 'signal.priced' | 'signal.removed' | 'wholesale_feed.bulk_change';
|
|
1571
|
+
|
|
1572
|
+
/**
|
|
1573
|
+
* Standard cursor-based pagination parameters for list operations
|
|
1574
|
+
*/
|
|
1575
|
+
export interface PaginationRequest {
|
|
1576
|
+
/**
|
|
1577
|
+
* Maximum number of items to return per page
|
|
1578
|
+
* @minimum 1
|
|
1579
|
+
* @maximum 100
|
|
1580
|
+
*/
|
|
1581
|
+
max_results?: number;
|
|
1582
|
+
/**
|
|
1583
|
+
* Opaque cursor from a previous response to fetch the next page
|
|
1584
|
+
*/
|
|
1585
|
+
cursor?: string;
|
|
1586
|
+
}
|
|
1587
|
+
|
|
1588
|
+
/**
|
|
1589
|
+
* Standard cursor-based pagination metadata for list responses
|
|
1590
|
+
*/
|
|
1591
|
+
export interface PaginationResponse {
|
|
1592
|
+
/**
|
|
1593
|
+
* Whether more results are available beyond this page
|
|
1594
|
+
*/
|
|
1595
|
+
has_more: boolean;
|
|
1596
|
+
/**
|
|
1597
|
+
* Opaque cursor to pass in the next request to fetch the next page. Only present when has_more is true.
|
|
1598
|
+
*/
|
|
1599
|
+
cursor?: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* Total number of items matching the query across all pages. Optional because not all backends can efficiently compute this.
|
|
1602
|
+
* @minimum 0
|
|
1603
|
+
*/
|
|
1604
|
+
total_count?: number;
|
|
1605
|
+
}
|
|
1606
|
+
|
|
1607
|
+
/**
|
|
1608
|
+
* Payment terms agreed for this account. Binding for all invoices when the account is active.
|
|
1609
|
+
*/
|
|
1610
|
+
export type PaymentTerms = 'net_15' | 'net_30' | 'net_45' | 'net_60' | 'net_90' | 'prepay';
|
|
1611
|
+
|
|
1612
|
+
/**
|
|
1613
|
+
* Fixed price per unit of work. Used for creative transformation (per format), AI generation (per image, per token), and rendering (per variant). The unit field describes what is counted; unit_price is the cost per one unit.
|
|
1614
|
+
*/
|
|
1615
|
+
export interface PerUnitPricing {
|
|
1616
|
+
model: 'per_unit';
|
|
1617
|
+
/**
|
|
1618
|
+
* What is counted — e.g. 'format', 'image', 'token', 'variant', 'render', 'evaluation'.
|
|
1619
|
+
*/
|
|
1620
|
+
unit: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* Cost per one unit
|
|
1623
|
+
* @minimum 0
|
|
1624
|
+
*/
|
|
1625
|
+
unit_price: number;
|
|
1626
|
+
/**
|
|
1627
|
+
* ISO 4217 currency code
|
|
1628
|
+
* @pattern ^[A-Z]{3}$
|
|
1629
|
+
*/
|
|
1630
|
+
currency: string;
|
|
1631
|
+
ext?: ExtensionObject;
|
|
1632
|
+
}
|
|
1633
|
+
|
|
1634
|
+
/**
|
|
1635
|
+
* Percentage of media spend charged for this signal. When max_cpm is set, the effective rate is capped at that CPM — useful for platforms like The Trade Desk that use percent-of-media pricing with a CPM ceiling.
|
|
1636
|
+
*/
|
|
1637
|
+
export interface PercentOfMediaPricing {
|
|
1638
|
+
model: 'percent_of_media';
|
|
1639
|
+
/**
|
|
1640
|
+
* Percentage of media spend, e.g. 15 = 15%
|
|
1641
|
+
* @minimum 0
|
|
1642
|
+
* @maximum 100
|
|
1643
|
+
*/
|
|
1644
|
+
percent: number;
|
|
1645
|
+
/**
|
|
1646
|
+
* Optional CPM cap. When set, the effective charge is min(percent × media_spend_per_mille, max_cpm).
|
|
1647
|
+
* @minimum 0
|
|
1648
|
+
*/
|
|
1649
|
+
max_cpm?: number;
|
|
1650
|
+
/**
|
|
1651
|
+
* ISO 4217 currency code for the resulting charge
|
|
1652
|
+
* @pattern ^[A-Z]{3}$
|
|
1653
|
+
*/
|
|
1654
|
+
currency: string;
|
|
1655
|
+
ext?: ExtensionObject;
|
|
1656
|
+
}
|
|
1657
|
+
|
|
1658
|
+
/**
|
|
1659
|
+
* 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.
|
|
1660
|
+
*
|
|
1661
|
+
* **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.
|
|
1662
|
+
*
|
|
1663
|
+
* - **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`).
|
|
1664
|
+
* - **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.
|
|
1665
|
+
* - **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.
|
|
1666
|
+
* - **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.
|
|
1667
|
+
* - **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).
|
|
1668
|
+
* - **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).
|
|
1669
|
+
* - **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.
|
|
1670
|
+
* - **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.
|
|
1671
|
+
* - **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.
|
|
1672
|
+
* - **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.
|
|
1673
|
+
* - **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.
|
|
1674
|
+
*/
|
|
1675
|
+
export interface PlatformExtensionReference {
|
|
1676
|
+
/**
|
|
1677
|
+
* 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.
|
|
1678
|
+
* @pattern ^https:\/\/
|
|
1679
|
+
*/
|
|
1680
|
+
uri: string;
|
|
1681
|
+
/**
|
|
1682
|
+
* 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.
|
|
1683
|
+
* @pattern ^sha256:[a-f0-9]{64}$
|
|
1684
|
+
*/
|
|
1685
|
+
digest: string;
|
|
1686
|
+
}
|
|
1687
|
+
|
|
1688
|
+
/**
|
|
1689
|
+
* Provenance metadata for this asset, overrides manifest-level provenance
|
|
1690
|
+
*/
|
|
1691
|
+
export interface Provenance {
|
|
1692
|
+
digital_source_type?: DigitalSourceType;
|
|
1693
|
+
/**
|
|
1694
|
+
* AI system used to generate or modify this content. Aligns with IPTC 2025.1 AI metadata fields and C2PA claim_generator.
|
|
1695
|
+
*/
|
|
1696
|
+
ai_tool?: {
|
|
1697
|
+
/**
|
|
1698
|
+
* Name of the AI tool or model (e.g., 'DALL-E 3', 'Stable Diffusion XL', 'Gemini')
|
|
1699
|
+
*/
|
|
1700
|
+
name: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* 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.
|
|
1703
|
+
*/
|
|
1704
|
+
version?: string;
|
|
1705
|
+
/**
|
|
1706
|
+
* Organization that provides the AI tool (e.g., 'OpenAI', 'Stability AI', 'Google')
|
|
1707
|
+
*/
|
|
1708
|
+
provider?: string;
|
|
1709
|
+
};
|
|
1710
|
+
/**
|
|
1711
|
+
* 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`.
|
|
1712
|
+
*/
|
|
1713
|
+
human_oversight?: 'none' | 'prompt_only' | 'selected' | 'edited' | 'directed';
|
|
1714
|
+
/**
|
|
1715
|
+
* Party declaring this provenance. Identifies who attached the provenance claim, enabling receiving parties to assess trust.
|
|
1716
|
+
*/
|
|
1717
|
+
declared_by?: {
|
|
1718
|
+
/**
|
|
1719
|
+
* URL of the agent or service that declared this provenance
|
|
1720
|
+
*/
|
|
1721
|
+
agent_url?: string;
|
|
1722
|
+
/**
|
|
1723
|
+
* Role of the declaring party in the supply chain
|
|
1724
|
+
*/
|
|
1725
|
+
role: 'creator' | 'advertiser' | 'agency' | 'platform' | 'tool';
|
|
1726
|
+
};
|
|
1727
|
+
/**
|
|
1728
|
+
* 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.
|
|
1729
|
+
* @format date-time
|
|
1730
|
+
*/
|
|
1731
|
+
declared_at?: string;
|
|
1732
|
+
/**
|
|
1733
|
+
* When this content was created or generated (ISO 8601)
|
|
1734
|
+
* @format date-time
|
|
1735
|
+
*/
|
|
1736
|
+
created_time?: string;
|
|
1737
|
+
/**
|
|
1738
|
+
* 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.
|
|
1739
|
+
*/
|
|
1740
|
+
c2pa?: {
|
|
1741
|
+
/**
|
|
1742
|
+
* URL to the C2PA manifest store for this content
|
|
1743
|
+
*/
|
|
1744
|
+
manifest_url: string;
|
|
1745
|
+
};
|
|
1746
|
+
/**
|
|
1747
|
+
* 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`).
|
|
1748
|
+
*/
|
|
1749
|
+
embedded_provenance?: {
|
|
1750
|
+
method: EmbeddedProvenanceMethod;
|
|
1751
|
+
/**
|
|
1752
|
+
* Standard the embedding conforms to, if any (e.g., 'c2pa' for C2PA Section A.7 text manifest embedding)
|
|
1753
|
+
*/
|
|
1754
|
+
standard?: string;
|
|
1755
|
+
/**
|
|
1756
|
+
* Organization that performed the embedding (e.g., 'Encypher', 'Digimarc'). Display label and audit context — not a wire identifier.
|
|
1757
|
+
*/
|
|
1758
|
+
provider: string;
|
|
1759
|
+
/**
|
|
1760
|
+
* 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).
|
|
1761
|
+
*/
|
|
1762
|
+
verify_agent?: {
|
|
1763
|
+
/**
|
|
1764
|
+
* 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.
|
|
1765
|
+
* @pattern ^https:\/\/
|
|
1766
|
+
*/
|
|
1767
|
+
agent_url: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* 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.
|
|
1770
|
+
*/
|
|
1771
|
+
feature_id?: string;
|
|
1772
|
+
};
|
|
1773
|
+
/**
|
|
1774
|
+
* When the provenance data was embedded (ISO 8601)
|
|
1775
|
+
* @format date-time
|
|
1776
|
+
*/
|
|
1777
|
+
embedded_at?: string;
|
|
1778
|
+
}[];
|
|
1779
|
+
/**
|
|
1780
|
+
* 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`).
|
|
1781
|
+
*/
|
|
1782
|
+
watermarks?: {
|
|
1783
|
+
media_type: WatermarkMediaType;
|
|
1784
|
+
/**
|
|
1785
|
+
* Organization that applied the watermark (e.g., 'Imatag', 'Steg.AI', 'Encypher'). Display label and audit context — not a wire identifier.
|
|
1786
|
+
*/
|
|
1787
|
+
provider: string;
|
|
1788
|
+
/**
|
|
1789
|
+
* 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).
|
|
1790
|
+
*/
|
|
1791
|
+
verify_agent?: {
|
|
1792
|
+
/**
|
|
1793
|
+
* 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.
|
|
1794
|
+
* @pattern ^https:\/\/
|
|
1795
|
+
*/
|
|
1796
|
+
agent_url: string;
|
|
1797
|
+
/**
|
|
1798
|
+
* 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.
|
|
1799
|
+
*/
|
|
1800
|
+
feature_id?: string;
|
|
1801
|
+
};
|
|
1802
|
+
c2pa_action?: C2PAWatermarkAction;
|
|
1803
|
+
/**
|
|
1804
|
+
* When the watermark was applied (ISO 8601)
|
|
1805
|
+
* @format date-time
|
|
1806
|
+
*/
|
|
1807
|
+
embedded_at?: string;
|
|
1808
|
+
}[];
|
|
1809
|
+
/**
|
|
1810
|
+
* Regulatory disclosure requirements for this content. Indicates whether AI disclosure is required and under which jurisdictions.
|
|
1811
|
+
*/
|
|
1812
|
+
disclosure?: {
|
|
1813
|
+
/**
|
|
1814
|
+
* 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.
|
|
1815
|
+
*/
|
|
1816
|
+
required: boolean;
|
|
1817
|
+
/**
|
|
1818
|
+
* Jurisdictions where disclosure obligations apply
|
|
1819
|
+
*/
|
|
1820
|
+
jurisdictions?: {
|
|
1821
|
+
/**
|
|
1822
|
+
* ISO 3166-1 alpha-2 country code (e.g., 'US', 'DE', 'CN')
|
|
1823
|
+
*/
|
|
1824
|
+
country: string;
|
|
1825
|
+
/**
|
|
1826
|
+
* Sub-national region code (e.g., 'CA' for California, 'BY' for Bavaria)
|
|
1827
|
+
*/
|
|
1828
|
+
region?: string;
|
|
1829
|
+
/**
|
|
1830
|
+
* Regulation identifier (e.g., 'eu_ai_act_article_50', 'ca_sb_942', 'cn_deep_synthesis')
|
|
1831
|
+
*/
|
|
1832
|
+
regulation: string;
|
|
1833
|
+
/**
|
|
1834
|
+
* Required disclosure label text for this jurisdiction, in the local language
|
|
1835
|
+
*/
|
|
1836
|
+
label_text?: string;
|
|
1837
|
+
/**
|
|
1838
|
+
* 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.
|
|
1839
|
+
*/
|
|
1840
|
+
render_guidance?: {
|
|
1841
|
+
persistence?: DisclosurePersistence;
|
|
1842
|
+
/**
|
|
1843
|
+
* 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.
|
|
1844
|
+
* @minimum 1
|
|
1845
|
+
*/
|
|
1846
|
+
min_duration_ms?: number;
|
|
1847
|
+
/**
|
|
1848
|
+
* Preferred disclosure positions in priority order. The first position a format supports should be used.
|
|
1849
|
+
*/
|
|
1850
|
+
positions?: DisclosurePosition[];
|
|
1851
|
+
ext?: ExtensionObject;
|
|
1852
|
+
};
|
|
1853
|
+
}[];
|
|
1854
|
+
};
|
|
1855
|
+
/**
|
|
1856
|
+
* 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.
|
|
1857
|
+
*/
|
|
1858
|
+
verification?: {
|
|
1859
|
+
/**
|
|
1860
|
+
* Name of the verification service (e.g., 'DoubleVerify', 'Hive Moderation', 'Reality Defender')
|
|
1861
|
+
*/
|
|
1862
|
+
verified_by: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* When the verification was performed (ISO 8601)
|
|
1865
|
+
* @format date-time
|
|
1866
|
+
*/
|
|
1867
|
+
verified_time?: string;
|
|
1868
|
+
/**
|
|
1869
|
+
* Verification outcome
|
|
1870
|
+
*/
|
|
1871
|
+
result: 'authentic' | 'ai_generated' | 'ai_modified' | 'inconclusive';
|
|
1872
|
+
/**
|
|
1873
|
+
* Confidence score of the verification result (0.0 to 1.0)
|
|
1874
|
+
* @minimum 0
|
|
1875
|
+
* @maximum 1
|
|
1876
|
+
*/
|
|
1877
|
+
confidence?: number;
|
|
1878
|
+
/**
|
|
1879
|
+
* URL to the full verification report
|
|
1880
|
+
*/
|
|
1881
|
+
details_url?: string;
|
|
1882
|
+
}[];
|
|
1883
|
+
ext?: ExtensionObject;
|
|
1884
|
+
}
|
|
1885
|
+
|
|
1886
|
+
/**
|
|
1887
|
+
* 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.
|
|
1888
|
+
*/
|
|
1889
|
+
export interface PushNotificationConfig {
|
|
1890
|
+
/**
|
|
1891
|
+
* 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).
|
|
1892
|
+
*/
|
|
1893
|
+
url: string;
|
|
1894
|
+
/**
|
|
1895
|
+
* 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`.
|
|
1896
|
+
* @minLength 1
|
|
1897
|
+
* @maxLength 255
|
|
1898
|
+
* @pattern ^[A-Za-z0-9_.:-]{1,255}$
|
|
1899
|
+
*/
|
|
1900
|
+
operation_id?: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* 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.
|
|
1903
|
+
* @minLength 16
|
|
1904
|
+
* @maxLength 4096
|
|
1905
|
+
*/
|
|
1906
|
+
token?: string;
|
|
1907
|
+
/**
|
|
1908
|
+
* 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).
|
|
1909
|
+
*/
|
|
1910
|
+
authentication?: {
|
|
1911
|
+
/**
|
|
1912
|
+
* 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.
|
|
1913
|
+
*/
|
|
1914
|
+
schemes: AuthenticationScheme[];
|
|
1915
|
+
/**
|
|
1916
|
+
* 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.
|
|
1917
|
+
* @minLength 32
|
|
1918
|
+
*/
|
|
1919
|
+
credentials: string;
|
|
1920
|
+
};
|
|
1921
|
+
}
|
|
1922
|
+
|
|
1923
|
+
/**
|
|
1924
|
+
* 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.
|
|
1925
|
+
*/
|
|
1926
|
+
export interface ReferenceAsset {
|
|
1927
|
+
/**
|
|
1928
|
+
* URL to the reference asset (image, video, or document)
|
|
1929
|
+
*/
|
|
1930
|
+
url: string;
|
|
1931
|
+
/**
|
|
1932
|
+
* 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
|
|
1933
|
+
*/
|
|
1934
|
+
role: 'style_reference' | 'product_shot' | 'mood_board' | 'example_creative' | 'logo' | 'strategy_doc' | 'storyboard';
|
|
1935
|
+
/**
|
|
1936
|
+
* Human-readable description of the asset and how it should inform creative generation
|
|
1937
|
+
*/
|
|
1938
|
+
description?: string;
|
|
1939
|
+
}
|
|
1940
|
+
|
|
1941
|
+
/**
|
|
1942
|
+
* Video scan method. Modern digital delivery requires progressive scan; interlaced is retained for broadcast legacy content.
|
|
1943
|
+
*/
|
|
1944
|
+
export type ScanType = 'progressive' | 'interlaced';
|
|
1945
|
+
|
|
1946
|
+
/**
|
|
1947
|
+
* Machine-readable reason the snapshot is omitted. Present only when include_snapshot was true and snapshot is unavailable for this package.
|
|
1948
|
+
*/
|
|
1949
|
+
export type SnapshotUnavailableReason = 'SNAPSHOT_UNSUPPORTED' | 'SNAPSHOT_TEMPORARILY_UNAVAILABLE' | 'SNAPSHOT_PERMISSION_DENIED';
|
|
1950
|
+
|
|
1951
|
+
/**
|
|
1952
|
+
* Sort direction
|
|
1953
|
+
*/
|
|
1954
|
+
export type SortDirection = 'asc' | 'desc';
|
|
1955
|
+
|
|
1956
|
+
/**
|
|
1957
|
+
* 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.
|
|
1958
|
+
*/
|
|
1959
|
+
export type TaskStatus = 'submitted' | 'working' | 'input-required' | 'completed' | 'canceled' | 'failed' | 'rejected' | 'auth-required' | 'unknown';
|
|
1960
|
+
|
|
1961
|
+
/**
|
|
1962
|
+
* Text content asset
|
|
1963
|
+
*/
|
|
1964
|
+
export interface TextAsset {
|
|
1965
|
+
/**
|
|
1966
|
+
* Discriminator identifying this as a text asset. See /schemas/creative/asset-types for the registry.
|
|
1967
|
+
*/
|
|
1968
|
+
asset_type: 'text';
|
|
1969
|
+
/**
|
|
1970
|
+
* Text content
|
|
1971
|
+
*/
|
|
1972
|
+
content: string;
|
|
1973
|
+
/**
|
|
1974
|
+
* Language code (e.g., 'en', 'es', 'fr')
|
|
1975
|
+
*/
|
|
1976
|
+
language?: string;
|
|
1977
|
+
provenance?: Provenance;
|
|
1978
|
+
}
|
|
1979
|
+
|
|
1980
|
+
/**
|
|
1981
|
+
* 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.
|
|
1982
|
+
*/
|
|
1983
|
+
export interface URLAsset {
|
|
1984
|
+
/**
|
|
1985
|
+
* Discriminator identifying this as a URL asset. See /schemas/creative/asset-types for the registry.
|
|
1986
|
+
*/
|
|
1987
|
+
asset_type: 'url';
|
|
1988
|
+
/**
|
|
1989
|
+
* 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.
|
|
1990
|
+
*/
|
|
1991
|
+
url: string;
|
|
1992
|
+
url_type?: URLAssetType;
|
|
1993
|
+
/**
|
|
1994
|
+
* Description of what this URL points to
|
|
1995
|
+
*/
|
|
1996
|
+
description?: string;
|
|
1997
|
+
provenance?: Provenance;
|
|
1998
|
+
}
|
|
1999
|
+
|
|
2000
|
+
/**
|
|
2001
|
+
* 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.
|
|
2002
|
+
*/
|
|
2003
|
+
export type URLAssetType = 'clickthrough' | 'tracker_pixel' | 'tracker_script';
|
|
2004
|
+
|
|
2005
|
+
/**
|
|
2006
|
+
* 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.
|
|
2007
|
+
*/
|
|
2008
|
+
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';
|
|
2009
|
+
|
|
2010
|
+
/**
|
|
2011
|
+
* 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.
|
|
2012
|
+
*/
|
|
2013
|
+
export type UpdateFrequency = 'realtime' | 'hourly' | 'daily' | 'weekly';
|
|
2014
|
+
|
|
2015
|
+
/**
|
|
2016
|
+
* VAST (Video Ad Serving Template) tag for third-party video ad serving
|
|
2017
|
+
*/
|
|
2018
|
+
export type VASTAsset = {
|
|
2019
|
+
/**
|
|
2020
|
+
* Discriminator identifying this as a VAST asset. See /schemas/creative/asset-types for the registry.
|
|
2021
|
+
*/
|
|
2022
|
+
asset_type: 'vast';
|
|
2023
|
+
vast_version?: VASTVersion;
|
|
2024
|
+
/**
|
|
2025
|
+
* Whether VPAID (Video Player-Ad Interface Definition) is supported
|
|
2026
|
+
*/
|
|
2027
|
+
vpaid_enabled?: boolean;
|
|
2028
|
+
/**
|
|
2029
|
+
* Expected video duration in milliseconds (if known)
|
|
2030
|
+
* @minimum 0
|
|
2031
|
+
*/
|
|
2032
|
+
duration_ms?: number;
|
|
2033
|
+
/**
|
|
2034
|
+
* Tracking events supported by this VAST tag
|
|
2035
|
+
*/
|
|
2036
|
+
tracking_events?: VASTTrackingEvent[];
|
|
2037
|
+
/**
|
|
2038
|
+
* URL to captions file (WebVTT, SRT, etc.)
|
|
2039
|
+
*/
|
|
2040
|
+
captions_url?: string;
|
|
2041
|
+
/**
|
|
2042
|
+
* URL to audio description track for visually impaired users
|
|
2043
|
+
*/
|
|
2044
|
+
audio_description_url?: string;
|
|
2045
|
+
provenance?: Provenance;
|
|
2046
|
+
} & ({
|
|
2047
|
+
/**
|
|
2048
|
+
* Discriminator indicating VAST is delivered via URL endpoint
|
|
2049
|
+
*/
|
|
2050
|
+
delivery_type: 'url';
|
|
2051
|
+
/**
|
|
2052
|
+
* URL endpoint that returns VAST XML
|
|
2053
|
+
*/
|
|
2054
|
+
url: string;
|
|
2055
|
+
} | {
|
|
2056
|
+
/**
|
|
2057
|
+
* Discriminator indicating VAST is delivered as inline XML content
|
|
2058
|
+
*/
|
|
2059
|
+
delivery_type: 'inline';
|
|
2060
|
+
/**
|
|
2061
|
+
* Inline VAST XML content
|
|
2062
|
+
*/
|
|
2063
|
+
content: string;
|
|
2064
|
+
});
|
|
2065
|
+
|
|
2066
|
+
/**
|
|
2067
|
+
* 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.
|
|
2068
|
+
*/
|
|
2069
|
+
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';
|
|
2070
|
+
|
|
2071
|
+
/**
|
|
2072
|
+
* VAST specification version
|
|
2073
|
+
*/
|
|
2074
|
+
export type VASTVersion = '2.0' | '3.0' | '4.0' | '4.1' | '4.2';
|
|
2075
|
+
|
|
2076
|
+
/**
|
|
2077
|
+
* Pricing model for a vendor service. Discriminated by model: 'cpm' (fixed CPM), 'percent_of_media' (percentage of spend with optional CPM cap), 'flat_fee' (fixed charge per reporting period), 'per_unit' (fixed price per unit of work), or 'custom' (escape hatch for models not covered by the enumerated forms — requires a description and structured metadata).
|
|
2078
|
+
*/
|
|
2079
|
+
export type VendorPricing = CpmPricing | PercentOfMediaPricing | FlatFeePricing | PerUnitPricing | CustomPricing;
|
|
2080
|
+
|
|
2081
|
+
/**
|
|
2082
|
+
* A pricing option offered by a vendor agent (signals, creative, governance). Combines pricing_option_id with the pricing model fields. Pass pricing_option_id in report_usage for billing verification. All vendor discovery responses return pricing_options as an array — vendors may offer multiple options (volume tiers, context-specific rates, different models per product line).
|
|
2083
|
+
*/
|
|
2084
|
+
export type VendorPricingOption = {
|
|
2085
|
+
/**
|
|
2086
|
+
* Opaque identifier for this pricing option, unique within the vendor agent. Pass this in report_usage to identify which pricing option was applied.
|
|
2087
|
+
*/
|
|
2088
|
+
pricing_option_id: string;
|
|
2089
|
+
} & VendorPricing;
|
|
2090
|
+
|
|
2091
|
+
/**
|
|
2092
|
+
* Video asset with URL and technical specifications including audio track properties
|
|
2093
|
+
*/
|
|
2094
|
+
export interface VideoAsset {
|
|
2095
|
+
/**
|
|
2096
|
+
* Discriminator identifying this as a video asset. See /schemas/creative/asset-types for the registry.
|
|
2097
|
+
*/
|
|
2098
|
+
asset_type: 'video';
|
|
2099
|
+
/**
|
|
2100
|
+
* URL to the video asset
|
|
2101
|
+
*/
|
|
2102
|
+
url: string;
|
|
2103
|
+
/**
|
|
2104
|
+
* Width in pixels
|
|
2105
|
+
* @minimum 1
|
|
2106
|
+
*/
|
|
2107
|
+
width: number;
|
|
2108
|
+
/**
|
|
2109
|
+
* Height in pixels
|
|
2110
|
+
* @minimum 1
|
|
2111
|
+
*/
|
|
2112
|
+
height: number;
|
|
2113
|
+
/**
|
|
2114
|
+
* Video duration in milliseconds
|
|
2115
|
+
* @minimum 1
|
|
2116
|
+
*/
|
|
2117
|
+
duration_ms?: number;
|
|
2118
|
+
/**
|
|
2119
|
+
* File size in bytes
|
|
2120
|
+
* @minimum 1
|
|
2121
|
+
*/
|
|
2122
|
+
file_size_bytes?: number;
|
|
2123
|
+
/**
|
|
2124
|
+
* Video container format (mp4, webm, mov, etc.)
|
|
2125
|
+
*/
|
|
2126
|
+
container_format?: string;
|
|
2127
|
+
/**
|
|
2128
|
+
* Video codec used (h264, h265, vp9, av1, prores, etc.)
|
|
2129
|
+
*/
|
|
2130
|
+
video_codec?: string;
|
|
2131
|
+
/**
|
|
2132
|
+
* Video stream bitrate in kilobits per second
|
|
2133
|
+
* @minimum 1
|
|
2134
|
+
*/
|
|
2135
|
+
video_bitrate_kbps?: number;
|
|
2136
|
+
/**
|
|
2137
|
+
* Frame rate as string to preserve precision (e.g., '23.976', '29.97', '30')
|
|
2138
|
+
*/
|
|
2139
|
+
frame_rate?: string;
|
|
2140
|
+
frame_rate_type?: FrameRateType;
|
|
2141
|
+
scan_type?: ScanType;
|
|
2142
|
+
/**
|
|
2143
|
+
* Color space of the video
|
|
2144
|
+
*/
|
|
2145
|
+
color_space?: 'rec709' | 'rec2020' | 'rec2100' | 'srgb' | 'dci_p3';
|
|
2146
|
+
/**
|
|
2147
|
+
* HDR format if applicable, or 'sdr' for standard dynamic range
|
|
2148
|
+
*/
|
|
2149
|
+
hdr_format?: 'sdr' | 'hdr10' | 'hdr10_plus' | 'hlg' | 'dolby_vision';
|
|
2150
|
+
/**
|
|
2151
|
+
* Chroma subsampling format
|
|
2152
|
+
*/
|
|
2153
|
+
chroma_subsampling?: '4:2:0' | '4:2:2' | '4:4:4';
|
|
2154
|
+
/**
|
|
2155
|
+
* Video bit depth
|
|
2156
|
+
*/
|
|
2157
|
+
video_bit_depth?: 8 | 10 | 12;
|
|
2158
|
+
/**
|
|
2159
|
+
* GOP/keyframe interval in seconds
|
|
2160
|
+
*/
|
|
2161
|
+
gop_interval_seconds?: number;
|
|
2162
|
+
gop_type?: GOPType;
|
|
2163
|
+
moov_atom_position?: MoovAtomPosition;
|
|
2164
|
+
/**
|
|
2165
|
+
* Whether the video contains an audio track
|
|
2166
|
+
*/
|
|
2167
|
+
has_audio?: boolean;
|
|
2168
|
+
/**
|
|
2169
|
+
* Audio codec used (aac, aac_lc, he_aac, pcm, mp3, ac3, eac3, etc.)
|
|
2170
|
+
*/
|
|
2171
|
+
audio_codec?: string;
|
|
2172
|
+
/**
|
|
2173
|
+
* Audio sampling rate in Hz (e.g., 44100, 48000)
|
|
2174
|
+
*/
|
|
2175
|
+
audio_sampling_rate_hz?: number;
|
|
2176
|
+
audio_channels?: AudioChannelLayout;
|
|
2177
|
+
/**
|
|
2178
|
+
* Audio bit depth
|
|
2179
|
+
*/
|
|
2180
|
+
audio_bit_depth?: 16 | 24 | 32;
|
|
2181
|
+
/**
|
|
2182
|
+
* Audio bitrate in kilobits per second
|
|
2183
|
+
* @minimum 1
|
|
2184
|
+
*/
|
|
2185
|
+
audio_bitrate_kbps?: number;
|
|
2186
|
+
/**
|
|
2187
|
+
* Integrated loudness in LUFS
|
|
2188
|
+
*/
|
|
2189
|
+
audio_loudness_lufs?: number;
|
|
2190
|
+
/**
|
|
2191
|
+
* True peak level in dBFS
|
|
2192
|
+
*/
|
|
2193
|
+
audio_true_peak_dbfs?: number;
|
|
2194
|
+
/**
|
|
2195
|
+
* URL to captions file (WebVTT, SRT, etc.)
|
|
2196
|
+
*/
|
|
2197
|
+
captions_url?: string;
|
|
2198
|
+
/**
|
|
2199
|
+
* URL to text transcript of the video content
|
|
2200
|
+
*/
|
|
2201
|
+
transcript_url?: string;
|
|
2202
|
+
/**
|
|
2203
|
+
* URL to audio description track for visually impaired users
|
|
2204
|
+
*/
|
|
2205
|
+
audio_description_url?: string;
|
|
2206
|
+
provenance?: Provenance;
|
|
2207
|
+
}
|
|
2208
|
+
|
|
2209
|
+
/**
|
|
2210
|
+
* Media category of the watermarked content
|
|
2211
|
+
*/
|
|
2212
|
+
export type WatermarkMediaType = 'audio' | 'image' | 'video' | 'text';
|
|
2213
|
+
|
|
2214
|
+
/**
|
|
2215
|
+
* Single webhook delivery attempt surfaced to a calling principal as a buyer-side debug aid. Represents one HTTP attempt of a logical webhook fire from the seller to the buyer's registered endpoint — retries of the same logical fire share `idempotency_key` and differ by `attempt`. This is the canonical record shape for any AdCP resource that exposes a `webhook_activity[]` log on its read API; see snapshot-and-log.mdx § Webhook activity log pattern for the full normative contract (scoping, retention, three-state presence, request-field conventions).
|
|
2216
|
+
*/
|
|
2217
|
+
export interface WebhookActivityRecord {
|
|
2218
|
+
/**
|
|
2219
|
+
* Equals the `idempotency_key` carried in the webhook payload itself (see docs/building/by-layer/L3/webhooks.mdx § Dedup by `idempotency_key`). Stable across retry attempts of the same logical fire — retries with `attempt` > 1 reuse this key. Buyers correlate this surface with their own endpoint logs via this exact field; the spec deliberately reuses the payload key rather than minting a parallel `delivery_id` so callers do not need a join table. Format is sender-defined; callers MUST treat as opaque.
|
|
2220
|
+
*/
|
|
2221
|
+
idempotency_key: string;
|
|
2222
|
+
/**
|
|
2223
|
+
* Identifies which registered webhook subscriber received this fire. **Required on records from account-anchored notification channels** (`notification_configs[]` registered via `sync_accounts`) — every subscriber has a `subscriber_id` at registration time, the seller MUST echo it on every fire and every activity record. **Optional on records from per-resource push channels** (`push_notification_config` on a media buy or task) — the calling principal is unambiguous in single-subscriber configurations and the field MAY be omitted; sellers MUST populate it once `reporting_webhook` adopts multi-subscriber (per #3009 in AdCP 4.0). Buyers MUST NOT use absence as a signal that no other subscribers exist; that information is not exposed by this surface.
|
|
2224
|
+
*/
|
|
2225
|
+
subscriber_id?: string;
|
|
2226
|
+
/**
|
|
2227
|
+
* ISO 8601 timestamp when the seller initiated the HTTP request for this attempt.
|
|
2228
|
+
* @format date-time
|
|
2229
|
+
*/
|
|
2230
|
+
fired_at: string;
|
|
2231
|
+
/**
|
|
2232
|
+
* ISO 8601 timestamp when the seller observed the response (or terminal timeout / connection error — for `timeout` and `connection_error` outcomes, `completed_at` is set to the moment the seller declared the attempt terminal). Explicitly `null` when the attempt is still in flight or queued for retry (status `pending`); MUST be set as `null` rather than omitted so callers can distinguish 'still in flight' from 'field missing'.
|
|
2233
|
+
* @format date-time
|
|
2234
|
+
*/
|
|
2235
|
+
completed_at?: string | null;
|
|
2236
|
+
notification_type: NotificationType;
|
|
2237
|
+
/**
|
|
2238
|
+
* Sequence number from the webhook payload. Surfaced here so the buyer can spot stale-sequence drops and gaps without correlating against their own endpoint log. Absent for notification types that do not carry a sequence number.
|
|
2239
|
+
* @minimum 0
|
|
2240
|
+
*/
|
|
2241
|
+
sequence_number?: number;
|
|
2242
|
+
/**
|
|
2243
|
+
* 1-indexed retry counter for this logical fire. Initial fire is attempt=1; retries increment. Sellers MUST emit one record per attempt, so a successful first-attempt fire appears as a single record with `attempt: 1` and a 3-attempt retry trail appears as three records sharing `idempotency_key`.
|
|
2244
|
+
* @minimum 1
|
|
2245
|
+
*/
|
|
2246
|
+
attempt: number;
|
|
2247
|
+
/**
|
|
2248
|
+
* Outcome of this attempt. `success` — response received with 2xx (`http_status_code` populated). `failed` — response received with non-2xx (`http_status_code` populated). `timeout` — no response within the seller's configured timeout (`http_status_code` null). `connection_error` — DNS / TLS / socket failure before any HTTP response (`http_status_code` null). `pending` — attempt is in flight or queued for retry (`completed_at` null, `http_status_code` null). The `timeout` / `connection_error` split is intentional and operationally distinct: `timeout` typically signals a slow / overloaded buyer endpoint, `connection_error` typically signals it is unreachable or misconfigured.
|
|
2249
|
+
*/
|
|
2250
|
+
status: 'success' | 'failed' | 'timeout' | 'connection_error' | 'pending';
|
|
2251
|
+
/**
|
|
2252
|
+
* Target URL for this fire. Query string and fragment MUST be stripped before surfacing — buyers commonly stash bearer tokens in the query string and sellers MUST NOT echo those back through this debug surface. Sellers SHOULD additionally redact path segments matching obvious secret patterns (e.g., a path segment that is high-entropy random material or matches a UUID / token format). Buyers matching this against their own configured URL should compare by origin + path; query strings will not match and that mismatch is expected.
|
|
2253
|
+
*/
|
|
2254
|
+
url: string;
|
|
2255
|
+
/**
|
|
2256
|
+
* HTTP status code returned by the buyer's endpoint. Explicitly `null` when no HTTP response was received (status `timeout`, `connection_error`, or `pending`); MUST be set as `null` rather than omitted.
|
|
2257
|
+
* @minimum 100
|
|
2258
|
+
* @maximum 599
|
|
2259
|
+
*/
|
|
2260
|
+
http_status_code?: number | null;
|
|
2261
|
+
/**
|
|
2262
|
+
* Wall-clock latency between request send and response receipt, in milliseconds. Explicitly `null` when the attempt did not complete (`timeout`, `connection_error`, `pending`); MUST be set as `null` rather than omitted.
|
|
2263
|
+
* @minimum 0
|
|
2264
|
+
*/
|
|
2265
|
+
response_time_ms?: number | null;
|
|
2266
|
+
/**
|
|
2267
|
+
* Size of the request body the seller sent, in bytes. Useful for diagnosing oversized-payload rejections from the buyer's gateway.
|
|
2268
|
+
* @minimum 0
|
|
2269
|
+
*/
|
|
2270
|
+
payload_size_bytes?: number;
|
|
2271
|
+
/**
|
|
2272
|
+
* Short human-readable server-side classification of why this attempt did not succeed (e.g., `connection refused`, `TLS handshake timeout`, `HTTP 503 Service Unavailable`). Explicitly `null` for `success` (MUST be set as `null` rather than omitted). Sellers MUST NOT include request headers, request body content, or response body content in this field — payload surfacing is reserved for a future `include_webhook_payloads` extension and is subject to stricter access controls. Sellers SHOULD also avoid including buyer-endpoint internal hostnames, stack traces, or other implementation detail leaked by the response — keep it a stable classification string.
|
|
2273
|
+
* @maxLength 500
|
|
2274
|
+
*/
|
|
2275
|
+
error_message?: string | null;
|
|
2276
|
+
ext?: ExtensionObject;
|
|
2277
|
+
}
|
|
2278
|
+
|
|
2279
|
+
/**
|
|
2280
|
+
* Webhook for server-side dynamic content rendering (DCO)
|
|
2281
|
+
*/
|
|
2282
|
+
export interface WebhookAsset {
|
|
2283
|
+
/**
|
|
2284
|
+
* Discriminator identifying this as a webhook asset. See /schemas/creative/asset-types for the registry.
|
|
2285
|
+
*/
|
|
2286
|
+
asset_type: 'webhook';
|
|
2287
|
+
/**
|
|
2288
|
+
* Webhook URL to call for dynamic content
|
|
2289
|
+
*/
|
|
2290
|
+
url: string;
|
|
2291
|
+
method?: HTTPMethod;
|
|
2292
|
+
/**
|
|
2293
|
+
* Maximum time to wait for response in milliseconds
|
|
2294
|
+
* @minimum 10
|
|
2295
|
+
* @maximum 5000
|
|
2296
|
+
*/
|
|
2297
|
+
timeout_ms?: number;
|
|
2298
|
+
/**
|
|
2299
|
+
* Universal macros that can be passed to webhook (e.g., DEVICE_TYPE, COUNTRY). See docs/creative/universal-macros.mdx for full list.
|
|
2300
|
+
*/
|
|
2301
|
+
supported_macros?: (UniversalMacro | string)[];
|
|
2302
|
+
/**
|
|
2303
|
+
* Universal macros that must be provided for webhook to function
|
|
2304
|
+
*/
|
|
2305
|
+
required_macros?: (UniversalMacro | string)[];
|
|
2306
|
+
response_type: WebhookResponseType;
|
|
2307
|
+
/**
|
|
2308
|
+
* Security configuration for webhook calls
|
|
2309
|
+
*/
|
|
2310
|
+
security: {
|
|
2311
|
+
method: WebhookSecurityMethod;
|
|
2312
|
+
/**
|
|
2313
|
+
* Header name for HMAC signature (e.g., 'X-Signature')
|
|
2314
|
+
*/
|
|
2315
|
+
hmac_header?: string;
|
|
2316
|
+
/**
|
|
2317
|
+
* Header name for API key (e.g., 'X-API-Key')
|
|
2318
|
+
*/
|
|
2319
|
+
api_key_header?: string;
|
|
2320
|
+
};
|
|
2321
|
+
provenance?: Provenance;
|
|
2322
|
+
}
|
|
2323
|
+
|
|
2324
|
+
/**
|
|
2325
|
+
* Expected content type of webhook response
|
|
2326
|
+
*/
|
|
2327
|
+
export type WebhookResponseType = 'html' | 'json' | 'xml' | 'javascript';
|
|
2328
|
+
|
|
2329
|
+
/**
|
|
2330
|
+
* Authentication method
|
|
2331
|
+
*/
|
|
2332
|
+
export type WebhookSecurityMethod = 'hmac_sha256' | 'api_key' | 'none';
|
|
2333
|
+
|
|
2334
|
+
/**
|
|
2335
|
+
* 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).
|
|
2336
|
+
*/
|
|
2337
|
+
export interface ZipAsset {
|
|
2338
|
+
/**
|
|
2339
|
+
* Discriminator identifying this as a zip-bundled asset. See /schemas/creative/asset-types for the registry.
|
|
2340
|
+
*/
|
|
2341
|
+
asset_type: 'zip';
|
|
2342
|
+
/**
|
|
2343
|
+
* URL where the zip archive is hosted. Must be HTTPS.
|
|
2344
|
+
*/
|
|
2345
|
+
url: string;
|
|
2346
|
+
/**
|
|
2347
|
+
* Maximum file size in kilobytes. Receivers should reject zips exceeding this.
|
|
2348
|
+
* @minimum 0
|
|
2349
|
+
*/
|
|
2350
|
+
max_file_size_kb?: number;
|
|
2351
|
+
/**
|
|
2352
|
+
* Relative path to the entry file within the zip (typically 'index.html'). Receivers default to 'index.html' if absent.
|
|
2353
|
+
*/
|
|
2354
|
+
entry_point?: string;
|
|
2355
|
+
/**
|
|
2356
|
+
* File extensions permitted inside the zip (e.g., ['html', 'css', 'js', 'png', 'jpg', 'svg', 'webp', 'json', 'woff2']). Receivers may reject zips containing other extensions.
|
|
2357
|
+
*/
|
|
2358
|
+
allowed_inner_extensions?: string[];
|
|
2359
|
+
/**
|
|
2360
|
+
* Fallback image URL for environments that cannot render the bundled creative (e.g., non-HTML5 endpoints, ad blockers). Recommended for HTML5 banners.
|
|
2361
|
+
*/
|
|
2362
|
+
backup_image_url?: string;
|
|
2363
|
+
/**
|
|
2364
|
+
* Optional SHA-256 content digest of the zip archive (sha256:<hex>) for integrity verification. Lets receivers detect tampered or stale archives.
|
|
2365
|
+
* @pattern ^sha256:[a-f0-9]{64}$
|
|
2366
|
+
*/
|
|
2367
|
+
digest?: string;
|
|
2368
|
+
/**
|
|
2369
|
+
* Self-declared accessibility properties for this opaque creative
|
|
2370
|
+
*/
|
|
2371
|
+
accessibility?: {
|
|
2372
|
+
/**
|
|
2373
|
+
* Text alternative describing the creative content
|
|
2374
|
+
*/
|
|
2375
|
+
alt_text?: string;
|
|
2376
|
+
/**
|
|
2377
|
+
* Whether the creative can be fully operated via keyboard
|
|
2378
|
+
*/
|
|
2379
|
+
keyboard_navigable?: boolean;
|
|
2380
|
+
/**
|
|
2381
|
+
* Whether the creative respects prefers-reduced-motion or provides pause/stop controls
|
|
2382
|
+
*/
|
|
2383
|
+
motion_control?: boolean;
|
|
2384
|
+
/**
|
|
2385
|
+
* Whether the creative has been tested with screen readers
|
|
2386
|
+
*/
|
|
2387
|
+
screen_reader_tested?: boolean;
|
|
2388
|
+
};
|
|
2389
|
+
provenance?: Provenance;
|
|
2390
|
+
}
|