@adcp/client 3.0.3 → 3.1.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/auth/index.d.ts +8 -3
- package/dist/lib/auth/index.d.ts.map +1 -1
- package/dist/lib/auth/index.js +32 -6
- package/dist/lib/auth/index.js.map +1 -1
- package/dist/lib/core/AgentClient.d.ts.map +1 -1
- package/dist/lib/core/ConfigurationManager.d.ts.map +1 -1
- package/dist/lib/core/ConfigurationManager.js +14 -1
- package/dist/lib/core/ConfigurationManager.js.map +1 -1
- package/dist/lib/core/SingleAgentClient.d.ts +6 -0
- package/dist/lib/core/SingleAgentClient.d.ts.map +1 -1
- package/dist/lib/core/SingleAgentClient.js +15 -2
- package/dist/lib/core/SingleAgentClient.js.map +1 -1
- package/dist/lib/protocols/a2a.js +2 -2
- package/dist/lib/protocols/a2a.js.map +1 -1
- package/dist/lib/types/adcp.d.ts +3 -58
- package/dist/lib/types/adcp.d.ts.map +1 -1
- package/dist/lib/types/core.generated.d.ts +85 -50
- 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 +483 -279
- package/dist/lib/types/schemas.generated.d.ts.map +1 -1
- package/dist/lib/types/schemas.generated.js +159 -152
- package/dist/lib/types/schemas.generated.js.map +1 -1
- package/dist/lib/types/tools.generated.d.ts +261 -150
- package/dist/lib/types/tools.generated.d.ts.map +1 -1
- package/dist/lib/types/tools.generated.js +1 -1
- package/dist/lib/types/tools.generated.js.map +1 -1
- package/dist/lib/utils/preview-utils.d.ts.map +1 -1
- package/dist/lib/utils/preview-utils.js +2 -0
- package/dist/lib/utils/preview-utils.js.map +1 -1
- package/package.json +3 -2
|
@@ -3,12 +3,9 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export type BrandManifestReference = BrandManifest | string;
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Type of asset. Note: Brand manifests typically contain basic media assets (image, video, audio, text). Code assets (html, javascript, css) and ad markup (vast, daast) are usually not part of brand asset libraries.
|
|
7
7
|
*/
|
|
8
|
-
export type
|
|
9
|
-
export type BrandManifest1 = {
|
|
10
|
-
[k: string]: unknown;
|
|
11
|
-
};
|
|
8
|
+
export type AssetContentType = 'image' | 'video' | 'audio' | 'text' | 'markdown' | 'html' | 'css' | 'javascript' | 'vast' | 'daast' | 'promoted_offerings' | 'url' | 'webhook';
|
|
12
9
|
/**
|
|
13
10
|
* Type of inventory delivery
|
|
14
11
|
*/
|
|
@@ -51,9 +48,14 @@ export interface GetProductsRequest {
|
|
|
51
48
|
/**
|
|
52
49
|
* Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
53
50
|
*/
|
|
54
|
-
context?: {
|
|
51
|
+
context?: {
|
|
52
|
+
[k: string]: unknown;
|
|
53
|
+
};
|
|
55
54
|
}
|
|
56
|
-
|
|
55
|
+
/**
|
|
56
|
+
* Inline brand manifest object
|
|
57
|
+
*/
|
|
58
|
+
export interface BrandManifest {
|
|
57
59
|
/**
|
|
58
60
|
* Primary brand URL for context and asset discovery. Creative agents can infer brand information from this URL.
|
|
59
61
|
*/
|
|
@@ -61,7 +63,7 @@ export interface BrandManifest2 {
|
|
|
61
63
|
/**
|
|
62
64
|
* Brand or business name
|
|
63
65
|
*/
|
|
64
|
-
name
|
|
66
|
+
name: string;
|
|
65
67
|
/**
|
|
66
68
|
* Brand logo assets with semantic tags for different use cases
|
|
67
69
|
*/
|
|
@@ -141,10 +143,7 @@ export interface BrandManifest2 {
|
|
|
141
143
|
* Unique identifier for this asset
|
|
142
144
|
*/
|
|
143
145
|
asset_id: string;
|
|
144
|
-
|
|
145
|
-
* Type of asset
|
|
146
|
-
*/
|
|
147
|
-
asset_type: 'image' | 'video' | 'audio' | 'text';
|
|
146
|
+
asset_type: AssetContentType;
|
|
148
147
|
/**
|
|
149
148
|
* URL to CDN-hosted asset file
|
|
150
149
|
*/
|
|
@@ -282,6 +281,49 @@ export interface FormatID {
|
|
|
282
281
|
*/
|
|
283
282
|
id: string;
|
|
284
283
|
}
|
|
284
|
+
/**
|
|
285
|
+
* 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.
|
|
286
|
+
*/
|
|
287
|
+
export type PublisherPropertySelector = {
|
|
288
|
+
/**
|
|
289
|
+
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
290
|
+
*/
|
|
291
|
+
publisher_domain: string;
|
|
292
|
+
/**
|
|
293
|
+
* Discriminator indicating all properties from this publisher are included
|
|
294
|
+
*/
|
|
295
|
+
selection_type: 'all';
|
|
296
|
+
} | {
|
|
297
|
+
/**
|
|
298
|
+
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
299
|
+
*/
|
|
300
|
+
publisher_domain: string;
|
|
301
|
+
/**
|
|
302
|
+
* Discriminator indicating selection by specific property IDs
|
|
303
|
+
*/
|
|
304
|
+
selection_type: 'by_id';
|
|
305
|
+
/**
|
|
306
|
+
* Specific property IDs from the publisher's adagents.json
|
|
307
|
+
*
|
|
308
|
+
* @minItems 1
|
|
309
|
+
*/
|
|
310
|
+
property_ids: [string, ...string[]];
|
|
311
|
+
} | {
|
|
312
|
+
/**
|
|
313
|
+
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
314
|
+
*/
|
|
315
|
+
publisher_domain: string;
|
|
316
|
+
/**
|
|
317
|
+
* Discriminator indicating selection by property tags
|
|
318
|
+
*/
|
|
319
|
+
selection_type: 'by_tag';
|
|
320
|
+
/**
|
|
321
|
+
* Property tags from the publisher's adagents.json. Selector covers all properties with these tags
|
|
322
|
+
*
|
|
323
|
+
* @minItems 1
|
|
324
|
+
*/
|
|
325
|
+
property_tags: [string, ...string[]];
|
|
326
|
+
};
|
|
285
327
|
/**
|
|
286
328
|
* Type of inventory delivery
|
|
287
329
|
*/
|
|
@@ -320,48 +362,11 @@ export interface Product {
|
|
|
320
362
|
*/
|
|
321
363
|
description: string;
|
|
322
364
|
/**
|
|
323
|
-
* Publisher properties covered by this product. Buyers fetch actual property definitions from each publisher's adagents.json and validate agent authorization.
|
|
365
|
+
* Publisher properties covered by this product. Buyers fetch actual property definitions from each publisher's adagents.json and validate agent authorization. Selection patterns mirror the authorization patterns in adagents.json for consistency.
|
|
324
366
|
*
|
|
325
367
|
* @minItems 1
|
|
326
368
|
*/
|
|
327
|
-
publisher_properties: [
|
|
328
|
-
{
|
|
329
|
-
/**
|
|
330
|
-
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
331
|
-
*/
|
|
332
|
-
publisher_domain: string;
|
|
333
|
-
/**
|
|
334
|
-
* Specific property IDs from the publisher's adagents.json. Mutually exclusive with property_tags.
|
|
335
|
-
*
|
|
336
|
-
* @minItems 1
|
|
337
|
-
*/
|
|
338
|
-
property_ids?: [string, ...string[]];
|
|
339
|
-
/**
|
|
340
|
-
* Property tags from the publisher's adagents.json. Product covers all properties with these tags. Mutually exclusive with property_ids.
|
|
341
|
-
*
|
|
342
|
-
* @minItems 1
|
|
343
|
-
*/
|
|
344
|
-
property_tags?: [string, ...string[]];
|
|
345
|
-
},
|
|
346
|
-
...{
|
|
347
|
-
/**
|
|
348
|
-
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
349
|
-
*/
|
|
350
|
-
publisher_domain: string;
|
|
351
|
-
/**
|
|
352
|
-
* Specific property IDs from the publisher's adagents.json. Mutually exclusive with property_tags.
|
|
353
|
-
*
|
|
354
|
-
* @minItems 1
|
|
355
|
-
*/
|
|
356
|
-
property_ids?: [string, ...string[]];
|
|
357
|
-
/**
|
|
358
|
-
* Property tags from the publisher's adagents.json. Product covers all properties with these tags. Mutually exclusive with property_ids.
|
|
359
|
-
*
|
|
360
|
-
* @minItems 1
|
|
361
|
-
*/
|
|
362
|
-
property_tags?: [string, ...string[]];
|
|
363
|
-
}[]
|
|
364
|
-
];
|
|
369
|
+
publisher_properties: [PublisherPropertySelector, ...PublisherPropertySelector[]];
|
|
365
370
|
/**
|
|
366
371
|
* Array of supported creative format IDs - structured format_id objects with agent_url and id
|
|
367
372
|
*/
|
|
@@ -479,6 +484,10 @@ export interface CPMFixedRatePricingOption {
|
|
|
479
484
|
* ISO 4217 currency code
|
|
480
485
|
*/
|
|
481
486
|
currency: string;
|
|
487
|
+
/**
|
|
488
|
+
* Whether this is a fixed rate (true) or auction-based (false)
|
|
489
|
+
*/
|
|
490
|
+
is_fixed: true;
|
|
482
491
|
/**
|
|
483
492
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
484
493
|
*/
|
|
@@ -500,6 +509,10 @@ export interface CPMAuctionPricingOption {
|
|
|
500
509
|
* ISO 4217 currency code
|
|
501
510
|
*/
|
|
502
511
|
currency: string;
|
|
512
|
+
/**
|
|
513
|
+
* Whether this is a fixed rate (true) or auction-based (false)
|
|
514
|
+
*/
|
|
515
|
+
is_fixed: false;
|
|
503
516
|
/**
|
|
504
517
|
* Pricing guidance for auction-based CPM bidding
|
|
505
518
|
*/
|
|
@@ -550,6 +563,10 @@ export interface VCPMFixedRatePricingOption {
|
|
|
550
563
|
* ISO 4217 currency code
|
|
551
564
|
*/
|
|
552
565
|
currency: string;
|
|
566
|
+
/**
|
|
567
|
+
* Whether this is a fixed rate (true) or auction-based (false)
|
|
568
|
+
*/
|
|
569
|
+
is_fixed: true;
|
|
553
570
|
/**
|
|
554
571
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
555
572
|
*/
|
|
@@ -571,6 +588,10 @@ export interface VCPMAuctionPricingOption {
|
|
|
571
588
|
* ISO 4217 currency code
|
|
572
589
|
*/
|
|
573
590
|
currency: string;
|
|
591
|
+
/**
|
|
592
|
+
* Whether this is a fixed rate (true) or auction-based (false)
|
|
593
|
+
*/
|
|
594
|
+
is_fixed: false;
|
|
574
595
|
/**
|
|
575
596
|
* Statistical guidance for auction pricing
|
|
576
597
|
*/
|
|
@@ -621,6 +642,10 @@ export interface CPCPricingOption {
|
|
|
621
642
|
* ISO 4217 currency code
|
|
622
643
|
*/
|
|
623
644
|
currency: string;
|
|
645
|
+
/**
|
|
646
|
+
* Whether this is a fixed rate (true) or auction-based (false)
|
|
647
|
+
*/
|
|
648
|
+
is_fixed: true;
|
|
624
649
|
/**
|
|
625
650
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
626
651
|
*/
|
|
@@ -646,6 +671,10 @@ export interface CPCVPricingOption {
|
|
|
646
671
|
* ISO 4217 currency code
|
|
647
672
|
*/
|
|
648
673
|
currency: string;
|
|
674
|
+
/**
|
|
675
|
+
* Whether this is a fixed rate (true) or auction-based (false)
|
|
676
|
+
*/
|
|
677
|
+
is_fixed: true;
|
|
649
678
|
/**
|
|
650
679
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
651
680
|
*/
|
|
@@ -671,6 +700,10 @@ export interface CPVPricingOption {
|
|
|
671
700
|
* ISO 4217 currency code
|
|
672
701
|
*/
|
|
673
702
|
currency: string;
|
|
703
|
+
/**
|
|
704
|
+
* Whether this is a fixed rate (true) or auction-based (false)
|
|
705
|
+
*/
|
|
706
|
+
is_fixed: true;
|
|
674
707
|
/**
|
|
675
708
|
* CPV-specific parameters defining the view threshold
|
|
676
709
|
*/
|
|
@@ -707,6 +740,10 @@ export interface CPPPricingOption {
|
|
|
707
740
|
* ISO 4217 currency code
|
|
708
741
|
*/
|
|
709
742
|
currency: string;
|
|
743
|
+
/**
|
|
744
|
+
* Whether this is a fixed rate (true) or auction-based (false)
|
|
745
|
+
*/
|
|
746
|
+
is_fixed: true;
|
|
710
747
|
/**
|
|
711
748
|
* CPP-specific parameters for demographic targeting and GRP requirements
|
|
712
749
|
*/
|
|
@@ -910,21 +947,22 @@ export interface Error {
|
|
|
910
947
|
};
|
|
911
948
|
}
|
|
912
949
|
/**
|
|
913
|
-
*
|
|
950
|
+
* Filter by format type (technical categories with distinct requirements)
|
|
951
|
+
*/
|
|
952
|
+
export type FormatCategory = 'audio' | 'video' | 'display' | 'native' | 'dooh' | 'rich_media' | 'universal';
|
|
953
|
+
/**
|
|
954
|
+
* Types of content that can be used as creative assets. Describes what KIND of content an asset contains (image, video, code, etc.), not where it displays.
|
|
914
955
|
*/
|
|
915
956
|
export interface ListCreativeFormatsRequest {
|
|
916
957
|
/**
|
|
917
958
|
* Return only these specific format IDs (e.g., from get_products response)
|
|
918
959
|
*/
|
|
919
960
|
format_ids?: FormatID[];
|
|
920
|
-
|
|
921
|
-
* Filter by format type (technical categories with distinct requirements)
|
|
922
|
-
*/
|
|
923
|
-
type?: 'audio' | 'video' | 'display' | 'dooh';
|
|
961
|
+
type?: FormatCategory;
|
|
924
962
|
/**
|
|
925
963
|
* Filter to formats that include these asset types. For third-party tags, search for 'html' or 'javascript'. E.g., ['image', 'text'] returns formats with images and text, ['javascript'] returns formats accepting JavaScript tags.
|
|
926
964
|
*/
|
|
927
|
-
asset_types?:
|
|
965
|
+
asset_types?: AssetContentType[];
|
|
928
966
|
/**
|
|
929
967
|
* Maximum width in pixels (inclusive). Returns formats where ANY render has width <= this value. For multi-render formats, matches if at least one render fits.
|
|
930
968
|
*/
|
|
@@ -952,11 +990,17 @@ export interface ListCreativeFormatsRequest {
|
|
|
952
990
|
/**
|
|
953
991
|
* Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
954
992
|
*/
|
|
955
|
-
context?: {
|
|
993
|
+
context?: {
|
|
994
|
+
[k: string]: unknown;
|
|
995
|
+
};
|
|
956
996
|
}
|
|
957
997
|
/**
|
|
958
998
|
* Structured format identifier with agent URL and format name
|
|
959
999
|
*/
|
|
1000
|
+
/**
|
|
1001
|
+
* Media type of this format - determines rendering method and asset requirements
|
|
1002
|
+
*/
|
|
1003
|
+
export type AssetContentType1 = 'image' | 'video' | 'audio' | 'text' | 'markdown' | 'html' | 'css' | 'javascript' | 'vast' | 'daast' | 'promoted_offerings' | 'url' | 'webhook';
|
|
960
1004
|
/**
|
|
961
1005
|
* Response payload for list_creative_formats task
|
|
962
1006
|
*/
|
|
@@ -1012,10 +1056,7 @@ export interface Format {
|
|
|
1012
1056
|
* Optional URL to showcase page with examples and interactive demos of this format
|
|
1013
1057
|
*/
|
|
1014
1058
|
example_url?: string;
|
|
1015
|
-
|
|
1016
|
-
* Media type of this format - determines rendering method and asset requirements
|
|
1017
|
-
*/
|
|
1018
|
-
type: 'audio' | 'video' | 'display' | 'native' | 'dooh' | 'rich_media' | 'universal';
|
|
1059
|
+
type: FormatCategory;
|
|
1019
1060
|
/**
|
|
1020
1061
|
* Specification of rendered pieces for this format. Most formats produce a single render. Companion ad formats (video + banner), adaptive formats, and multi-placement formats produce multiple renders. Each render specifies its role and dimensions.
|
|
1021
1062
|
*
|
|
@@ -1128,13 +1169,14 @@ export interface Format {
|
|
|
1128
1169
|
*/
|
|
1129
1170
|
assets_required?: ({
|
|
1130
1171
|
/**
|
|
1131
|
-
*
|
|
1172
|
+
* Discriminator indicating this is an individual asset requirement
|
|
1132
1173
|
*/
|
|
1133
|
-
|
|
1174
|
+
item_type: 'individual';
|
|
1134
1175
|
/**
|
|
1135
|
-
*
|
|
1176
|
+
* Unique identifier for this asset. Creative manifests MUST use this exact value as the key in the assets object.
|
|
1136
1177
|
*/
|
|
1137
|
-
|
|
1178
|
+
asset_id: string;
|
|
1179
|
+
asset_type: AssetContentType;
|
|
1138
1180
|
/**
|
|
1139
1181
|
* Optional descriptive label for this asset's purpose (e.g., 'hero_image', 'logo'). Not used for referencing assets in manifests—use asset_id instead. This field is for human-readable documentation and UI display only.
|
|
1140
1182
|
*/
|
|
@@ -1151,13 +1193,13 @@ export interface Format {
|
|
|
1151
1193
|
};
|
|
1152
1194
|
} | {
|
|
1153
1195
|
/**
|
|
1154
|
-
*
|
|
1196
|
+
* Discriminator indicating this is a repeatable asset group
|
|
1155
1197
|
*/
|
|
1156
|
-
|
|
1198
|
+
item_type: 'repeatable_group';
|
|
1157
1199
|
/**
|
|
1158
|
-
*
|
|
1200
|
+
* Identifier for this asset group (e.g., 'product', 'slide', 'card')
|
|
1159
1201
|
*/
|
|
1160
|
-
|
|
1202
|
+
asset_group_id: string;
|
|
1161
1203
|
/**
|
|
1162
1204
|
* Minimum number of repetitions required
|
|
1163
1205
|
*/
|
|
@@ -1174,10 +1216,7 @@ export interface Format {
|
|
|
1174
1216
|
* Identifier for this asset within the group
|
|
1175
1217
|
*/
|
|
1176
1218
|
asset_id: string;
|
|
1177
|
-
|
|
1178
|
-
* Type of asset
|
|
1179
|
-
*/
|
|
1180
|
-
asset_type: 'image' | 'video' | 'audio' | 'vast' | 'daast' | 'text' | 'markdown' | 'html' | 'css' | 'javascript' | 'url' | 'webhook' | 'promoted_offerings';
|
|
1219
|
+
asset_type: AssetContentType1;
|
|
1181
1220
|
/**
|
|
1182
1221
|
* Optional descriptive label for this asset's purpose (e.g., 'hero_image', 'logo'). Not used for referencing assets in manifests—use asset_id instead. This field is for human-readable documentation and UI display only.
|
|
1183
1222
|
*/
|
|
@@ -1364,7 +1403,7 @@ export type DAASTAsset = {
|
|
|
1364
1403
|
/**
|
|
1365
1404
|
* Brand information manifest containing assets, themes, and guidelines. Can be provided inline or as a URL reference to a hosted manifest.
|
|
1366
1405
|
*/
|
|
1367
|
-
export type BrandManifestReference1 =
|
|
1406
|
+
export type BrandManifestReference1 = BrandManifest | string;
|
|
1368
1407
|
/**
|
|
1369
1408
|
* Campaign start timing: 'asap' or ISO 8601 date-time
|
|
1370
1409
|
*/
|
|
@@ -1404,7 +1443,9 @@ export interface CreateMediaBuyRequest {
|
|
|
1404
1443
|
/**
|
|
1405
1444
|
* Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
1406
1445
|
*/
|
|
1407
|
-
context?: {
|
|
1446
|
+
context?: {
|
|
1447
|
+
[k: string]: unknown;
|
|
1448
|
+
};
|
|
1408
1449
|
}
|
|
1409
1450
|
/**
|
|
1410
1451
|
* Package configuration for media buy creation
|
|
@@ -1709,6 +1750,9 @@ export interface PromotedOfferings {
|
|
|
1709
1750
|
exclude_tags?: string[];
|
|
1710
1751
|
};
|
|
1711
1752
|
}
|
|
1753
|
+
/**
|
|
1754
|
+
* Inline brand manifest object
|
|
1755
|
+
*/
|
|
1712
1756
|
export interface PromotedProducts {
|
|
1713
1757
|
/**
|
|
1714
1758
|
* Direct product SKU references from the brand manifest product catalog
|
|
@@ -1790,18 +1834,9 @@ export type CreateMediaBuyResponse = {
|
|
|
1790
1834
|
*/
|
|
1791
1835
|
creative_deadline?: string;
|
|
1792
1836
|
/**
|
|
1793
|
-
* Array of created packages
|
|
1837
|
+
* Array of created packages with complete state information
|
|
1794
1838
|
*/
|
|
1795
|
-
packages:
|
|
1796
|
-
/**
|
|
1797
|
-
* Publisher's unique identifier for the package
|
|
1798
|
-
*/
|
|
1799
|
-
package_id: string;
|
|
1800
|
-
/**
|
|
1801
|
-
* Buyer's reference identifier for the package
|
|
1802
|
-
*/
|
|
1803
|
-
buyer_ref: string;
|
|
1804
|
-
}[];
|
|
1839
|
+
packages: Package[];
|
|
1805
1840
|
/**
|
|
1806
1841
|
* Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers.
|
|
1807
1842
|
*/
|
|
@@ -1819,7 +1854,74 @@ export type CreateMediaBuyResponse = {
|
|
|
1819
1854
|
context?: {};
|
|
1820
1855
|
};
|
|
1821
1856
|
/**
|
|
1822
|
-
*
|
|
1857
|
+
* Budget pacing strategy
|
|
1858
|
+
*/
|
|
1859
|
+
export type PackageStatus = 'draft' | 'active' | 'paused' | 'completed';
|
|
1860
|
+
/**
|
|
1861
|
+
* A specific product within a media buy (line item)
|
|
1862
|
+
*/
|
|
1863
|
+
export interface Package {
|
|
1864
|
+
/**
|
|
1865
|
+
* Publisher's unique identifier for the package
|
|
1866
|
+
*/
|
|
1867
|
+
package_id: string;
|
|
1868
|
+
/**
|
|
1869
|
+
* Buyer's reference identifier for this package
|
|
1870
|
+
*/
|
|
1871
|
+
buyer_ref?: string;
|
|
1872
|
+
/**
|
|
1873
|
+
* ID of the product this package is based on
|
|
1874
|
+
*/
|
|
1875
|
+
product_id?: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* Budget allocation for this package in the currency specified by the pricing option
|
|
1878
|
+
*/
|
|
1879
|
+
budget?: number;
|
|
1880
|
+
pacing?: Pacing;
|
|
1881
|
+
/**
|
|
1882
|
+
* ID of the selected pricing option from the product's pricing_options array
|
|
1883
|
+
*/
|
|
1884
|
+
pricing_option_id?: string;
|
|
1885
|
+
/**
|
|
1886
|
+
* Bid price for auction-based CPM pricing (present if using cpm-auction-option)
|
|
1887
|
+
*/
|
|
1888
|
+
bid_price?: number;
|
|
1889
|
+
/**
|
|
1890
|
+
* Impression goal for this package
|
|
1891
|
+
*/
|
|
1892
|
+
impressions?: number;
|
|
1893
|
+
targeting_overlay?: TargetingOverlay;
|
|
1894
|
+
/**
|
|
1895
|
+
* Creative assets assigned to this package
|
|
1896
|
+
*/
|
|
1897
|
+
creative_assignments?: CreativeAssignment[];
|
|
1898
|
+
/**
|
|
1899
|
+
* Format IDs that creative assets will be provided for this package
|
|
1900
|
+
*/
|
|
1901
|
+
format_ids_to_provide?: FormatID[];
|
|
1902
|
+
status: PackageStatus;
|
|
1903
|
+
}
|
|
1904
|
+
/**
|
|
1905
|
+
* Optional geographic refinements for media buys. Most targeting should be expressed in the brief and handled by the publisher. These fields are primarily for geographic restrictions (RCT testing, regulatory compliance).
|
|
1906
|
+
*/
|
|
1907
|
+
export interface CreativeAssignment {
|
|
1908
|
+
/**
|
|
1909
|
+
* Unique identifier for the creative
|
|
1910
|
+
*/
|
|
1911
|
+
creative_id: string;
|
|
1912
|
+
/**
|
|
1913
|
+
* Delivery weight for this creative
|
|
1914
|
+
*/
|
|
1915
|
+
weight?: number;
|
|
1916
|
+
/**
|
|
1917
|
+
* 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.
|
|
1918
|
+
*
|
|
1919
|
+
* @minItems 1
|
|
1920
|
+
*/
|
|
1921
|
+
placement_ids?: [string, ...string[]];
|
|
1922
|
+
}
|
|
1923
|
+
/**
|
|
1924
|
+
* Structured format identifier with agent URL and format name
|
|
1823
1925
|
*/
|
|
1824
1926
|
/**
|
|
1825
1927
|
* VAST (Video Ad Serving Template) tag for third-party video ad serving
|
|
@@ -1863,7 +1965,9 @@ export interface SyncCreativesRequest {
|
|
|
1863
1965
|
/**
|
|
1864
1966
|
* Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
1865
1967
|
*/
|
|
1866
|
-
context?: {
|
|
1968
|
+
context?: {
|
|
1969
|
+
[k: string]: unknown;
|
|
1970
|
+
};
|
|
1867
1971
|
}
|
|
1868
1972
|
/**
|
|
1869
1973
|
* Creative asset for upload to library - supports static assets, generative formats, and third-party snippets
|
|
@@ -2073,7 +2177,9 @@ export interface ListCreativesRequest {
|
|
|
2073
2177
|
/**
|
|
2074
2178
|
* Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
2075
2179
|
*/
|
|
2076
|
-
context?: {
|
|
2180
|
+
context?: {
|
|
2181
|
+
[k: string]: unknown;
|
|
2182
|
+
};
|
|
2077
2183
|
}
|
|
2078
2184
|
/**
|
|
2079
2185
|
* Current approval status of the creative
|
|
@@ -2188,10 +2294,6 @@ export interface ListCreativesResponse {
|
|
|
2188
2294
|
* When the creative was last modified
|
|
2189
2295
|
*/
|
|
2190
2296
|
updated_date: string;
|
|
2191
|
-
/**
|
|
2192
|
-
* URL of the creative file (for hosted assets)
|
|
2193
|
-
*/
|
|
2194
|
-
media_url?: string;
|
|
2195
2297
|
/**
|
|
2196
2298
|
* Assets for this creative, keyed by asset_role
|
|
2197
2299
|
*/
|
|
@@ -2202,22 +2304,6 @@ export interface ListCreativesResponse {
|
|
|
2202
2304
|
*/
|
|
2203
2305
|
[k: string]: ImageAsset | VideoAsset | AudioAsset | TextAsset | HTMLAsset | CSSAsset | JavaScriptAsset | VASTAsset | DAASTAsset | PromotedOfferings | URLAsset;
|
|
2204
2306
|
};
|
|
2205
|
-
/**
|
|
2206
|
-
* Landing page URL for the creative
|
|
2207
|
-
*/
|
|
2208
|
-
click_url?: string;
|
|
2209
|
-
/**
|
|
2210
|
-
* Duration in milliseconds (for video/audio)
|
|
2211
|
-
*/
|
|
2212
|
-
duration?: number;
|
|
2213
|
-
/**
|
|
2214
|
-
* Width in pixels (for video/display)
|
|
2215
|
-
*/
|
|
2216
|
-
width?: number;
|
|
2217
|
-
/**
|
|
2218
|
-
* Height in pixels (for video/display)
|
|
2219
|
-
*/
|
|
2220
|
-
height?: number;
|
|
2221
2307
|
/**
|
|
2222
2308
|
* User-defined tags for organization and searchability
|
|
2223
2309
|
*/
|
|
@@ -2367,7 +2453,9 @@ export interface UpdateMediaBuyRequest1 {
|
|
|
2367
2453
|
/**
|
|
2368
2454
|
* Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
2369
2455
|
*/
|
|
2370
|
-
context?: {
|
|
2456
|
+
context?: {
|
|
2457
|
+
[k: string]: unknown;
|
|
2458
|
+
};
|
|
2371
2459
|
}
|
|
2372
2460
|
/**
|
|
2373
2461
|
* Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time.
|
|
@@ -2389,18 +2477,9 @@ export type UpdateMediaBuyResponse = {
|
|
|
2389
2477
|
*/
|
|
2390
2478
|
implementation_date?: string | null;
|
|
2391
2479
|
/**
|
|
2392
|
-
* Array of packages that were modified
|
|
2480
|
+
* Array of packages that were modified with complete state information
|
|
2393
2481
|
*/
|
|
2394
|
-
affected_packages?:
|
|
2395
|
-
/**
|
|
2396
|
-
* Publisher's package identifier
|
|
2397
|
-
*/
|
|
2398
|
-
package_id: string;
|
|
2399
|
-
/**
|
|
2400
|
-
* Buyer's reference for the package
|
|
2401
|
-
*/
|
|
2402
|
-
buyer_ref: string;
|
|
2403
|
-
}[];
|
|
2482
|
+
affected_packages?: Package[];
|
|
2404
2483
|
/**
|
|
2405
2484
|
* Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers.
|
|
2406
2485
|
*/
|
|
@@ -2418,7 +2497,7 @@ export type UpdateMediaBuyResponse = {
|
|
|
2418
2497
|
context?: {};
|
|
2419
2498
|
};
|
|
2420
2499
|
/**
|
|
2421
|
-
*
|
|
2500
|
+
* Budget pacing strategy
|
|
2422
2501
|
*/
|
|
2423
2502
|
/**
|
|
2424
2503
|
* Request parameters for retrieving comprehensive delivery metrics
|
|
@@ -2447,7 +2526,9 @@ export interface GetMediaBuyDeliveryRequest {
|
|
|
2447
2526
|
/**
|
|
2448
2527
|
* Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
2449
2528
|
*/
|
|
2450
|
-
context?: {
|
|
2529
|
+
context?: {
|
|
2530
|
+
[k: string]: unknown;
|
|
2531
|
+
};
|
|
2451
2532
|
}
|
|
2452
2533
|
/**
|
|
2453
2534
|
* Pricing model used for this media buy
|
|
@@ -2752,7 +2833,9 @@ export interface ListAuthorizedPropertiesRequest {
|
|
|
2752
2833
|
/**
|
|
2753
2834
|
* Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
2754
2835
|
*/
|
|
2755
|
-
context?: {
|
|
2836
|
+
context?: {
|
|
2837
|
+
[k: string]: unknown;
|
|
2838
|
+
};
|
|
2756
2839
|
}
|
|
2757
2840
|
/**
|
|
2758
2841
|
* Standard advertising channels supported by AdCP
|
|
@@ -2848,7 +2931,9 @@ export interface ProvidePerformanceFeedbackRequest {
|
|
|
2848
2931
|
/**
|
|
2849
2932
|
* Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
2850
2933
|
*/
|
|
2851
|
-
context?: {
|
|
2934
|
+
context?: {
|
|
2935
|
+
[k: string]: unknown;
|
|
2936
|
+
};
|
|
2852
2937
|
}
|
|
2853
2938
|
/**
|
|
2854
2939
|
* Response payload for provide_performance_feedback task. Returns either success confirmation OR error information, never both.
|
|
@@ -2890,7 +2975,9 @@ export interface BuildCreativeRequest {
|
|
|
2890
2975
|
/**
|
|
2891
2976
|
* Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
2892
2977
|
*/
|
|
2893
|
-
context?: {
|
|
2978
|
+
context?: {
|
|
2979
|
+
[k: string]: unknown;
|
|
2980
|
+
};
|
|
2894
2981
|
}
|
|
2895
2982
|
/**
|
|
2896
2983
|
* Creative manifest to transform or generate from. For pure generation, this should include the target format_id and any required input assets (e.g., promoted_offerings for generative formats). For transformation (e.g., resizing, reformatting), this is the complete creative to adapt.
|
|
@@ -2991,6 +3078,10 @@ export type BuildCreativeResponse = {
|
|
|
2991
3078
|
* Request to generate previews of one or more creative manifests. Accepts either a single creative request or an array of requests for batch processing.
|
|
2992
3079
|
*/
|
|
2993
3080
|
export type PreviewCreativeRequest = {
|
|
3081
|
+
/**
|
|
3082
|
+
* Discriminator indicating this is a single preview request
|
|
3083
|
+
*/
|
|
3084
|
+
request_type: 'single';
|
|
2994
3085
|
format_id: FormatID;
|
|
2995
3086
|
creative_manifest: CreativeManifest;
|
|
2996
3087
|
/**
|
|
@@ -3023,8 +3114,14 @@ export type PreviewCreativeRequest = {
|
|
|
3023
3114
|
/**
|
|
3024
3115
|
* Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
3025
3116
|
*/
|
|
3026
|
-
context?: {
|
|
3117
|
+
context?: {
|
|
3118
|
+
[k: string]: unknown;
|
|
3119
|
+
};
|
|
3027
3120
|
} | {
|
|
3121
|
+
/**
|
|
3122
|
+
* Discriminator indicating this is a batch preview request
|
|
3123
|
+
*/
|
|
3124
|
+
request_type: 'batch';
|
|
3028
3125
|
/**
|
|
3029
3126
|
* Array of preview requests (1-50 items). Each follows the single request structure.
|
|
3030
3127
|
*
|
|
@@ -3102,7 +3199,9 @@ export type PreviewCreativeRequest = {
|
|
|
3102
3199
|
/**
|
|
3103
3200
|
* Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
3104
3201
|
*/
|
|
3105
|
-
context?: {
|
|
3202
|
+
context?: {
|
|
3203
|
+
[k: string]: unknown;
|
|
3204
|
+
};
|
|
3106
3205
|
};
|
|
3107
3206
|
/**
|
|
3108
3207
|
* VAST (Video Ad Serving Template) tag for third-party video ad serving
|
|
@@ -3130,6 +3229,10 @@ export interface CreativeManifest1 {
|
|
|
3130
3229
|
* Response containing preview links for one or more creatives. Format matches the request: single preview response for single requests, batch results for batch requests.
|
|
3131
3230
|
*/
|
|
3132
3231
|
export type PreviewCreativeResponse = {
|
|
3232
|
+
/**
|
|
3233
|
+
* Discriminator indicating this is a single preview response
|
|
3234
|
+
*/
|
|
3235
|
+
response_type: 'single';
|
|
3133
3236
|
/**
|
|
3134
3237
|
* Array of preview variants. Each preview corresponds to an input set from the request. If no inputs were provided, returns a single default preview.
|
|
3135
3238
|
*
|
|
@@ -3212,6 +3315,10 @@ export type PreviewCreativeResponse = {
|
|
|
3212
3315
|
*/
|
|
3213
3316
|
context?: {};
|
|
3214
3317
|
} | {
|
|
3318
|
+
/**
|
|
3319
|
+
* Discriminator indicating this is a batch preview response
|
|
3320
|
+
*/
|
|
3321
|
+
response_type: 'batch';
|
|
3215
3322
|
/**
|
|
3216
3323
|
* Array of preview results corresponding to each request in the same order. results[0] is the result for requests[0], results[1] for requests[1], etc. Order is guaranteed even when some requests fail. Each result contains either a successful preview response or an error.
|
|
3217
3324
|
*
|
|
@@ -3378,11 +3485,11 @@ export type PreviewRender = {
|
|
|
3378
3485
|
};
|
|
3379
3486
|
};
|
|
3380
3487
|
/**
|
|
3381
|
-
* A
|
|
3488
|
+
* A deployment target where signals can be activated (DSP, sales agent, etc.)
|
|
3382
3489
|
*/
|
|
3383
3490
|
export type Destination = {
|
|
3384
3491
|
/**
|
|
3385
|
-
* Discriminator indicating this is a platform-based
|
|
3492
|
+
* Discriminator indicating this is a platform-based deployment
|
|
3386
3493
|
*/
|
|
3387
3494
|
type: 'platform';
|
|
3388
3495
|
/**
|
|
@@ -3395,11 +3502,11 @@ export type Destination = {
|
|
|
3395
3502
|
account?: string;
|
|
3396
3503
|
} | {
|
|
3397
3504
|
/**
|
|
3398
|
-
* Discriminator indicating this is an agent URL-based
|
|
3505
|
+
* Discriminator indicating this is an agent URL-based deployment
|
|
3399
3506
|
*/
|
|
3400
3507
|
type: 'agent';
|
|
3401
3508
|
/**
|
|
3402
|
-
* URL identifying the
|
|
3509
|
+
* URL identifying the deployment agent (for sales agents, etc.)
|
|
3403
3510
|
*/
|
|
3404
3511
|
agent_url: string;
|
|
3405
3512
|
/**
|
|
@@ -3416,15 +3523,15 @@ export interface GetSignalsRequest {
|
|
|
3416
3523
|
*/
|
|
3417
3524
|
signal_spec: string;
|
|
3418
3525
|
/**
|
|
3419
|
-
*
|
|
3526
|
+
* Deployment targets where signals need to be activated
|
|
3420
3527
|
*/
|
|
3421
3528
|
deliver_to: {
|
|
3422
3529
|
/**
|
|
3423
|
-
* List of
|
|
3530
|
+
* List of deployment targets (DSPs, sales agents, etc.). If the authenticated caller matches one of these deployment targets, activation keys will be included in the response.
|
|
3424
3531
|
*
|
|
3425
3532
|
* @minItems 1
|
|
3426
3533
|
*/
|
|
3427
|
-
|
|
3534
|
+
deployments: [Destination, ...Destination[]];
|
|
3428
3535
|
/**
|
|
3429
3536
|
* Countries where signals will be used (ISO codes)
|
|
3430
3537
|
*/
|
|
@@ -3458,10 +3565,12 @@ export interface GetSignalsRequest {
|
|
|
3458
3565
|
/**
|
|
3459
3566
|
* Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
3460
3567
|
*/
|
|
3461
|
-
context?: {
|
|
3568
|
+
context?: {
|
|
3569
|
+
[k: string]: unknown;
|
|
3570
|
+
};
|
|
3462
3571
|
}
|
|
3463
3572
|
/**
|
|
3464
|
-
* A signal deployment to a specific
|
|
3573
|
+
* A signal deployment to a specific deployment target with activation status and key
|
|
3465
3574
|
*/
|
|
3466
3575
|
export type Deployment = {
|
|
3467
3576
|
/**
|
|
@@ -3477,7 +3586,7 @@ export type Deployment = {
|
|
|
3477
3586
|
*/
|
|
3478
3587
|
account?: string;
|
|
3479
3588
|
/**
|
|
3480
|
-
* Whether signal is currently active on this
|
|
3589
|
+
* Whether signal is currently active on this deployment
|
|
3481
3590
|
*/
|
|
3482
3591
|
is_live: boolean;
|
|
3483
3592
|
activation_key?: ActivationKey;
|
|
@@ -3495,7 +3604,7 @@ export type Deployment = {
|
|
|
3495
3604
|
*/
|
|
3496
3605
|
type: 'agent';
|
|
3497
3606
|
/**
|
|
3498
|
-
* URL identifying the
|
|
3607
|
+
* URL identifying the deployment agent
|
|
3499
3608
|
*/
|
|
3500
3609
|
agent_url: string;
|
|
3501
3610
|
/**
|
|
@@ -3503,7 +3612,7 @@ export type Deployment = {
|
|
|
3503
3612
|
*/
|
|
3504
3613
|
account?: string;
|
|
3505
3614
|
/**
|
|
3506
|
-
* Whether signal is currently active on this
|
|
3615
|
+
* Whether signal is currently active on this deployment
|
|
3507
3616
|
*/
|
|
3508
3617
|
is_live: boolean;
|
|
3509
3618
|
activation_key?: ActivationKey1;
|
|
@@ -3517,7 +3626,7 @@ export type Deployment = {
|
|
|
3517
3626
|
deployed_at?: string;
|
|
3518
3627
|
};
|
|
3519
3628
|
/**
|
|
3520
|
-
* The key to use for targeting. Only present if is_live=true AND requester has access to this
|
|
3629
|
+
* The key to use for targeting. Only present if is_live=true AND requester has access to this deployment.
|
|
3521
3630
|
*/
|
|
3522
3631
|
export type ActivationKey = {
|
|
3523
3632
|
/**
|
|
@@ -3543,7 +3652,7 @@ export type ActivationKey = {
|
|
|
3543
3652
|
value: string;
|
|
3544
3653
|
};
|
|
3545
3654
|
/**
|
|
3546
|
-
* The key to use for targeting. Only present if is_live=true AND requester has access to this
|
|
3655
|
+
* The key to use for targeting. Only present if is_live=true AND requester has access to this deployment.
|
|
3547
3656
|
*/
|
|
3548
3657
|
export type ActivationKey1 = {
|
|
3549
3658
|
/**
|
|
@@ -3601,7 +3710,7 @@ export interface GetSignalsResponse {
|
|
|
3601
3710
|
*/
|
|
3602
3711
|
coverage_percentage: number;
|
|
3603
3712
|
/**
|
|
3604
|
-
* Array of
|
|
3713
|
+
* Array of deployment targets
|
|
3605
3714
|
*/
|
|
3606
3715
|
deployments: Deployment[];
|
|
3607
3716
|
/**
|
|
@@ -3631,7 +3740,7 @@ export interface GetSignalsResponse {
|
|
|
3631
3740
|
* Standard error structure for task-specific errors and warnings
|
|
3632
3741
|
*/
|
|
3633
3742
|
/**
|
|
3634
|
-
* A
|
|
3743
|
+
* A deployment target where signals can be activated (DSP, sales agent, etc.)
|
|
3635
3744
|
*/
|
|
3636
3745
|
export interface ActivateSignalRequest {
|
|
3637
3746
|
/**
|
|
@@ -3639,22 +3748,24 @@ export interface ActivateSignalRequest {
|
|
|
3639
3748
|
*/
|
|
3640
3749
|
signal_agent_segment_id: string;
|
|
3641
3750
|
/**
|
|
3642
|
-
* Target
|
|
3751
|
+
* Target deployment(s) for activation. If the authenticated caller matches one of these deployment targets, activation keys will be included in the response.
|
|
3643
3752
|
*
|
|
3644
3753
|
* @minItems 1
|
|
3645
3754
|
*/
|
|
3646
|
-
|
|
3755
|
+
deployments: [Destination, ...Destination[]];
|
|
3647
3756
|
/**
|
|
3648
3757
|
* Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata.
|
|
3649
3758
|
*/
|
|
3650
|
-
context?: {
|
|
3759
|
+
context?: {
|
|
3760
|
+
[k: string]: unknown;
|
|
3761
|
+
};
|
|
3651
3762
|
}
|
|
3652
3763
|
/**
|
|
3653
3764
|
* Response payload for activate_signal task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - the signal is either fully activated or not activated at all.
|
|
3654
3765
|
*/
|
|
3655
3766
|
export type ActivateSignalResponse = {
|
|
3656
3767
|
/**
|
|
3657
|
-
* Array of deployment results for each
|
|
3768
|
+
* Array of deployment results for each deployment target
|
|
3658
3769
|
*/
|
|
3659
3770
|
deployments: Deployment[];
|
|
3660
3771
|
/**
|
|
@@ -3674,6 +3785,6 @@ export type ActivateSignalResponse = {
|
|
|
3674
3785
|
context?: {};
|
|
3675
3786
|
};
|
|
3676
3787
|
/**
|
|
3677
|
-
* A signal deployment to a specific
|
|
3788
|
+
* A signal deployment to a specific deployment target with activation status and key
|
|
3678
3789
|
*/
|
|
3679
3790
|
//# sourceMappingURL=tools.generated.d.ts.map
|