@adcp/client 3.21.0 → 3.23.0
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/dist/lib/agents/index.generated.d.ts +9 -1
- package/dist/lib/agents/index.generated.d.ts.map +1 -1
- package/dist/lib/agents/index.generated.js +12 -0
- package/dist/lib/agents/index.generated.js.map +1 -1
- package/dist/lib/index.d.ts +1 -1
- package/dist/lib/index.d.ts.map +1 -1
- package/dist/lib/index.js.map +1 -1
- package/dist/lib/protocols/a2a.d.ts +1 -1
- package/dist/lib/protocols/a2a.d.ts.map +1 -1
- package/dist/lib/protocols/a2a.js +3 -2
- package/dist/lib/protocols/a2a.js.map +1 -1
- package/dist/lib/protocols/index.d.ts +2 -2
- package/dist/lib/protocols/index.d.ts.map +1 -1
- package/dist/lib/protocols/index.js +6 -6
- package/dist/lib/protocols/index.js.map +1 -1
- package/dist/lib/protocols/mcp.d.ts +4 -1
- package/dist/lib/protocols/mcp.d.ts.map +1 -1
- package/dist/lib/protocols/mcp.js +24 -25
- package/dist/lib/protocols/mcp.js.map +1 -1
- package/dist/lib/registry/index.d.ts +57 -0
- package/dist/lib/registry/index.d.ts.map +1 -1
- package/dist/lib/registry/index.js +34 -0
- package/dist/lib/registry/index.js.map +1 -1
- package/dist/lib/registry/types.generated.d.ts +159 -0
- package/dist/lib/registry/types.generated.d.ts.map +1 -1
- package/dist/lib/registry/types.generated.js +1 -1
- package/dist/lib/types/adcp.d.ts +14 -0
- package/dist/lib/types/adcp.d.ts.map +1 -1
- package/dist/lib/types/core.generated.d.ts +153 -308
- package/dist/lib/types/core.generated.d.ts.map +1 -1
- package/dist/lib/types/core.generated.js +1 -1
- package/dist/lib/types/schemas.generated.d.ts +6326 -3761
- package/dist/lib/types/schemas.generated.d.ts.map +1 -1
- package/dist/lib/types/schemas.generated.js +473 -410
- package/dist/lib/types/schemas.generated.js.map +1 -1
- package/dist/lib/types/tools.generated.d.ts +531 -690
- package/dist/lib/types/tools.generated.d.ts.map +1 -1
- package/dist/lib/types/tools.generated.js +3 -0
- package/dist/lib/types/tools.generated.js.map +1 -1
- package/package.json +2 -2
|
@@ -125,18 +125,33 @@ export interface Account {
|
|
|
125
125
|
amount: number;
|
|
126
126
|
currency: string;
|
|
127
127
|
};
|
|
128
|
+
/**
|
|
129
|
+
* Present when status is 'pending_approval'. Contains next steps for completing account activation.
|
|
130
|
+
*/
|
|
131
|
+
setup?: {
|
|
132
|
+
/**
|
|
133
|
+
* URL where the human can complete the required action (credit application, legal agreement, add funds).
|
|
134
|
+
*/
|
|
135
|
+
url?: string;
|
|
136
|
+
/**
|
|
137
|
+
* Human-readable description of what's needed.
|
|
138
|
+
*/
|
|
139
|
+
message: string;
|
|
140
|
+
/**
|
|
141
|
+
* When this setup link expires.
|
|
142
|
+
*/
|
|
143
|
+
expires_at?: string;
|
|
144
|
+
};
|
|
128
145
|
/**
|
|
129
146
|
* When true, this is a sandbox account. All requests using this account_id are treated as sandbox — no real platform calls, no real spend.
|
|
130
147
|
*/
|
|
131
148
|
sandbox?: boolean;
|
|
132
149
|
ext?: ExtensionObject;
|
|
133
|
-
[k: string]: unknown | undefined;
|
|
134
150
|
}
|
|
135
151
|
/**
|
|
136
152
|
* 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.
|
|
137
153
|
*/
|
|
138
154
|
export interface ExtensionObject {
|
|
139
|
-
[k: string]: unknown | undefined;
|
|
140
155
|
}
|
|
141
156
|
/**
|
|
142
157
|
* A specific product within a media buy (line item)
|
|
@@ -186,7 +201,6 @@ export interface Package {
|
|
|
186
201
|
*/
|
|
187
202
|
paused?: boolean;
|
|
188
203
|
ext?: ExtensionObject;
|
|
189
|
-
[k: string]: unknown | undefined;
|
|
190
204
|
}
|
|
191
205
|
/**
|
|
192
206
|
* Optional restriction overlays for media buys. Most targeting should be expressed in the brief and handled by the publisher. These fields are for functional restrictions: geographic (RCT testing, regulatory compliance), age verification (alcohol, gambling), device platform (app compatibility), and language (localization).
|
|
@@ -194,134 +208,64 @@ export interface Package {
|
|
|
194
208
|
export interface TargetingOverlay {
|
|
195
209
|
/**
|
|
196
210
|
* Restrict delivery to specific countries. ISO 3166-1 alpha-2 codes (e.g., 'US', 'GB', 'DE').
|
|
197
|
-
*
|
|
198
|
-
* @minItems 1
|
|
199
211
|
*/
|
|
200
|
-
geo_countries?:
|
|
212
|
+
geo_countries?: string[];
|
|
201
213
|
/**
|
|
202
214
|
* Exclude specific countries from delivery. ISO 3166-1 alpha-2 codes (e.g., 'US', 'GB', 'DE').
|
|
203
|
-
*
|
|
204
|
-
* @minItems 1
|
|
205
215
|
*/
|
|
206
|
-
geo_countries_exclude?:
|
|
216
|
+
geo_countries_exclude?: string[];
|
|
207
217
|
/**
|
|
208
218
|
* Restrict delivery to specific regions/states. ISO 3166-2 subdivision codes (e.g., 'US-CA', 'GB-SCT').
|
|
209
|
-
*
|
|
210
|
-
* @minItems 1
|
|
211
219
|
*/
|
|
212
|
-
geo_regions?:
|
|
220
|
+
geo_regions?: string[];
|
|
213
221
|
/**
|
|
214
222
|
* Exclude specific regions/states from delivery. ISO 3166-2 subdivision codes (e.g., 'US-CA', 'GB-SCT').
|
|
215
|
-
*
|
|
216
|
-
* @minItems 1
|
|
217
223
|
*/
|
|
218
|
-
geo_regions_exclude?:
|
|
224
|
+
geo_regions_exclude?: string[];
|
|
219
225
|
/**
|
|
220
226
|
* Restrict delivery to specific metro areas. Each entry specifies the classification system and target values. Seller must declare supported systems in get_adcp_capabilities.
|
|
221
|
-
*
|
|
222
|
-
* @minItems 1
|
|
223
227
|
*/
|
|
224
|
-
geo_metros?:
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
*/
|
|
232
|
-
values: [string, ...string[]];
|
|
233
|
-
},
|
|
234
|
-
...{
|
|
235
|
-
system: MetroAreaSystem;
|
|
236
|
-
/**
|
|
237
|
-
* Metro codes within the system (e.g., ['501', '602'] for Nielsen DMAs)
|
|
238
|
-
*
|
|
239
|
-
* @minItems 1
|
|
240
|
-
*/
|
|
241
|
-
values: [string, ...string[]];
|
|
242
|
-
}[]
|
|
243
|
-
];
|
|
228
|
+
geo_metros?: {
|
|
229
|
+
system: MetroAreaSystem;
|
|
230
|
+
/**
|
|
231
|
+
* Metro codes within the system (e.g., ['501', '602'] for Nielsen DMAs)
|
|
232
|
+
*/
|
|
233
|
+
values: string[];
|
|
234
|
+
}[];
|
|
244
235
|
/**
|
|
245
236
|
* Exclude specific metro areas from delivery. Each entry specifies the classification system and excluded values. Seller must declare supported systems in get_adcp_capabilities.
|
|
246
|
-
*
|
|
247
|
-
* @minItems 1
|
|
248
237
|
*/
|
|
249
|
-
geo_metros_exclude?:
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
*/
|
|
257
|
-
values: [string, ...string[]];
|
|
258
|
-
},
|
|
259
|
-
...{
|
|
260
|
-
system: MetroAreaSystem;
|
|
261
|
-
/**
|
|
262
|
-
* Metro codes to exclude within the system (e.g., ['501', '602'] for Nielsen DMAs)
|
|
263
|
-
*
|
|
264
|
-
* @minItems 1
|
|
265
|
-
*/
|
|
266
|
-
values: [string, ...string[]];
|
|
267
|
-
}[]
|
|
268
|
-
];
|
|
238
|
+
geo_metros_exclude?: {
|
|
239
|
+
system: MetroAreaSystem;
|
|
240
|
+
/**
|
|
241
|
+
* Metro codes to exclude within the system (e.g., ['501', '602'] for Nielsen DMAs)
|
|
242
|
+
*/
|
|
243
|
+
values: string[];
|
|
244
|
+
}[];
|
|
269
245
|
/**
|
|
270
246
|
* Restrict delivery to specific postal areas. Each entry specifies the postal system and target values. Seller must declare supported systems in get_adcp_capabilities.
|
|
271
|
-
*
|
|
272
|
-
* @minItems 1
|
|
273
247
|
*/
|
|
274
|
-
geo_postal_areas?:
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
*/
|
|
282
|
-
values: [string, ...string[]];
|
|
283
|
-
},
|
|
284
|
-
...{
|
|
285
|
-
system: PostalCodeSystem;
|
|
286
|
-
/**
|
|
287
|
-
* Postal codes within the system (e.g., ['10001', '10002'] for us_zip)
|
|
288
|
-
*
|
|
289
|
-
* @minItems 1
|
|
290
|
-
*/
|
|
291
|
-
values: [string, ...string[]];
|
|
292
|
-
}[]
|
|
293
|
-
];
|
|
248
|
+
geo_postal_areas?: {
|
|
249
|
+
system: PostalCodeSystem;
|
|
250
|
+
/**
|
|
251
|
+
* Postal codes within the system (e.g., ['10001', '10002'] for us_zip)
|
|
252
|
+
*/
|
|
253
|
+
values: string[];
|
|
254
|
+
}[];
|
|
294
255
|
/**
|
|
295
256
|
* Exclude specific postal areas from delivery. Each entry specifies the postal system and excluded values. Seller must declare supported systems in get_adcp_capabilities.
|
|
296
|
-
*
|
|
297
|
-
* @minItems 1
|
|
298
257
|
*/
|
|
299
|
-
geo_postal_areas_exclude?:
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
*/
|
|
307
|
-
values: [string, ...string[]];
|
|
308
|
-
},
|
|
309
|
-
...{
|
|
310
|
-
system: PostalCodeSystem;
|
|
311
|
-
/**
|
|
312
|
-
* Postal codes to exclude within the system (e.g., ['10001', '10002'] for us_zip)
|
|
313
|
-
*
|
|
314
|
-
* @minItems 1
|
|
315
|
-
*/
|
|
316
|
-
values: [string, ...string[]];
|
|
317
|
-
}[]
|
|
318
|
-
];
|
|
258
|
+
geo_postal_areas_exclude?: {
|
|
259
|
+
system: PostalCodeSystem;
|
|
260
|
+
/**
|
|
261
|
+
* Postal codes to exclude within the system (e.g., ['10001', '10002'] for us_zip)
|
|
262
|
+
*/
|
|
263
|
+
values: string[];
|
|
264
|
+
}[];
|
|
319
265
|
/**
|
|
320
266
|
* Restrict delivery to specific time windows. Each entry specifies days of week and an hour range.
|
|
321
|
-
*
|
|
322
|
-
* @minItems 1
|
|
323
267
|
*/
|
|
324
|
-
daypart_targets?:
|
|
268
|
+
daypart_targets?: DaypartTarget[];
|
|
325
269
|
/**
|
|
326
270
|
* AXE segment ID to include for targeting
|
|
327
271
|
*/
|
|
@@ -332,16 +276,12 @@ export interface TargetingOverlay {
|
|
|
332
276
|
axe_exclude_segment?: string;
|
|
333
277
|
/**
|
|
334
278
|
* Restrict delivery to members of these first-party CRM audiences. Only users present in the uploaded lists are eligible. References audience_id values from sync_audiences on the same seller account — audience IDs are not portable across sellers. Not for lookalike expansion — express that intent in the campaign brief. Seller must declare support in get_adcp_capabilities.
|
|
335
|
-
*
|
|
336
|
-
* @minItems 1
|
|
337
279
|
*/
|
|
338
|
-
audience_include?:
|
|
280
|
+
audience_include?: string[];
|
|
339
281
|
/**
|
|
340
282
|
* Suppress delivery to members of these first-party CRM audiences. Matched users are excluded regardless of other targeting. References audience_id values from sync_audiences on the same seller account — audience IDs are not portable across sellers. Seller must declare support in get_adcp_capabilities.
|
|
341
|
-
*
|
|
342
|
-
* @minItems 1
|
|
343
283
|
*/
|
|
344
|
-
audience_exclude?:
|
|
284
|
+
audience_exclude?: string[];
|
|
345
285
|
frequency_cap?: FrequencyCap;
|
|
346
286
|
property_list?: PropertyListReference;
|
|
347
287
|
/**
|
|
@@ -358,69 +298,34 @@ export interface TargetingOverlay {
|
|
|
358
298
|
verification_required?: boolean;
|
|
359
299
|
/**
|
|
360
300
|
* Accepted verification methods. If omitted, any method the platform supports is acceptable.
|
|
361
|
-
*
|
|
362
|
-
* @minItems 1
|
|
363
301
|
*/
|
|
364
|
-
accepted_methods?:
|
|
302
|
+
accepted_methods?: AgeVerificationMethod[];
|
|
365
303
|
};
|
|
366
304
|
/**
|
|
367
305
|
* Restrict to specific platforms. Use for technical compatibility (app only works on iOS). Values from Sec-CH-UA-Platform standard, extended for CTV.
|
|
368
|
-
*
|
|
369
|
-
* @minItems 1
|
|
370
306
|
*/
|
|
371
|
-
device_platform?:
|
|
307
|
+
device_platform?: DevicePlatform[];
|
|
372
308
|
/**
|
|
373
309
|
* Target users within store catchment areas from a synced store catalog. Each entry references a store-type catalog and optionally narrows to specific stores or catchment zones.
|
|
374
|
-
*
|
|
375
|
-
* @minItems 1
|
|
376
310
|
*/
|
|
377
|
-
store_catchments?:
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
*
|
|
392
|
-
* @minItems 1
|
|
393
|
-
*/
|
|
394
|
-
catchment_ids?: [string, ...string[]];
|
|
395
|
-
[k: string]: unknown | undefined;
|
|
396
|
-
},
|
|
397
|
-
...{
|
|
398
|
-
/**
|
|
399
|
-
* Synced store-type catalog ID from sync_catalogs.
|
|
400
|
-
*/
|
|
401
|
-
catalog_id: string;
|
|
402
|
-
/**
|
|
403
|
-
* Filter to specific stores within the catalog. Omit to target all stores.
|
|
404
|
-
*
|
|
405
|
-
* @minItems 1
|
|
406
|
-
*/
|
|
407
|
-
store_ids?: [string, ...string[]];
|
|
408
|
-
/**
|
|
409
|
-
* Catchment zone IDs to target (e.g., 'walk', 'drive'). Omit to target all catchment zones.
|
|
410
|
-
*
|
|
411
|
-
* @minItems 1
|
|
412
|
-
*/
|
|
413
|
-
catchment_ids?: [string, ...string[]];
|
|
414
|
-
[k: string]: unknown | undefined;
|
|
415
|
-
}[]
|
|
416
|
-
];
|
|
311
|
+
store_catchments?: {
|
|
312
|
+
/**
|
|
313
|
+
* Synced store-type catalog ID from sync_catalogs.
|
|
314
|
+
*/
|
|
315
|
+
catalog_id: string;
|
|
316
|
+
/**
|
|
317
|
+
* Filter to specific stores within the catalog. Omit to target all stores.
|
|
318
|
+
*/
|
|
319
|
+
store_ids?: string[];
|
|
320
|
+
/**
|
|
321
|
+
* Catchment zone IDs to target (e.g., 'walk', 'drive'). Omit to target all catchment zones.
|
|
322
|
+
*/
|
|
323
|
+
catchment_ids?: string[];
|
|
324
|
+
}[];
|
|
417
325
|
/**
|
|
418
326
|
* Restrict to users with specific language preferences. ISO 639-1 codes (e.g., 'en', 'es', 'fr').
|
|
419
|
-
*
|
|
420
|
-
* @minItems 1
|
|
421
327
|
*/
|
|
422
|
-
language?:
|
|
423
|
-
[k: string]: unknown | undefined;
|
|
328
|
+
language?: string[];
|
|
424
329
|
}
|
|
425
330
|
/**
|
|
426
331
|
* A time window for daypart targeting. Specifies days of week and an hour range. start_hour is inclusive, end_hour is exclusive (e.g., 6-10 = 6:00am to 10:00am). Follows the Google Ads AdScheduleInfo / DV360 DayPartTargeting pattern.
|
|
@@ -428,10 +333,8 @@ export interface TargetingOverlay {
|
|
|
428
333
|
export interface DaypartTarget {
|
|
429
334
|
/**
|
|
430
335
|
* Days of week this window applies to. Use multiple days for compact targeting (e.g., monday-friday in one object).
|
|
431
|
-
*
|
|
432
|
-
* @minItems 1
|
|
433
336
|
*/
|
|
434
|
-
days:
|
|
337
|
+
days: DayOfWeek[];
|
|
435
338
|
/**
|
|
436
339
|
* Start hour (inclusive), 0-23 in 24-hour format. 0 = midnight, 6 = 6:00am, 18 = 6:00pm.
|
|
437
340
|
*/
|
|
@@ -453,7 +356,6 @@ export interface FrequencyCap {
|
|
|
453
356
|
* Minutes to suppress after impression
|
|
454
357
|
*/
|
|
455
358
|
suppress_minutes: number;
|
|
456
|
-
[k: string]: unknown | undefined;
|
|
457
359
|
}
|
|
458
360
|
/**
|
|
459
361
|
* Reference to a property list for targeting specific properties within this product. The package runs on the intersection of the product's publisher_properties and this list. Sellers SHOULD return a validation error if the product has property_targeting_allowed: false.
|
|
@@ -486,11 +388,8 @@ export interface CreativeAssignment {
|
|
|
486
388
|
weight?: number;
|
|
487
389
|
/**
|
|
488
390
|
* Optional array of placement IDs where this creative should run. When omitted, the creative runs on all placements in the package. References placement_id values from the product's placements array.
|
|
489
|
-
*
|
|
490
|
-
* @minItems 1
|
|
491
391
|
*/
|
|
492
|
-
placement_ids?:
|
|
493
|
-
[k: string]: unknown | undefined;
|
|
392
|
+
placement_ids?: string[];
|
|
494
393
|
}
|
|
495
394
|
/**
|
|
496
395
|
* Structured format identifier with agent URL and format name. 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.
|
|
@@ -516,7 +415,6 @@ export interface FormatID {
|
|
|
516
415
|
* Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
|
|
517
416
|
*/
|
|
518
417
|
duration_ms?: number;
|
|
519
|
-
[k: string]: unknown | undefined;
|
|
520
418
|
}
|
|
521
419
|
/**
|
|
522
420
|
* Conversion optimization goal for a package. Tells the seller which event source and event type to optimize delivery against. Provide at most one of target_roas or target_cpa. If neither is provided, the seller optimizes for maximum conversions within budget.
|
|
@@ -547,9 +445,7 @@ export interface OptimizationGoal {
|
|
|
547
445
|
* View-through attribution window (e.g. '1d', '7d')
|
|
548
446
|
*/
|
|
549
447
|
view_through?: string;
|
|
550
|
-
[k: string]: unknown | undefined;
|
|
551
448
|
};
|
|
552
|
-
[k: string]: unknown | undefined;
|
|
553
449
|
}
|
|
554
450
|
/**
|
|
555
451
|
* 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.
|
|
@@ -604,7 +500,6 @@ export type VASTAsset = {
|
|
|
604
500
|
* URL to audio description track for visually impaired users
|
|
605
501
|
*/
|
|
606
502
|
audio_description_url?: string;
|
|
607
|
-
[k: string]: unknown | undefined;
|
|
608
503
|
} | {
|
|
609
504
|
/**
|
|
610
505
|
* Discriminator indicating VAST is delivered as inline XML content
|
|
@@ -635,7 +530,6 @@ export type VASTAsset = {
|
|
|
635
530
|
* URL to audio description track for visually impaired users
|
|
636
531
|
*/
|
|
637
532
|
audio_description_url?: string;
|
|
638
|
-
[k: string]: unknown | undefined;
|
|
639
533
|
};
|
|
640
534
|
/**
|
|
641
535
|
* VAST specification version
|
|
@@ -674,7 +568,6 @@ export type DAASTAsset = {
|
|
|
674
568
|
* URL to text transcript of the audio content
|
|
675
569
|
*/
|
|
676
570
|
transcript_url?: string;
|
|
677
|
-
[k: string]: unknown | undefined;
|
|
678
571
|
} | {
|
|
679
572
|
/**
|
|
680
573
|
* Discriminator indicating DAAST is delivered as inline XML content
|
|
@@ -701,7 +594,6 @@ export type DAASTAsset = {
|
|
|
701
594
|
* URL to text transcript of the audio content
|
|
702
595
|
*/
|
|
703
596
|
transcript_url?: string;
|
|
704
|
-
[k: string]: unknown | undefined;
|
|
705
597
|
};
|
|
706
598
|
/**
|
|
707
599
|
* DAAST specification version
|
|
@@ -800,28 +692,20 @@ export interface Catalog {
|
|
|
800
692
|
update_frequency?: UpdateFrequency;
|
|
801
693
|
/**
|
|
802
694
|
* 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.
|
|
803
|
-
*
|
|
804
|
-
* @minItems 1
|
|
805
695
|
*/
|
|
806
|
-
items?:
|
|
696
|
+
items?: {}[];
|
|
807
697
|
/**
|
|
808
698
|
* Filter catalog to specific item IDs. For offering-type catalogs, these are offering_id values. For product-type catalogs, these are SKU identifiers.
|
|
809
|
-
*
|
|
810
|
-
* @minItems 1
|
|
811
699
|
*/
|
|
812
|
-
ids?:
|
|
700
|
+
ids?: string[];
|
|
813
701
|
/**
|
|
814
702
|
* 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'.
|
|
815
|
-
*
|
|
816
|
-
* @minItems 1
|
|
817
703
|
*/
|
|
818
|
-
gtins?:
|
|
704
|
+
gtins?: string[];
|
|
819
705
|
/**
|
|
820
706
|
* Filter catalog to items with these tags. Tags are matched using OR logic — items matching any tag are included.
|
|
821
|
-
*
|
|
822
|
-
* @minItems 1
|
|
823
707
|
*/
|
|
824
|
-
tags?:
|
|
708
|
+
tags?: string[];
|
|
825
709
|
/**
|
|
826
710
|
* Filter catalog to items in this category (e.g., 'beverages/soft-drinks', 'chef-positions').
|
|
827
711
|
*/
|
|
@@ -832,15 +716,66 @@ export interface Catalog {
|
|
|
832
716
|
query?: string;
|
|
833
717
|
/**
|
|
834
718
|
* 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.
|
|
835
|
-
*
|
|
836
|
-
* @minItems 1
|
|
837
719
|
*/
|
|
838
|
-
conversion_events?:
|
|
720
|
+
conversion_events?: EventType[];
|
|
839
721
|
content_id_type?: ContentIDType;
|
|
840
|
-
|
|
722
|
+
/**
|
|
723
|
+
* 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.
|
|
724
|
+
*/
|
|
725
|
+
feed_field_mappings?: CatalogFieldMapping[];
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* 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).
|
|
729
|
+
*/
|
|
730
|
+
export interface CatalogFieldMapping {
|
|
731
|
+
/**
|
|
732
|
+
* Field name in the external feed record. Omit when injecting a static literal value (use the value property instead).
|
|
733
|
+
*/
|
|
734
|
+
feed_field?: string;
|
|
735
|
+
/**
|
|
736
|
+
* 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.
|
|
737
|
+
*/
|
|
738
|
+
catalog_field?: string;
|
|
739
|
+
/**
|
|
740
|
+
* 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.
|
|
741
|
+
*/
|
|
742
|
+
asset_group_id?: string;
|
|
743
|
+
/**
|
|
744
|
+
* 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).
|
|
745
|
+
*/
|
|
746
|
+
value?: {
|
|
747
|
+
[k: string]: unknown | undefined;
|
|
748
|
+
};
|
|
749
|
+
/**
|
|
750
|
+
* Named transform to apply to the feed field value before writing to the catalog schema. See transform-specific parameters (format, timezone, by, separator).
|
|
751
|
+
*/
|
|
752
|
+
transform?: 'date' | 'divide' | 'boolean' | 'split';
|
|
753
|
+
/**
|
|
754
|
+
* 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.
|
|
755
|
+
*/
|
|
756
|
+
format?: string;
|
|
757
|
+
/**
|
|
758
|
+
* 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.
|
|
759
|
+
*/
|
|
760
|
+
timezone?: string;
|
|
761
|
+
/**
|
|
762
|
+
* For transform 'divide': the divisor to apply (e.g., 100 to convert integer cents to decimal dollars).
|
|
763
|
+
*/
|
|
764
|
+
by?: number;
|
|
765
|
+
/**
|
|
766
|
+
* For transform 'split': the separator character or string to split on. Defaults to ','.
|
|
767
|
+
*/
|
|
768
|
+
separator?: string;
|
|
769
|
+
/**
|
|
770
|
+
* 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.
|
|
771
|
+
*/
|
|
772
|
+
default?: {
|
|
773
|
+
[k: string]: unknown | undefined;
|
|
774
|
+
};
|
|
775
|
+
ext?: ExtensionObject;
|
|
841
776
|
}
|
|
842
777
|
/**
|
|
843
|
-
*
|
|
778
|
+
* 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.
|
|
844
779
|
*/
|
|
845
780
|
export interface ImageAsset {
|
|
846
781
|
/**
|
|
@@ -863,7 +798,6 @@ export interface ImageAsset {
|
|
|
863
798
|
* Alternative text for accessibility
|
|
864
799
|
*/
|
|
865
800
|
alt_text?: string;
|
|
866
|
-
[k: string]: unknown | undefined;
|
|
867
801
|
}
|
|
868
802
|
/**
|
|
869
803
|
* Video asset with URL and technical specifications including audio track properties
|
|
@@ -985,7 +919,6 @@ export interface VideoAsset {
|
|
|
985
919
|
* URL to audio description track for visually impaired users
|
|
986
920
|
*/
|
|
987
921
|
audio_description_url?: string;
|
|
988
|
-
[k: string]: unknown | undefined;
|
|
989
922
|
}
|
|
990
923
|
/**
|
|
991
924
|
* Audio asset with URL and technical specifications
|
|
@@ -1039,7 +972,6 @@ export interface AudioAsset {
|
|
|
1039
972
|
* URL to text transcript of the audio content
|
|
1040
973
|
*/
|
|
1041
974
|
transcript_url?: string;
|
|
1042
|
-
[k: string]: unknown | undefined;
|
|
1043
975
|
}
|
|
1044
976
|
/**
|
|
1045
977
|
* Text content asset
|
|
@@ -1053,7 +985,6 @@ export interface TextAsset {
|
|
|
1053
985
|
* Language code (e.g., 'en', 'es', 'fr')
|
|
1054
986
|
*/
|
|
1055
987
|
language?: string;
|
|
1056
|
-
[k: string]: unknown | undefined;
|
|
1057
988
|
}
|
|
1058
989
|
/**
|
|
1059
990
|
* HTML content asset
|
|
@@ -1088,7 +1019,6 @@ export interface HTMLAsset {
|
|
|
1088
1019
|
*/
|
|
1089
1020
|
screen_reader_tested?: boolean;
|
|
1090
1021
|
};
|
|
1091
|
-
[k: string]: unknown | undefined;
|
|
1092
1022
|
}
|
|
1093
1023
|
/**
|
|
1094
1024
|
* CSS stylesheet asset
|
|
@@ -1102,7 +1032,6 @@ export interface CSSAsset {
|
|
|
1102
1032
|
* CSS media query context (e.g., 'screen', 'print')
|
|
1103
1033
|
*/
|
|
1104
1034
|
media?: string;
|
|
1105
|
-
[k: string]: unknown | undefined;
|
|
1106
1035
|
}
|
|
1107
1036
|
/**
|
|
1108
1037
|
* JavaScript code asset
|
|
@@ -1134,7 +1063,6 @@ export interface JavaScriptAsset {
|
|
|
1134
1063
|
*/
|
|
1135
1064
|
screen_reader_tested?: boolean;
|
|
1136
1065
|
};
|
|
1137
|
-
[k: string]: unknown | undefined;
|
|
1138
1066
|
}
|
|
1139
1067
|
/**
|
|
1140
1068
|
* URL reference asset
|
|
@@ -1149,7 +1077,6 @@ export interface URLAsset {
|
|
|
1149
1077
|
* Description of what this URL points to
|
|
1150
1078
|
*/
|
|
1151
1079
|
description?: string;
|
|
1152
|
-
[k: string]: unknown | undefined;
|
|
1153
1080
|
}
|
|
1154
1081
|
/**
|
|
1155
1082
|
* Selects properties from a publisher's adagents.json. Used for both product definitions and agent authorization. Supports three selection patterns: all properties, specific IDs, or by tags.
|
|
@@ -1163,7 +1090,6 @@ export type PublisherPropertySelector = {
|
|
|
1163
1090
|
* Discriminator indicating all properties from this publisher are included
|
|
1164
1091
|
*/
|
|
1165
1092
|
selection_type: 'all';
|
|
1166
|
-
[k: string]: unknown | undefined;
|
|
1167
1093
|
} | {
|
|
1168
1094
|
/**
|
|
1169
1095
|
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
@@ -1175,11 +1101,8 @@ export type PublisherPropertySelector = {
|
|
|
1175
1101
|
selection_type: 'by_id';
|
|
1176
1102
|
/**
|
|
1177
1103
|
* Specific property IDs from the publisher's adagents.json
|
|
1178
|
-
*
|
|
1179
|
-
* @minItems 1
|
|
1180
1104
|
*/
|
|
1181
|
-
property_ids:
|
|
1182
|
-
[k: string]: unknown | undefined;
|
|
1105
|
+
property_ids: PropertyID[];
|
|
1183
1106
|
} | {
|
|
1184
1107
|
/**
|
|
1185
1108
|
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
@@ -1191,11 +1114,8 @@ export type PublisherPropertySelector = {
|
|
|
1191
1114
|
selection_type: 'by_tag';
|
|
1192
1115
|
/**
|
|
1193
1116
|
* Property tags from the publisher's adagents.json. Selector covers all properties with these tags
|
|
1194
|
-
*
|
|
1195
|
-
* @minItems 1
|
|
1196
1117
|
*/
|
|
1197
|
-
property_tags:
|
|
1198
|
-
[k: string]: unknown | undefined;
|
|
1118
|
+
property_tags: PropertyTag[];
|
|
1199
1119
|
};
|
|
1200
1120
|
/**
|
|
1201
1121
|
* Identifier for a publisher property. Must be lowercase alphanumeric with underscores only.
|
|
@@ -1261,7 +1181,6 @@ export type DataProviderSignalSelector = {
|
|
|
1261
1181
|
* Discriminator indicating all signals from this data provider are included
|
|
1262
1182
|
*/
|
|
1263
1183
|
selection_type: 'all';
|
|
1264
|
-
[k: string]: unknown | undefined;
|
|
1265
1184
|
} | {
|
|
1266
1185
|
/**
|
|
1267
1186
|
* Domain where data provider's adagents.json is hosted (e.g., 'polk.com')
|
|
@@ -1273,11 +1192,8 @@ export type DataProviderSignalSelector = {
|
|
|
1273
1192
|
selection_type: 'by_id';
|
|
1274
1193
|
/**
|
|
1275
1194
|
* Specific signal IDs from the data provider's catalog
|
|
1276
|
-
*
|
|
1277
|
-
* @minItems 1
|
|
1278
1195
|
*/
|
|
1279
|
-
signal_ids:
|
|
1280
|
-
[k: string]: unknown | undefined;
|
|
1196
|
+
signal_ids: string[];
|
|
1281
1197
|
} | {
|
|
1282
1198
|
/**
|
|
1283
1199
|
* Domain where data provider's adagents.json is hosted (e.g., 'polk.com')
|
|
@@ -1289,11 +1205,8 @@ export type DataProviderSignalSelector = {
|
|
|
1289
1205
|
selection_type: 'by_tag';
|
|
1290
1206
|
/**
|
|
1291
1207
|
* Signal tags from the data provider's catalog. Selector covers all signals with these tags
|
|
1292
|
-
*
|
|
1293
|
-
* @minItems 1
|
|
1294
1208
|
*/
|
|
1295
|
-
signal_tags:
|
|
1296
|
-
[k: string]: unknown | undefined;
|
|
1209
|
+
signal_tags: string[];
|
|
1297
1210
|
};
|
|
1298
1211
|
/**
|
|
1299
1212
|
* The type of catalog feed. Determines the item schema and how the platform resolves catalog items. Multiple catalog types can be synced to the same account and referenced together in creatives.
|
|
@@ -1459,11 +1372,8 @@ export interface Placement {
|
|
|
1459
1372
|
description?: string;
|
|
1460
1373
|
/**
|
|
1461
1374
|
* Format IDs supported by this specific placement. Can include: (1) concrete format_ids (fixed dimensions), (2) template format_ids without parameters (accepts any dimensions/duration), or (3) parameterized format_ids (specific dimension/duration constraints).
|
|
1462
|
-
*
|
|
1463
|
-
* @minItems 1
|
|
1464
1375
|
*/
|
|
1465
|
-
format_ids?:
|
|
1466
|
-
[k: string]: unknown | undefined;
|
|
1376
|
+
format_ids?: FormatID[];
|
|
1467
1377
|
}
|
|
1468
1378
|
/**
|
|
1469
1379
|
* Cost Per Mille (cost per 1,000 impressions) pricing. If fixed_price is present, it's fixed pricing. If absent, it's auction-based.
|
|
@@ -1498,7 +1408,6 @@ export interface CPMPricingOption {
|
|
|
1498
1408
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1499
1409
|
*/
|
|
1500
1410
|
min_spend_per_package?: number;
|
|
1501
|
-
[k: string]: unknown | undefined;
|
|
1502
1411
|
}
|
|
1503
1412
|
/**
|
|
1504
1413
|
* Optional pricing guidance for auction-based bidding
|
|
@@ -1520,7 +1429,6 @@ export interface PriceGuidance {
|
|
|
1520
1429
|
* 90th percentile of recent winning bids
|
|
1521
1430
|
*/
|
|
1522
1431
|
p90?: number;
|
|
1523
|
-
[k: string]: unknown | undefined;
|
|
1524
1432
|
}
|
|
1525
1433
|
/**
|
|
1526
1434
|
* Viewable Cost Per Mille (cost per 1,000 viewable impressions) pricing - MRC viewability standard. If fixed_price is present, it's fixed pricing. If absent, it's auction-based.
|
|
@@ -1555,7 +1463,6 @@ export interface VCPMPricingOption {
|
|
|
1555
1463
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1556
1464
|
*/
|
|
1557
1465
|
min_spend_per_package?: number;
|
|
1558
|
-
[k: string]: unknown | undefined;
|
|
1559
1466
|
}
|
|
1560
1467
|
/**
|
|
1561
1468
|
* Optional pricing guidance for auction-based bidding
|
|
@@ -1590,7 +1497,6 @@ export interface CPCPricingOption {
|
|
|
1590
1497
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1591
1498
|
*/
|
|
1592
1499
|
min_spend_per_package?: number;
|
|
1593
|
-
[k: string]: unknown | undefined;
|
|
1594
1500
|
}
|
|
1595
1501
|
/**
|
|
1596
1502
|
* Optional pricing guidance for auction-based bidding
|
|
@@ -1625,7 +1531,6 @@ export interface CPCVPricingOption {
|
|
|
1625
1531
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1626
1532
|
*/
|
|
1627
1533
|
min_spend_per_package?: number;
|
|
1628
|
-
[k: string]: unknown | undefined;
|
|
1629
1534
|
}
|
|
1630
1535
|
/**
|
|
1631
1536
|
* Optional pricing guidance for auction-based bidding
|
|
@@ -1665,15 +1570,12 @@ export interface CPVPricingOption {
|
|
|
1665
1570
|
* Seconds of viewing required
|
|
1666
1571
|
*/
|
|
1667
1572
|
duration_seconds: number;
|
|
1668
|
-
[k: string]: unknown | undefined;
|
|
1669
1573
|
};
|
|
1670
|
-
[k: string]: unknown | undefined;
|
|
1671
1574
|
};
|
|
1672
1575
|
/**
|
|
1673
1576
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1674
1577
|
*/
|
|
1675
1578
|
min_spend_per_package?: number;
|
|
1676
|
-
[k: string]: unknown | undefined;
|
|
1677
1579
|
}
|
|
1678
1580
|
/**
|
|
1679
1581
|
* Optional pricing guidance for auction-based bidding
|
|
@@ -1713,13 +1615,11 @@ export interface CPPPricingOption {
|
|
|
1713
1615
|
* Minimum GRPs/TRPs required
|
|
1714
1616
|
*/
|
|
1715
1617
|
min_points?: number;
|
|
1716
|
-
[k: string]: unknown | undefined;
|
|
1717
1618
|
};
|
|
1718
1619
|
/**
|
|
1719
1620
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1720
1621
|
*/
|
|
1721
1622
|
min_spend_per_package?: number;
|
|
1722
|
-
[k: string]: unknown | undefined;
|
|
1723
1623
|
}
|
|
1724
1624
|
/**
|
|
1725
1625
|
* Optional pricing guidance for auction-based bidding
|
|
@@ -1757,7 +1657,6 @@ export interface CPAPricingOption {
|
|
|
1757
1657
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1758
1658
|
*/
|
|
1759
1659
|
min_spend_per_package?: number;
|
|
1760
|
-
[k: string]: unknown | undefined;
|
|
1761
1660
|
}
|
|
1762
1661
|
/**
|
|
1763
1662
|
* Flat rate pricing for DOOH, sponsorships, and time-based campaigns. If fixed_price is present, it's fixed pricing. If absent, it's auction-based.
|
|
@@ -1816,13 +1715,11 @@ export interface FlatRatePricingOption {
|
|
|
1816
1715
|
* Specific daypart for time-based pricing
|
|
1817
1716
|
*/
|
|
1818
1717
|
daypart?: string;
|
|
1819
|
-
[k: string]: unknown | undefined;
|
|
1820
1718
|
};
|
|
1821
1719
|
/**
|
|
1822
1720
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1823
1721
|
*/
|
|
1824
1722
|
min_spend_per_package?: number;
|
|
1825
|
-
[k: string]: unknown | undefined;
|
|
1826
1723
|
}
|
|
1827
1724
|
/**
|
|
1828
1725
|
* Optional pricing guidance for auction-based bidding
|
|
@@ -1865,13 +1762,11 @@ export interface TimeBasedPricingOption {
|
|
|
1865
1762
|
* Maximum booking duration in time_units. Must be >= min_duration when both are present.
|
|
1866
1763
|
*/
|
|
1867
1764
|
max_duration?: number;
|
|
1868
|
-
[k: string]: unknown | undefined;
|
|
1869
1765
|
};
|
|
1870
1766
|
/**
|
|
1871
1767
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
1872
1768
|
*/
|
|
1873
1769
|
min_spend_per_package?: number;
|
|
1874
|
-
[k: string]: unknown | undefined;
|
|
1875
1770
|
}
|
|
1876
1771
|
/**
|
|
1877
1772
|
* Optional pricing guidance for auction-based bidding
|
|
@@ -1879,10 +1774,8 @@ export interface TimeBasedPricingOption {
|
|
|
1879
1774
|
export interface DeliveryForecast {
|
|
1880
1775
|
/**
|
|
1881
1776
|
* Forecasted delivery at one or more budget levels. A single point is a standard forecast; multiple points ordered by ascending budget form a curve showing how metrics scale with spend. Each point pairs a budget with metric ranges.
|
|
1882
|
-
*
|
|
1883
|
-
* @minItems 1
|
|
1884
1777
|
*/
|
|
1885
|
-
points:
|
|
1778
|
+
points: ForecastPoint[];
|
|
1886
1779
|
forecast_range_unit?: ForecastRangeUnit;
|
|
1887
1780
|
method: ForecastMethod;
|
|
1888
1781
|
/**
|
|
@@ -1904,7 +1797,6 @@ export interface DeliveryForecast {
|
|
|
1904
1797
|
*/
|
|
1905
1798
|
valid_until?: string;
|
|
1906
1799
|
ext?: ExtensionObject;
|
|
1907
|
-
[k: string]: unknown | undefined;
|
|
1908
1800
|
}
|
|
1909
1801
|
/**
|
|
1910
1802
|
* A forecast at a specific budget level. A single point represents a standard forecast; multiple points ordered by ascending budget form a curve showing how delivery metrics scale with spend.
|
|
@@ -1920,7 +1812,6 @@ export interface ForecastPoint {
|
|
|
1920
1812
|
metrics: {
|
|
1921
1813
|
[k: string]: ForecastRange | undefined;
|
|
1922
1814
|
};
|
|
1923
|
-
[k: string]: unknown | undefined;
|
|
1924
1815
|
}
|
|
1925
1816
|
/**
|
|
1926
1817
|
* A forecast value with optional low/high bounds. The mid value represents the most likely outcome. When low and high are provided, they represent conservative and optimistic estimates respectively.
|
|
@@ -1938,7 +1829,6 @@ export interface ForecastRange {
|
|
|
1938
1829
|
* Optimistic (high-end) forecast value
|
|
1939
1830
|
*/
|
|
1940
1831
|
high?: number;
|
|
1941
|
-
[k: string]: unknown | undefined;
|
|
1942
1832
|
}
|
|
1943
1833
|
/**
|
|
1944
1834
|
* 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.
|
|
@@ -1960,7 +1850,6 @@ export interface Measurement {
|
|
|
1960
1850
|
* Reporting frequency and format
|
|
1961
1851
|
*/
|
|
1962
1852
|
reporting: string;
|
|
1963
|
-
[k: string]: unknown | undefined;
|
|
1964
1853
|
}
|
|
1965
1854
|
/**
|
|
1966
1855
|
* Reporting capabilities available for a product
|
|
@@ -1968,10 +1857,8 @@ export interface Measurement {
|
|
|
1968
1857
|
export interface ReportingCapabilities {
|
|
1969
1858
|
/**
|
|
1970
1859
|
* Supported reporting frequency options
|
|
1971
|
-
*
|
|
1972
|
-
* @minItems 1
|
|
1973
1860
|
*/
|
|
1974
|
-
available_reporting_frequencies:
|
|
1861
|
+
available_reporting_frequencies: ReportingFrequency[];
|
|
1975
1862
|
/**
|
|
1976
1863
|
* Expected delay in minutes before reporting data becomes available (e.g., 240 for 4-hour delay)
|
|
1977
1864
|
*/
|
|
@@ -1996,7 +1883,6 @@ export interface ReportingCapabilities {
|
|
|
1996
1883
|
* Whether delivery data can be filtered to arbitrary date ranges. 'date_range' means the platform supports start_date/end_date parameters. 'lifetime_only' means the platform returns campaign lifetime totals and date range parameters are not accepted.
|
|
1997
1884
|
*/
|
|
1998
1885
|
date_range_support: 'date_range' | 'lifetime_only';
|
|
1999
|
-
[k: string]: unknown | undefined;
|
|
2000
1886
|
}
|
|
2001
1887
|
/**
|
|
2002
1888
|
* Creative requirements and restrictions for a product
|
|
@@ -2008,7 +1894,6 @@ export interface CreativePolicy {
|
|
|
2008
1894
|
* Whether creative templates are provided
|
|
2009
1895
|
*/
|
|
2010
1896
|
templates_available: boolean;
|
|
2011
|
-
[k: string]: unknown | undefined;
|
|
2012
1897
|
}
|
|
2013
1898
|
/**
|
|
2014
1899
|
* Structured format identifier with agent URL and format name. 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.
|
|
@@ -2100,7 +1985,7 @@ export type CatalogItemStatus = 'approved' | 'pending' | 'rejected' | 'warning';
|
|
|
2100
1985
|
*/
|
|
2101
1986
|
export interface MCPWebhookPayload {
|
|
2102
1987
|
/**
|
|
2103
|
-
*
|
|
1988
|
+
* Client-generated identifier that was embedded in the webhook URL by the buyer. Publishers echo this back in webhook payloads so clients can correlate notifications without parsing URL paths. Typically generated as a unique ID per task invocation.
|
|
2104
1989
|
*/
|
|
2105
1990
|
operation_id?: string;
|
|
2106
1991
|
/**
|
|
@@ -2155,7 +2040,6 @@ export interface GetProductsResponse {
|
|
|
2155
2040
|
sandbox?: boolean;
|
|
2156
2041
|
context?: ContextObject;
|
|
2157
2042
|
ext?: ExtensionObject;
|
|
2158
|
-
[k: string]: unknown | undefined;
|
|
2159
2043
|
}
|
|
2160
2044
|
/**
|
|
2161
2045
|
* Represents available advertising inventory
|
|
@@ -2175,10 +2059,8 @@ export interface Proposal {
|
|
|
2175
2059
|
description?: string;
|
|
2176
2060
|
/**
|
|
2177
2061
|
* Budget allocations across products. Allocation percentages MUST sum to 100. Publishers are responsible for ensuring the sum equals 100; buyers SHOULD validate this before execution.
|
|
2178
|
-
*
|
|
2179
|
-
* @minItems 1
|
|
2180
2062
|
*/
|
|
2181
|
-
allocations:
|
|
2063
|
+
allocations: ProductAllocation[];
|
|
2182
2064
|
/**
|
|
2183
2065
|
* When this proposal expires and can no longer be executed. After expiration, referenced products or pricing may no longer be available.
|
|
2184
2066
|
*/
|
|
@@ -2203,7 +2085,6 @@ export interface Proposal {
|
|
|
2203
2085
|
* ISO 4217 currency code
|
|
2204
2086
|
*/
|
|
2205
2087
|
currency?: string;
|
|
2206
|
-
[k: string]: unknown | undefined;
|
|
2207
2088
|
};
|
|
2208
2089
|
/**
|
|
2209
2090
|
* Explanation of how this proposal aligns with the campaign brief
|
|
@@ -2211,7 +2092,6 @@ export interface Proposal {
|
|
|
2211
2092
|
brief_alignment?: string;
|
|
2212
2093
|
forecast?: DeliveryForecast;
|
|
2213
2094
|
ext?: ExtensionObject;
|
|
2214
|
-
[k: string]: unknown | undefined;
|
|
2215
2095
|
}
|
|
2216
2096
|
/**
|
|
2217
2097
|
* A budget allocation for a specific product within a proposal. Percentages across all allocations in a proposal should sum to 100.
|
|
@@ -2243,13 +2123,10 @@ export interface ProductAllocation {
|
|
|
2243
2123
|
tags?: string[];
|
|
2244
2124
|
/**
|
|
2245
2125
|
* Recommended time windows for this allocation in spot-plan proposals.
|
|
2246
|
-
*
|
|
2247
|
-
* @minItems 1
|
|
2248
2126
|
*/
|
|
2249
|
-
daypart_targets?:
|
|
2127
|
+
daypart_targets?: DaypartTarget[];
|
|
2250
2128
|
forecast?: DeliveryForecast;
|
|
2251
2129
|
ext?: ExtensionObject;
|
|
2252
|
-
[k: string]: unknown | undefined;
|
|
2253
2130
|
}
|
|
2254
2131
|
/**
|
|
2255
2132
|
* A time window for daypart targeting. Specifies days of week and an hour range. start_hour is inclusive, end_hour is exclusive (e.g., 6-10 = 6:00am to 10:00am). Follows the Google Ads AdScheduleInfo / DV360 DayPartTargeting pattern.
|
|
@@ -2278,10 +2155,7 @@ export interface Error {
|
|
|
2278
2155
|
/**
|
|
2279
2156
|
* Additional task-specific error details
|
|
2280
2157
|
*/
|
|
2281
|
-
details?: {
|
|
2282
|
-
[k: string]: unknown | undefined;
|
|
2283
|
-
};
|
|
2284
|
-
[k: string]: unknown | undefined;
|
|
2158
|
+
details?: {};
|
|
2285
2159
|
}
|
|
2286
2160
|
/**
|
|
2287
2161
|
* Standard cursor-based pagination metadata for list responses
|
|
@@ -2304,7 +2178,6 @@ export interface PaginationResponse {
|
|
|
2304
2178
|
* 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.
|
|
2305
2179
|
*/
|
|
2306
2180
|
export interface ContextObject {
|
|
2307
|
-
[k: string]: unknown | undefined;
|
|
2308
2181
|
}
|
|
2309
2182
|
/**
|
|
2310
2183
|
* Progress data for working get_products
|
|
@@ -2328,7 +2201,6 @@ export interface GetProductsAsyncWorking {
|
|
|
2328
2201
|
step_number?: number;
|
|
2329
2202
|
context?: ContextObject;
|
|
2330
2203
|
ext?: ExtensionObject;
|
|
2331
|
-
[k: string]: unknown | undefined;
|
|
2332
2204
|
}
|
|
2333
2205
|
/**
|
|
2334
2206
|
* Input requirements for get_products needing clarification
|
|
@@ -2348,7 +2220,6 @@ export interface GetProductsAsyncInputRequired {
|
|
|
2348
2220
|
suggestions?: string[];
|
|
2349
2221
|
context?: ContextObject;
|
|
2350
2222
|
ext?: ExtensionObject;
|
|
2351
|
-
[k: string]: unknown | undefined;
|
|
2352
2223
|
}
|
|
2353
2224
|
/**
|
|
2354
2225
|
* Acknowledgment for submitted get_products (custom curation)
|
|
@@ -2360,7 +2231,6 @@ export interface GetProductsAsyncSubmitted {
|
|
|
2360
2231
|
estimated_completion?: string;
|
|
2361
2232
|
context?: ContextObject;
|
|
2362
2233
|
ext?: ExtensionObject;
|
|
2363
|
-
[k: string]: unknown | undefined;
|
|
2364
2234
|
}
|
|
2365
2235
|
/**
|
|
2366
2236
|
* Success response - media buy created successfully
|
|
@@ -2393,7 +2263,6 @@ export interface CreateMediaBuySuccess {
|
|
|
2393
2263
|
sandbox?: boolean;
|
|
2394
2264
|
context?: ContextObject;
|
|
2395
2265
|
ext?: ExtensionObject;
|
|
2396
|
-
[k: string]: unknown | undefined;
|
|
2397
2266
|
}
|
|
2398
2267
|
/**
|
|
2399
2268
|
* Account billed for this media buy. Includes advertiser, billing proxy (if any), and rate card applied.
|
|
@@ -2401,13 +2270,10 @@ export interface CreateMediaBuySuccess {
|
|
|
2401
2270
|
export interface CreateMediaBuyError {
|
|
2402
2271
|
/**
|
|
2403
2272
|
* Array of errors explaining why the operation failed
|
|
2404
|
-
*
|
|
2405
|
-
* @minItems 1
|
|
2406
2273
|
*/
|
|
2407
|
-
errors:
|
|
2274
|
+
errors: Error[];
|
|
2408
2275
|
context?: ContextObject;
|
|
2409
2276
|
ext?: ExtensionObject;
|
|
2410
|
-
[k: string]: unknown | undefined;
|
|
2411
2277
|
}
|
|
2412
2278
|
/**
|
|
2413
2279
|
* Progress data for working create_media_buy
|
|
@@ -2431,7 +2297,6 @@ export interface CreateMediaBuyAsyncWorking {
|
|
|
2431
2297
|
step_number?: number;
|
|
2432
2298
|
context?: ContextObject;
|
|
2433
2299
|
ext?: ExtensionObject;
|
|
2434
|
-
[k: string]: unknown | undefined;
|
|
2435
2300
|
}
|
|
2436
2301
|
/**
|
|
2437
2302
|
* Input requirements for create_media_buy needing user input
|
|
@@ -2447,7 +2312,6 @@ export interface CreateMediaBuyAsyncInputRequired {
|
|
|
2447
2312
|
errors?: Error[];
|
|
2448
2313
|
context?: ContextObject;
|
|
2449
2314
|
ext?: ExtensionObject;
|
|
2450
|
-
[k: string]: unknown | undefined;
|
|
2451
2315
|
}
|
|
2452
2316
|
/**
|
|
2453
2317
|
* Acknowledgment for submitted create_media_buy
|
|
@@ -2455,7 +2319,6 @@ export interface CreateMediaBuyAsyncInputRequired {
|
|
|
2455
2319
|
export interface CreateMediaBuyAsyncSubmitted {
|
|
2456
2320
|
context?: ContextObject;
|
|
2457
2321
|
ext?: ExtensionObject;
|
|
2458
|
-
[k: string]: unknown | undefined;
|
|
2459
2322
|
}
|
|
2460
2323
|
/**
|
|
2461
2324
|
* Success response - media buy updated successfully
|
|
@@ -2483,7 +2346,6 @@ export interface UpdateMediaBuySuccess {
|
|
|
2483
2346
|
sandbox?: boolean;
|
|
2484
2347
|
context?: ContextObject;
|
|
2485
2348
|
ext?: ExtensionObject;
|
|
2486
|
-
[k: string]: unknown | undefined;
|
|
2487
2349
|
}
|
|
2488
2350
|
/**
|
|
2489
2351
|
* Error response - operation failed, no changes applied
|
|
@@ -2491,13 +2353,10 @@ export interface UpdateMediaBuySuccess {
|
|
|
2491
2353
|
export interface UpdateMediaBuyError {
|
|
2492
2354
|
/**
|
|
2493
2355
|
* Array of errors explaining why the operation failed
|
|
2494
|
-
*
|
|
2495
|
-
* @minItems 1
|
|
2496
2356
|
*/
|
|
2497
|
-
errors:
|
|
2357
|
+
errors: Error[];
|
|
2498
2358
|
context?: ContextObject;
|
|
2499
2359
|
ext?: ExtensionObject;
|
|
2500
|
-
[k: string]: unknown | undefined;
|
|
2501
2360
|
}
|
|
2502
2361
|
/**
|
|
2503
2362
|
* Progress data for working update_media_buy
|
|
@@ -2521,7 +2380,6 @@ export interface UpdateMediaBuyAsyncWorking {
|
|
|
2521
2380
|
step_number?: number;
|
|
2522
2381
|
context?: ContextObject;
|
|
2523
2382
|
ext?: ExtensionObject;
|
|
2524
|
-
[k: string]: unknown | undefined;
|
|
2525
2383
|
}
|
|
2526
2384
|
/**
|
|
2527
2385
|
* Input requirements for update_media_buy needing user input
|
|
@@ -2533,7 +2391,6 @@ export interface UpdateMediaBuyAsyncInputRequired {
|
|
|
2533
2391
|
reason?: 'APPROVAL_REQUIRED' | 'CHANGE_CONFIRMATION';
|
|
2534
2392
|
context?: ContextObject;
|
|
2535
2393
|
ext?: ExtensionObject;
|
|
2536
|
-
[k: string]: unknown | undefined;
|
|
2537
2394
|
}
|
|
2538
2395
|
/**
|
|
2539
2396
|
* Acknowledgment for submitted update_media_buy
|
|
@@ -2541,7 +2398,6 @@ export interface UpdateMediaBuyAsyncInputRequired {
|
|
|
2541
2398
|
export interface UpdateMediaBuyAsyncSubmitted {
|
|
2542
2399
|
context?: ContextObject;
|
|
2543
2400
|
ext?: ExtensionObject;
|
|
2544
|
-
[k: string]: unknown | undefined;
|
|
2545
2401
|
}
|
|
2546
2402
|
/**
|
|
2547
2403
|
* Success response - sync operation processed creatives (may include per-item failures)
|
|
@@ -2593,9 +2449,14 @@ export interface SyncCreativesSuccess {
|
|
|
2593
2449
|
* Assignment errors by package ID (only present when assignment failures occurred)
|
|
2594
2450
|
*/
|
|
2595
2451
|
assignment_errors?: {
|
|
2596
|
-
|
|
2452
|
+
/**
|
|
2453
|
+
* Error message for this package assignment
|
|
2454
|
+
*
|
|
2455
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
2456
|
+
* via the `patternProperty` "^[a-zA-Z0-9_-]+$".
|
|
2457
|
+
*/
|
|
2458
|
+
[k: string]: string;
|
|
2597
2459
|
};
|
|
2598
|
-
[k: string]: unknown | undefined;
|
|
2599
2460
|
}[];
|
|
2600
2461
|
/**
|
|
2601
2462
|
* When true, this response contains simulated data from sandbox mode.
|
|
@@ -2603,7 +2464,6 @@ export interface SyncCreativesSuccess {
|
|
|
2603
2464
|
sandbox?: boolean;
|
|
2604
2465
|
context?: ContextObject;
|
|
2605
2466
|
ext?: ExtensionObject;
|
|
2606
|
-
[k: string]: unknown | undefined;
|
|
2607
2467
|
}
|
|
2608
2468
|
/**
|
|
2609
2469
|
* Account that owns this creative
|
|
@@ -2611,13 +2471,10 @@ export interface SyncCreativesSuccess {
|
|
|
2611
2471
|
export interface SyncCreativesError {
|
|
2612
2472
|
/**
|
|
2613
2473
|
* Operation-level errors that prevented processing any creatives (e.g., authentication failure, service unavailable, invalid request format)
|
|
2614
|
-
*
|
|
2615
|
-
* @minItems 1
|
|
2616
2474
|
*/
|
|
2617
|
-
errors:
|
|
2475
|
+
errors: Error[];
|
|
2618
2476
|
context?: ContextObject;
|
|
2619
2477
|
ext?: ExtensionObject;
|
|
2620
|
-
[k: string]: unknown | undefined;
|
|
2621
2478
|
}
|
|
2622
2479
|
/**
|
|
2623
2480
|
* Progress data for working sync_creatives
|
|
@@ -2649,7 +2506,6 @@ export interface SyncCreativesAsyncWorking {
|
|
|
2649
2506
|
creatives_total?: number;
|
|
2650
2507
|
context?: ContextObject;
|
|
2651
2508
|
ext?: ExtensionObject;
|
|
2652
|
-
[k: string]: unknown | undefined;
|
|
2653
2509
|
}
|
|
2654
2510
|
/**
|
|
2655
2511
|
* Input requirements for sync_creatives needing user input
|
|
@@ -2661,7 +2517,6 @@ export interface SyncCreativesAsyncInputRequired {
|
|
|
2661
2517
|
reason?: 'APPROVAL_REQUIRED' | 'ASSET_CONFIRMATION' | 'FORMAT_CLARIFICATION';
|
|
2662
2518
|
context?: ContextObject;
|
|
2663
2519
|
ext?: ExtensionObject;
|
|
2664
|
-
[k: string]: unknown | undefined;
|
|
2665
2520
|
}
|
|
2666
2521
|
/**
|
|
2667
2522
|
* Acknowledgment for submitted sync_creatives
|
|
@@ -2669,7 +2524,6 @@ export interface SyncCreativesAsyncInputRequired {
|
|
|
2669
2524
|
export interface SyncCreativesAsyncSubmitted {
|
|
2670
2525
|
context?: ContextObject;
|
|
2671
2526
|
ext?: ExtensionObject;
|
|
2672
|
-
[k: string]: unknown | undefined;
|
|
2673
2527
|
}
|
|
2674
2528
|
/**
|
|
2675
2529
|
* Success response - sync operation processed catalogs (may include per-catalog failures)
|
|
@@ -2721,7 +2575,6 @@ export interface SyncCatalogsSuccess {
|
|
|
2721
2575
|
* Reasons for rejection or warning
|
|
2722
2576
|
*/
|
|
2723
2577
|
reasons?: string[];
|
|
2724
|
-
[k: string]: unknown | undefined;
|
|
2725
2578
|
}[];
|
|
2726
2579
|
/**
|
|
2727
2580
|
* ISO 8601 timestamp of when the most recent sync was accepted by the platform
|
|
@@ -2743,7 +2596,6 @@ export interface SyncCatalogsSuccess {
|
|
|
2743
2596
|
* Non-fatal warnings about this catalog
|
|
2744
2597
|
*/
|
|
2745
2598
|
warnings?: string[];
|
|
2746
|
-
[k: string]: unknown | undefined;
|
|
2747
2599
|
}[];
|
|
2748
2600
|
/**
|
|
2749
2601
|
* When true, this response contains simulated data from sandbox mode.
|
|
@@ -2751,7 +2603,6 @@ export interface SyncCatalogsSuccess {
|
|
|
2751
2603
|
sandbox?: boolean;
|
|
2752
2604
|
context?: ContextObject;
|
|
2753
2605
|
ext?: ExtensionObject;
|
|
2754
|
-
[k: string]: unknown | undefined;
|
|
2755
2606
|
}
|
|
2756
2607
|
/**
|
|
2757
2608
|
* Error response - operation failed completely, no catalogs were processed
|
|
@@ -2759,13 +2610,10 @@ export interface SyncCatalogsSuccess {
|
|
|
2759
2610
|
export interface SyncCatalogsError {
|
|
2760
2611
|
/**
|
|
2761
2612
|
* Operation-level errors that prevented processing any catalogs (e.g., authentication failure, service unavailable, invalid request format)
|
|
2762
|
-
*
|
|
2763
|
-
* @minItems 1
|
|
2764
2613
|
*/
|
|
2765
|
-
errors:
|
|
2614
|
+
errors: Error[];
|
|
2766
2615
|
context?: ContextObject;
|
|
2767
2616
|
ext?: ExtensionObject;
|
|
2768
|
-
[k: string]: unknown | undefined;
|
|
2769
2617
|
}
|
|
2770
2618
|
/**
|
|
2771
2619
|
* Progress data for working sync_catalogs
|
|
@@ -2805,7 +2653,6 @@ export interface SyncCatalogsAsyncWorking {
|
|
|
2805
2653
|
items_total?: number;
|
|
2806
2654
|
context?: ContextObject;
|
|
2807
2655
|
ext?: ExtensionObject;
|
|
2808
|
-
[k: string]: unknown | undefined;
|
|
2809
2656
|
}
|
|
2810
2657
|
/**
|
|
2811
2658
|
* Input requirements for sync_catalogs needing buyer input
|
|
@@ -2817,7 +2664,6 @@ export interface SyncCatalogsAsyncInputRequired {
|
|
|
2817
2664
|
reason?: 'APPROVAL_REQUIRED' | 'FEED_VALIDATION' | 'ITEM_REVIEW' | 'FEED_ACCESS';
|
|
2818
2665
|
context?: ContextObject;
|
|
2819
2666
|
ext?: ExtensionObject;
|
|
2820
|
-
[k: string]: unknown | undefined;
|
|
2821
2667
|
}
|
|
2822
2668
|
/**
|
|
2823
2669
|
* Acknowledgment for submitted sync_catalogs
|
|
@@ -2825,6 +2671,5 @@ export interface SyncCatalogsAsyncInputRequired {
|
|
|
2825
2671
|
export interface SyncCatalogsAsyncSubmitted {
|
|
2826
2672
|
context?: ContextObject;
|
|
2827
2673
|
ext?: ExtensionObject;
|
|
2828
|
-
[k: string]: unknown | undefined;
|
|
2829
2674
|
}
|
|
2830
2675
|
//# sourceMappingURL=core.generated.d.ts.map
|