@adcp/client 3.6.0 → 3.7.1
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/bin/adcp.js +42 -2
- package/dist/lib/core/AsyncHandler.js.map +1 -1
- package/dist/lib/index.d.ts +1 -0
- package/dist/lib/index.d.ts.map +1 -1
- package/dist/lib/index.js +14 -2
- package/dist/lib/index.js.map +1 -1
- package/dist/lib/testing/client.d.ts.map +1 -1
- package/dist/lib/testing/client.js +23 -9
- package/dist/lib/testing/client.js.map +1 -1
- package/dist/lib/testing/formatter.d.ts.map +1 -1
- package/dist/lib/testing/formatter.js +14 -1
- package/dist/lib/testing/formatter.js.map +1 -1
- package/dist/lib/testing/types.d.ts +1 -0
- package/dist/lib/testing/types.d.ts.map +1 -1
- package/dist/lib/types/core.generated.d.ts +74 -9
- package/dist/lib/types/core.generated.d.ts.map +1 -1
- package/dist/lib/types/core.generated.js +2 -2
- package/dist/lib/types/schemas.generated.d.ts +877 -2442
- package/dist/lib/types/schemas.generated.d.ts.map +1 -1
- package/dist/lib/types/schemas.generated.js +243 -210
- package/dist/lib/types/schemas.generated.js.map +1 -1
- package/dist/lib/types/tools.generated.d.ts +195 -17
- package/dist/lib/types/tools.generated.d.ts.map +1 -1
- package/dist/lib/types/tools.generated.js.map +1 -1
- package/dist/lib/utils/format-assets.d.ts +112 -0
- package/dist/lib/utils/format-assets.d.ts.map +1 -0
- package/dist/lib/utils/format-assets.js +145 -0
- package/dist/lib/utils/format-assets.js.map +1 -0
- package/dist/lib/utils/index.d.ts +1 -0
- package/dist/lib/utils/index.d.ts.map +1 -1
- package/dist/lib/utils/index.js +12 -1
- package/dist/lib/utils/index.js.map +1 -1
- package/dist/lib/version.d.ts +5 -5
- package/dist/lib/version.js +5 -5
- package/package.json +2 -2
|
@@ -28,6 +28,7 @@ export interface GetProductsRequest {
|
|
|
28
28
|
brief?: string;
|
|
29
29
|
brand_manifest?: BrandManifestReference;
|
|
30
30
|
filters?: ProductFilters;
|
|
31
|
+
property_list?: PropertyListReference;
|
|
31
32
|
context?: ContextObject;
|
|
32
33
|
ext?: ExtensionObject;
|
|
33
34
|
}
|
|
@@ -165,6 +166,7 @@ export interface BrandManifest {
|
|
|
165
166
|
metadata?: {
|
|
166
167
|
[k: string]: unknown;
|
|
167
168
|
};
|
|
169
|
+
[k: string]: unknown;
|
|
168
170
|
}[];
|
|
169
171
|
/**
|
|
170
172
|
* Product catalog information for e-commerce advertisers. Enables SKU-level creative generation and product selection.
|
|
@@ -190,6 +192,7 @@ export interface BrandManifest {
|
|
|
190
192
|
* How frequently the product catalog is updated
|
|
191
193
|
*/
|
|
192
194
|
update_frequency?: 'realtime' | 'hourly' | 'daily' | 'weekly';
|
|
195
|
+
[k: string]: unknown;
|
|
193
196
|
};
|
|
194
197
|
/**
|
|
195
198
|
* Legal disclaimers or required text that must appear in creatives
|
|
@@ -246,6 +249,7 @@ export interface BrandManifest {
|
|
|
246
249
|
*/
|
|
247
250
|
version?: string;
|
|
248
251
|
};
|
|
252
|
+
[k: string]: unknown;
|
|
249
253
|
}
|
|
250
254
|
/**
|
|
251
255
|
* Structured filters for product discovery
|
|
@@ -294,6 +298,7 @@ export interface ProductFilters {
|
|
|
294
298
|
* Filter by advertising channels (e.g., ['display', 'video', 'dooh'])
|
|
295
299
|
*/
|
|
296
300
|
channels?: AdvertisingChannels[];
|
|
301
|
+
[k: string]: unknown;
|
|
297
302
|
}
|
|
298
303
|
/**
|
|
299
304
|
* 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.
|
|
@@ -319,6 +324,24 @@ export interface FormatID {
|
|
|
319
324
|
* Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
|
|
320
325
|
*/
|
|
321
326
|
duration_ms?: number;
|
|
327
|
+
[k: string]: unknown;
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* [AdCP 3.0] Reference to an externally managed property list. When provided, the sales agent should filter products to only those available on properties in the list.
|
|
331
|
+
*/
|
|
332
|
+
export interface PropertyListReference {
|
|
333
|
+
/**
|
|
334
|
+
* URL of the agent managing the property list
|
|
335
|
+
*/
|
|
336
|
+
agent_url: string;
|
|
337
|
+
/**
|
|
338
|
+
* Identifier for the property list within the agent
|
|
339
|
+
*/
|
|
340
|
+
list_id: string;
|
|
341
|
+
/**
|
|
342
|
+
* JWT or other authorization token for accessing the list. Optional if the list is public or caller has implicit access.
|
|
343
|
+
*/
|
|
344
|
+
auth_token?: string;
|
|
322
345
|
}
|
|
323
346
|
/**
|
|
324
347
|
* 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.
|
|
@@ -344,6 +367,7 @@ export type PublisherPropertySelector = {
|
|
|
344
367
|
* Discriminator indicating all properties from this publisher are included
|
|
345
368
|
*/
|
|
346
369
|
selection_type: 'all';
|
|
370
|
+
[k: string]: unknown;
|
|
347
371
|
} | {
|
|
348
372
|
/**
|
|
349
373
|
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
@@ -359,6 +383,7 @@ export type PublisherPropertySelector = {
|
|
|
359
383
|
* @minItems 1
|
|
360
384
|
*/
|
|
361
385
|
property_ids: [PropertyID, ...PropertyID[]];
|
|
386
|
+
[k: string]: unknown;
|
|
362
387
|
} | {
|
|
363
388
|
/**
|
|
364
389
|
* Domain where publisher's adagents.json is hosted (e.g., 'cnn.com')
|
|
@@ -374,6 +399,7 @@ export type PublisherPropertySelector = {
|
|
|
374
399
|
* @minItems 1
|
|
375
400
|
*/
|
|
376
401
|
property_tags: [PropertyTag, ...PropertyTag[]];
|
|
402
|
+
[k: string]: unknown;
|
|
377
403
|
};
|
|
378
404
|
/**
|
|
379
405
|
* Identifier for a publisher property. Must be lowercase alphanumeric with underscores only.
|
|
@@ -415,6 +441,10 @@ export interface GetProductsResponse {
|
|
|
415
441
|
* Task-specific errors and warnings (e.g., product filtering issues)
|
|
416
442
|
*/
|
|
417
443
|
errors?: Error[];
|
|
444
|
+
/**
|
|
445
|
+
* [AdCP 3.0] Indicates whether property_list filtering was applied. True if the agent filtered products based on the provided property_list. Absent or false if property_list was not provided or not supported by this agent.
|
|
446
|
+
*/
|
|
447
|
+
property_list_applied?: boolean;
|
|
418
448
|
context?: ContextObject;
|
|
419
449
|
ext?: ExtensionObject;
|
|
420
450
|
}
|
|
@@ -500,6 +530,7 @@ export interface Product {
|
|
|
500
530
|
manifest: {
|
|
501
531
|
[k: string]: unknown;
|
|
502
532
|
};
|
|
533
|
+
[k: string]: unknown;
|
|
503
534
|
};
|
|
504
535
|
/**
|
|
505
536
|
* Optional detailed card with carousel and full specifications. Provides rich product presentation similar to media kit pages.
|
|
@@ -512,8 +543,10 @@ export interface Product {
|
|
|
512
543
|
manifest: {
|
|
513
544
|
[k: string]: unknown;
|
|
514
545
|
};
|
|
546
|
+
[k: string]: unknown;
|
|
515
547
|
};
|
|
516
548
|
ext?: ExtensionObject;
|
|
549
|
+
[k: string]: unknown;
|
|
517
550
|
}
|
|
518
551
|
/**
|
|
519
552
|
* 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.
|
|
@@ -537,6 +570,7 @@ export interface Placement {
|
|
|
537
570
|
* @minItems 1
|
|
538
571
|
*/
|
|
539
572
|
format_ids?: [FormatID, ...FormatID[]];
|
|
573
|
+
[k: string]: unknown;
|
|
540
574
|
}
|
|
541
575
|
/**
|
|
542
576
|
* Cost Per Mille (cost per 1,000 impressions) with guaranteed fixed rate - common for direct/guaranteed deals
|
|
@@ -566,6 +600,7 @@ export interface CPMFixedRatePricingOption {
|
|
|
566
600
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
567
601
|
*/
|
|
568
602
|
min_spend_per_package?: number;
|
|
603
|
+
[k: string]: unknown;
|
|
569
604
|
}
|
|
570
605
|
/**
|
|
571
606
|
* Cost Per Mille (cost per 1,000 impressions) with auction-based pricing - common for programmatic/non-guaranteed inventory
|
|
@@ -616,6 +651,7 @@ export interface CPMAuctionPricingOption {
|
|
|
616
651
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
617
652
|
*/
|
|
618
653
|
min_spend_per_package?: number;
|
|
654
|
+
[k: string]: unknown;
|
|
619
655
|
}
|
|
620
656
|
/**
|
|
621
657
|
* Viewable Cost Per Mille (cost per 1,000 viewable impressions) with guaranteed fixed rate - impressions meeting MRC viewability standard (50% pixels in-view for 1 second for display, 2 seconds for video)
|
|
@@ -645,6 +681,7 @@ export interface VCPMFixedRatePricingOption {
|
|
|
645
681
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
646
682
|
*/
|
|
647
683
|
min_spend_per_package?: number;
|
|
684
|
+
[k: string]: unknown;
|
|
648
685
|
}
|
|
649
686
|
/**
|
|
650
687
|
* Viewable Cost Per Mille (cost per 1,000 viewable impressions) with auction-based pricing - impressions meeting MRC viewability standard (50% pixels in-view for 1 second for display, 2 seconds for video)
|
|
@@ -695,6 +732,7 @@ export interface VCPMAuctionPricingOption {
|
|
|
695
732
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
696
733
|
*/
|
|
697
734
|
min_spend_per_package?: number;
|
|
735
|
+
[k: string]: unknown;
|
|
698
736
|
}
|
|
699
737
|
/**
|
|
700
738
|
* Cost Per Click fixed-rate pricing for performance-driven advertising campaigns
|
|
@@ -724,6 +762,7 @@ export interface CPCPricingOption {
|
|
|
724
762
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
725
763
|
*/
|
|
726
764
|
min_spend_per_package?: number;
|
|
765
|
+
[k: string]: unknown;
|
|
727
766
|
}
|
|
728
767
|
/**
|
|
729
768
|
* Cost Per Completed View (100% video/audio completion) fixed-rate pricing
|
|
@@ -753,6 +792,7 @@ export interface CPCVPricingOption {
|
|
|
753
792
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
754
793
|
*/
|
|
755
794
|
min_spend_per_package?: number;
|
|
795
|
+
[k: string]: unknown;
|
|
756
796
|
}
|
|
757
797
|
/**
|
|
758
798
|
* Cost Per View (at publisher-defined threshold) fixed-rate pricing for video/audio
|
|
@@ -787,12 +827,15 @@ export interface CPVPricingOption {
|
|
|
787
827
|
* Seconds of viewing required (e.g., 30 for YouTube-style '30 seconds = view')
|
|
788
828
|
*/
|
|
789
829
|
duration_seconds: number;
|
|
830
|
+
[k: string]: unknown;
|
|
790
831
|
};
|
|
832
|
+
[k: string]: unknown;
|
|
791
833
|
};
|
|
792
834
|
/**
|
|
793
835
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
794
836
|
*/
|
|
795
837
|
min_spend_per_package?: number;
|
|
838
|
+
[k: string]: unknown;
|
|
796
839
|
}
|
|
797
840
|
/**
|
|
798
841
|
* Cost Per Point (Gross Rating Point) fixed-rate pricing for TV and audio campaigns requiring demographic measurement
|
|
@@ -830,11 +873,13 @@ export interface CPPPricingOption {
|
|
|
830
873
|
* Minimum GRPs/TRPs required for this pricing option
|
|
831
874
|
*/
|
|
832
875
|
min_points?: number;
|
|
876
|
+
[k: string]: unknown;
|
|
833
877
|
};
|
|
834
878
|
/**
|
|
835
879
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
836
880
|
*/
|
|
837
881
|
min_spend_per_package?: number;
|
|
882
|
+
[k: string]: unknown;
|
|
838
883
|
}
|
|
839
884
|
/**
|
|
840
885
|
* Flat rate pricing for DOOH, sponsorships, and time-based campaigns - fixed cost regardless of delivery volume
|
|
@@ -892,11 +937,13 @@ export interface FlatRatePricingOption {
|
|
|
892
937
|
* Specific daypart for time-based pricing (e.g., 'morning_commute', 'evening_prime', 'overnight')
|
|
893
938
|
*/
|
|
894
939
|
daypart?: string;
|
|
940
|
+
[k: string]: unknown;
|
|
895
941
|
};
|
|
896
942
|
/**
|
|
897
943
|
* Minimum spend requirement per package using this pricing option, in the specified currency
|
|
898
944
|
*/
|
|
899
945
|
min_spend_per_package?: number;
|
|
946
|
+
[k: string]: unknown;
|
|
900
947
|
}
|
|
901
948
|
/**
|
|
902
949
|
* Measurement capabilities included with a product
|
|
@@ -918,6 +965,7 @@ export interface Measurement {
|
|
|
918
965
|
* Reporting frequency and format
|
|
919
966
|
*/
|
|
920
967
|
reporting: string;
|
|
968
|
+
[k: string]: unknown;
|
|
921
969
|
}
|
|
922
970
|
/**
|
|
923
971
|
* Reporting capabilities available for a product
|
|
@@ -945,6 +993,7 @@ export interface ReportingCapabilities {
|
|
|
945
993
|
* Metrics available in reporting. Impressions and spend are always implicitly included.
|
|
946
994
|
*/
|
|
947
995
|
available_metrics: AvailableMetric[];
|
|
996
|
+
[k: string]: unknown;
|
|
948
997
|
}
|
|
949
998
|
/**
|
|
950
999
|
* Creative requirements and restrictions for a product
|
|
@@ -956,6 +1005,7 @@ export interface CreativePolicy {
|
|
|
956
1005
|
* Whether creative templates are provided
|
|
957
1006
|
*/
|
|
958
1007
|
templates_available: boolean;
|
|
1008
|
+
[k: string]: unknown;
|
|
959
1009
|
}
|
|
960
1010
|
/**
|
|
961
1011
|
* 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.
|
|
@@ -981,6 +1031,7 @@ export interface FormatID1 {
|
|
|
981
1031
|
* Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
|
|
982
1032
|
*/
|
|
983
1033
|
duration_ms?: number;
|
|
1034
|
+
[k: string]: unknown;
|
|
984
1035
|
}
|
|
985
1036
|
/**
|
|
986
1037
|
* 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.
|
|
@@ -1006,6 +1057,7 @@ export interface FormatID2 {
|
|
|
1006
1057
|
* Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
|
|
1007
1058
|
*/
|
|
1008
1059
|
duration_ms?: number;
|
|
1060
|
+
[k: string]: unknown;
|
|
1009
1061
|
}
|
|
1010
1062
|
/**
|
|
1011
1063
|
* 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.
|
|
@@ -1037,6 +1089,7 @@ export interface Error {
|
|
|
1037
1089
|
details?: {
|
|
1038
1090
|
[k: string]: unknown;
|
|
1039
1091
|
};
|
|
1092
|
+
[k: string]: unknown;
|
|
1040
1093
|
}
|
|
1041
1094
|
/**
|
|
1042
1095
|
* 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.
|
|
@@ -1092,6 +1145,14 @@ export type FormatIDParameter = 'dimensions' | 'duration';
|
|
|
1092
1145
|
* Type of asset
|
|
1093
1146
|
*/
|
|
1094
1147
|
export type AssetContentType1 = 'image' | 'video' | 'audio' | 'text' | 'markdown' | 'html' | 'css' | 'javascript' | 'vast' | 'daast' | 'promoted_offerings' | 'url' | 'webhook';
|
|
1148
|
+
/**
|
|
1149
|
+
* Type of asset
|
|
1150
|
+
*/
|
|
1151
|
+
export type AssetContentType2 = 'image' | 'video' | 'audio' | 'text' | 'markdown' | 'html' | 'css' | 'javascript' | 'vast' | 'daast' | 'promoted_offerings' | 'url' | 'webhook';
|
|
1152
|
+
/**
|
|
1153
|
+
* Type of asset
|
|
1154
|
+
*/
|
|
1155
|
+
export type AssetContentType3 = 'image' | 'video' | 'audio' | 'text' | 'markdown' | 'html' | 'css' | 'javascript' | 'vast' | 'daast' | 'promoted_offerings' | 'url' | 'webhook';
|
|
1095
1156
|
/**
|
|
1096
1157
|
* Capabilities supported by creative agents for format handling
|
|
1097
1158
|
*/
|
|
@@ -1172,7 +1233,8 @@ export interface Format {
|
|
|
1172
1233
|
})[]
|
|
1173
1234
|
];
|
|
1174
1235
|
/**
|
|
1175
|
-
*
|
|
1236
|
+
* @deprecated
|
|
1237
|
+
* DEPRECATED: Use 'assets' instead. Array of required assets or asset groups for this format. Each asset is identified by its asset_id, which must be used as the key in creative manifests. Can contain individual assets or repeatable asset sequences (e.g., carousel products, slideshow frames). This field is maintained for backward compatibility; new implementations should use 'assets' with the 'required' boolean on each asset.
|
|
1176
1238
|
*/
|
|
1177
1239
|
assets_required?: ({
|
|
1178
1240
|
/**
|
|
@@ -1240,6 +1302,79 @@ export interface Format {
|
|
|
1240
1302
|
};
|
|
1241
1303
|
}[];
|
|
1242
1304
|
})[];
|
|
1305
|
+
/**
|
|
1306
|
+
* Array of all assets supported for this format. Each asset is identified by its asset_id, which must be used as the key in creative manifests. Use the 'required' boolean on each asset to indicate whether it's mandatory. This field replaces the deprecated 'assets_required' and enables full asset discovery for buyers and AI agents.
|
|
1307
|
+
*/
|
|
1308
|
+
assets?: ({
|
|
1309
|
+
/**
|
|
1310
|
+
* Discriminator indicating this is an individual asset
|
|
1311
|
+
*/
|
|
1312
|
+
item_type: 'individual';
|
|
1313
|
+
/**
|
|
1314
|
+
* Unique identifier for this asset. Creative manifests MUST use this exact value as the key in the assets object.
|
|
1315
|
+
*/
|
|
1316
|
+
asset_id: string;
|
|
1317
|
+
asset_type: AssetContentType2;
|
|
1318
|
+
/**
|
|
1319
|
+
* Optional descriptive label for this asset's purpose (e.g., 'hero_image', 'logo', 'third_party_tracking'). Not used for referencing assets in manifests—use asset_id instead. This field is for human-readable documentation and UI display only.
|
|
1320
|
+
*/
|
|
1321
|
+
asset_role?: string;
|
|
1322
|
+
/**
|
|
1323
|
+
* Whether this asset is required (true) or optional (false). Required assets must be provided for a valid creative. Optional assets enhance the creative but are not mandatory.
|
|
1324
|
+
*/
|
|
1325
|
+
required: boolean;
|
|
1326
|
+
/**
|
|
1327
|
+
* Technical requirements for this asset (dimensions, file size, duration, etc.). For template formats, use parameters_from_format_id: true to indicate asset parameters must match the format_id parameters (width/height/unit and/or duration_ms).
|
|
1328
|
+
*/
|
|
1329
|
+
requirements?: {
|
|
1330
|
+
[k: string]: unknown;
|
|
1331
|
+
};
|
|
1332
|
+
} | {
|
|
1333
|
+
/**
|
|
1334
|
+
* Discriminator indicating this is a repeatable asset group
|
|
1335
|
+
*/
|
|
1336
|
+
item_type: 'repeatable_group';
|
|
1337
|
+
/**
|
|
1338
|
+
* Identifier for this asset group (e.g., 'product', 'slide', 'card')
|
|
1339
|
+
*/
|
|
1340
|
+
asset_group_id: string;
|
|
1341
|
+
/**
|
|
1342
|
+
* Whether this asset group is required. If true, at least min_count repetitions must be provided.
|
|
1343
|
+
*/
|
|
1344
|
+
required: boolean;
|
|
1345
|
+
/**
|
|
1346
|
+
* Minimum number of repetitions required (if group is required) or allowed (if optional)
|
|
1347
|
+
*/
|
|
1348
|
+
min_count: number;
|
|
1349
|
+
/**
|
|
1350
|
+
* Maximum number of repetitions allowed
|
|
1351
|
+
*/
|
|
1352
|
+
max_count: number;
|
|
1353
|
+
/**
|
|
1354
|
+
* Assets within each repetition of this group
|
|
1355
|
+
*/
|
|
1356
|
+
assets: {
|
|
1357
|
+
/**
|
|
1358
|
+
* Identifier for this asset within the group
|
|
1359
|
+
*/
|
|
1360
|
+
asset_id: string;
|
|
1361
|
+
asset_type: AssetContentType3;
|
|
1362
|
+
/**
|
|
1363
|
+
* Optional descriptive label for this asset's purpose. Not used for referencing assets in manifests—use asset_id instead. This field is for human-readable documentation and UI display only.
|
|
1364
|
+
*/
|
|
1365
|
+
asset_role?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* Whether this asset is required within each repetition of the group
|
|
1368
|
+
*/
|
|
1369
|
+
required: boolean;
|
|
1370
|
+
/**
|
|
1371
|
+
* Technical requirements for this asset. For template formats, use parameters_from_format_id: true to indicate asset parameters must match the format_id parameters (width/height/unit and/or duration_ms).
|
|
1372
|
+
*/
|
|
1373
|
+
requirements?: {
|
|
1374
|
+
[k: string]: unknown;
|
|
1375
|
+
};
|
|
1376
|
+
}[];
|
|
1377
|
+
})[];
|
|
1243
1378
|
/**
|
|
1244
1379
|
* Delivery method specifications (e.g., hosted, VAST, third-party tags)
|
|
1245
1380
|
*/
|
|
@@ -1265,6 +1400,7 @@ export interface Format {
|
|
|
1265
1400
|
manifest: {
|
|
1266
1401
|
[k: string]: unknown;
|
|
1267
1402
|
};
|
|
1403
|
+
[k: string]: unknown;
|
|
1268
1404
|
};
|
|
1269
1405
|
/**
|
|
1270
1406
|
* Optional detailed card with carousel and full specifications. Provides rich format documentation similar to ad spec pages.
|
|
@@ -1277,7 +1413,9 @@ export interface Format {
|
|
|
1277
1413
|
manifest: {
|
|
1278
1414
|
[k: string]: unknown;
|
|
1279
1415
|
};
|
|
1416
|
+
[k: string]: unknown;
|
|
1280
1417
|
};
|
|
1418
|
+
[k: string]: unknown;
|
|
1281
1419
|
}
|
|
1282
1420
|
/**
|
|
1283
1421
|
* Structured format identifier with agent URL and format name
|
|
@@ -1303,6 +1441,7 @@ export interface FormatID3 {
|
|
|
1303
1441
|
* Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.
|
|
1304
1442
|
*/
|
|
1305
1443
|
duration_ms?: number;
|
|
1444
|
+
[k: string]: unknown;
|
|
1306
1445
|
}
|
|
1307
1446
|
/**
|
|
1308
1447
|
* Standard error structure for task-specific errors and warnings
|
|
@@ -1340,6 +1479,7 @@ export type VASTAsset = {
|
|
|
1340
1479
|
* Tracking events supported by this VAST tag
|
|
1341
1480
|
*/
|
|
1342
1481
|
tracking_events?: VASTTrackingEvent[];
|
|
1482
|
+
[k: string]: unknown;
|
|
1343
1483
|
} | {
|
|
1344
1484
|
/**
|
|
1345
1485
|
* Discriminator indicating VAST is delivered as inline XML content
|
|
@@ -1362,6 +1502,7 @@ export type VASTAsset = {
|
|
|
1362
1502
|
* Tracking events supported by this VAST tag
|
|
1363
1503
|
*/
|
|
1364
1504
|
tracking_events?: VASTTrackingEvent[];
|
|
1505
|
+
[k: string]: unknown;
|
|
1365
1506
|
};
|
|
1366
1507
|
/**
|
|
1367
1508
|
* VAST specification version
|
|
@@ -1400,6 +1541,7 @@ export type DAASTAsset = {
|
|
|
1400
1541
|
* Whether companion display ads are included
|
|
1401
1542
|
*/
|
|
1402
1543
|
companion_ads?: boolean;
|
|
1544
|
+
[k: string]: unknown;
|
|
1403
1545
|
} | {
|
|
1404
1546
|
/**
|
|
1405
1547
|
* Discriminator indicating DAAST is delivered as inline XML content
|
|
@@ -1422,6 +1564,7 @@ export type DAASTAsset = {
|
|
|
1422
1564
|
* Whether companion display ads are included
|
|
1423
1565
|
*/
|
|
1424
1566
|
companion_ads?: boolean;
|
|
1567
|
+
[k: string]: unknown;
|
|
1425
1568
|
};
|
|
1426
1569
|
/**
|
|
1427
1570
|
* DAAST specification version
|
|
@@ -1543,6 +1686,14 @@ export interface PackageRequest {
|
|
|
1543
1686
|
* Bid price for auction-based CPM pricing (required if using cpm-auction-option)
|
|
1544
1687
|
*/
|
|
1545
1688
|
bid_price?: number;
|
|
1689
|
+
/**
|
|
1690
|
+
* Impression goal for this package
|
|
1691
|
+
*/
|
|
1692
|
+
impressions?: number;
|
|
1693
|
+
/**
|
|
1694
|
+
* Whether this package should be created in a paused state. Paused packages do not deliver impressions. Defaults to false.
|
|
1695
|
+
*/
|
|
1696
|
+
paused?: boolean;
|
|
1546
1697
|
targeting_overlay?: TargetingOverlay;
|
|
1547
1698
|
/**
|
|
1548
1699
|
* Creative IDs to assign to this package at creation time (references existing library creatives)
|
|
@@ -1555,6 +1706,7 @@ export interface PackageRequest {
|
|
|
1555
1706
|
*/
|
|
1556
1707
|
creatives?: CreativeAsset[];
|
|
1557
1708
|
ext?: ExtensionObject;
|
|
1709
|
+
[k: string]: unknown;
|
|
1558
1710
|
}
|
|
1559
1711
|
/**
|
|
1560
1712
|
* 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.
|
|
@@ -1585,6 +1737,7 @@ export interface TargetingOverlay {
|
|
|
1585
1737
|
*/
|
|
1586
1738
|
axe_exclude_segment?: string;
|
|
1587
1739
|
frequency_cap?: FrequencyCap;
|
|
1740
|
+
[k: string]: unknown;
|
|
1588
1741
|
}
|
|
1589
1742
|
/**
|
|
1590
1743
|
* Frequency capping settings for package-level application
|
|
@@ -1594,6 +1747,7 @@ export interface FrequencyCap {
|
|
|
1594
1747
|
* Minutes to suppress after impression
|
|
1595
1748
|
*/
|
|
1596
1749
|
suppress_minutes: number;
|
|
1750
|
+
[k: string]: unknown;
|
|
1597
1751
|
}
|
|
1598
1752
|
/**
|
|
1599
1753
|
* Creative asset for upload to library - supports static assets, generative formats, and third-party snippets
|
|
@@ -1612,11 +1766,7 @@ export interface CreativeAsset {
|
|
|
1612
1766
|
* Assets required by the format, keyed by asset_role
|
|
1613
1767
|
*/
|
|
1614
1768
|
assets: {
|
|
1615
|
-
|
|
1616
|
-
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
1617
|
-
* via the `patternProperty` "^[a-zA-Z0-9_-]+$".
|
|
1618
|
-
*/
|
|
1619
|
-
[k: string]: ImageAsset | VideoAsset | AudioAsset | TextAsset | HTMLAsset | CSSAsset | JavaScriptAsset | VASTAsset | DAASTAsset | PromotedOfferings | URLAsset;
|
|
1769
|
+
[k: string]: unknown;
|
|
1620
1770
|
};
|
|
1621
1771
|
/**
|
|
1622
1772
|
* Preview contexts for generative formats - defines what scenarios to generate previews for
|
|
@@ -1636,6 +1786,7 @@ export interface CreativeAsset {
|
|
|
1636
1786
|
* Natural language description of the context for AI-generated content
|
|
1637
1787
|
*/
|
|
1638
1788
|
context_description?: string;
|
|
1789
|
+
[k: string]: unknown;
|
|
1639
1790
|
}[];
|
|
1640
1791
|
/**
|
|
1641
1792
|
* User-defined tags for organization and searchability
|
|
@@ -1655,6 +1806,7 @@ export interface CreativeAsset {
|
|
|
1655
1806
|
* @minItems 1
|
|
1656
1807
|
*/
|
|
1657
1808
|
placement_ids?: [string, ...string[]];
|
|
1809
|
+
[k: string]: unknown;
|
|
1658
1810
|
}
|
|
1659
1811
|
/**
|
|
1660
1812
|
* 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.
|
|
@@ -1680,6 +1832,7 @@ export interface ImageAsset {
|
|
|
1680
1832
|
* Alternative text for accessibility
|
|
1681
1833
|
*/
|
|
1682
1834
|
alt_text?: string;
|
|
1835
|
+
[k: string]: unknown;
|
|
1683
1836
|
}
|
|
1684
1837
|
/**
|
|
1685
1838
|
* Video asset with URL and specifications
|
|
@@ -1709,6 +1862,7 @@ export interface VideoAsset {
|
|
|
1709
1862
|
* Video bitrate in kilobits per second
|
|
1710
1863
|
*/
|
|
1711
1864
|
bitrate_kbps?: number;
|
|
1865
|
+
[k: string]: unknown;
|
|
1712
1866
|
}
|
|
1713
1867
|
/**
|
|
1714
1868
|
* Audio asset with URL and specifications
|
|
@@ -1730,6 +1884,7 @@ export interface AudioAsset {
|
|
|
1730
1884
|
* Audio bitrate in kilobits per second
|
|
1731
1885
|
*/
|
|
1732
1886
|
bitrate_kbps?: number;
|
|
1887
|
+
[k: string]: unknown;
|
|
1733
1888
|
}
|
|
1734
1889
|
/**
|
|
1735
1890
|
* Text content asset
|
|
@@ -1743,6 +1898,7 @@ export interface TextAsset {
|
|
|
1743
1898
|
* Language code (e.g., 'en', 'es', 'fr')
|
|
1744
1899
|
*/
|
|
1745
1900
|
language?: string;
|
|
1901
|
+
[k: string]: unknown;
|
|
1746
1902
|
}
|
|
1747
1903
|
/**
|
|
1748
1904
|
* HTML content asset
|
|
@@ -1756,6 +1912,7 @@ export interface HTMLAsset {
|
|
|
1756
1912
|
* HTML version (e.g., 'HTML5')
|
|
1757
1913
|
*/
|
|
1758
1914
|
version?: string;
|
|
1915
|
+
[k: string]: unknown;
|
|
1759
1916
|
}
|
|
1760
1917
|
/**
|
|
1761
1918
|
* CSS stylesheet asset
|
|
@@ -1769,6 +1926,7 @@ export interface CSSAsset {
|
|
|
1769
1926
|
* CSS media query context (e.g., 'screen', 'print')
|
|
1770
1927
|
*/
|
|
1771
1928
|
media?: string;
|
|
1929
|
+
[k: string]: unknown;
|
|
1772
1930
|
}
|
|
1773
1931
|
/**
|
|
1774
1932
|
* JavaScript code asset
|
|
@@ -1779,6 +1937,7 @@ export interface JavaScriptAsset {
|
|
|
1779
1937
|
*/
|
|
1780
1938
|
content: string;
|
|
1781
1939
|
module_type?: JavaScriptModuleType;
|
|
1940
|
+
[k: string]: unknown;
|
|
1782
1941
|
}
|
|
1783
1942
|
/**
|
|
1784
1943
|
* Complete offering specification combining brand manifest, product selectors, and asset filters. Provides all context needed for creative generation about what is being promoted.
|
|
@@ -1804,6 +1963,7 @@ export interface PromotedOfferings {
|
|
|
1804
1963
|
assets?: {
|
|
1805
1964
|
[k: string]: unknown;
|
|
1806
1965
|
}[];
|
|
1966
|
+
[k: string]: unknown;
|
|
1807
1967
|
}[];
|
|
1808
1968
|
/**
|
|
1809
1969
|
* Selectors to choose specific assets from the brand manifest
|
|
@@ -1821,7 +1981,9 @@ export interface PromotedOfferings {
|
|
|
1821
1981
|
* Exclude assets with these tags
|
|
1822
1982
|
*/
|
|
1823
1983
|
exclude_tags?: string[];
|
|
1984
|
+
[k: string]: unknown;
|
|
1824
1985
|
};
|
|
1986
|
+
[k: string]: unknown;
|
|
1825
1987
|
}
|
|
1826
1988
|
/**
|
|
1827
1989
|
* Inline brand manifest object
|
|
@@ -1843,6 +2005,7 @@ export interface PromotedProducts {
|
|
|
1843
2005
|
* Natural language query to select products from the brand manifest (e.g., 'all Kraft Heinz pasta sauces', 'organic products under $20')
|
|
1844
2006
|
*/
|
|
1845
2007
|
manifest_query?: string;
|
|
2008
|
+
[k: string]: unknown;
|
|
1846
2009
|
}
|
|
1847
2010
|
/**
|
|
1848
2011
|
* URL reference asset
|
|
@@ -1857,6 +2020,7 @@ export interface URLAsset {
|
|
|
1857
2020
|
* Description of what this URL points to
|
|
1858
2021
|
*/
|
|
1859
2022
|
description?: string;
|
|
2023
|
+
[k: string]: unknown;
|
|
1860
2024
|
}
|
|
1861
2025
|
/**
|
|
1862
2026
|
* 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.
|
|
@@ -1935,6 +2099,7 @@ export interface Package {
|
|
|
1935
2099
|
*/
|
|
1936
2100
|
paused?: boolean;
|
|
1937
2101
|
ext?: ExtensionObject;
|
|
2102
|
+
[k: string]: unknown;
|
|
1938
2103
|
}
|
|
1939
2104
|
/**
|
|
1940
2105
|
* 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).
|
|
@@ -1954,6 +2119,7 @@ export interface CreativeAssignment {
|
|
|
1954
2119
|
* @minItems 1
|
|
1955
2120
|
*/
|
|
1956
2121
|
placement_ids?: [string, ...string[]];
|
|
2122
|
+
[k: string]: unknown;
|
|
1957
2123
|
}
|
|
1958
2124
|
/**
|
|
1959
2125
|
* 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.
|
|
@@ -2264,6 +2430,7 @@ export interface CreativeFilters {
|
|
|
2264
2430
|
* Filter creatives that have performance data when true
|
|
2265
2431
|
*/
|
|
2266
2432
|
has_performance_data?: boolean;
|
|
2433
|
+
[k: string]: unknown;
|
|
2267
2434
|
}
|
|
2268
2435
|
/**
|
|
2269
2436
|
* 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.
|
|
@@ -2288,6 +2455,7 @@ export type SubAsset = {
|
|
|
2288
2455
|
* URL for media assets (images, videos, etc.)
|
|
2289
2456
|
*/
|
|
2290
2457
|
content_uri: string;
|
|
2458
|
+
[k: string]: unknown;
|
|
2291
2459
|
} | {
|
|
2292
2460
|
/**
|
|
2293
2461
|
* Discriminator indicating this is a text asset with content
|
|
@@ -2305,6 +2473,7 @@ export type SubAsset = {
|
|
|
2305
2473
|
* Text content for text-based assets like headlines, body text, CTA text, etc.
|
|
2306
2474
|
*/
|
|
2307
2475
|
content: string | string[];
|
|
2476
|
+
[k: string]: unknown;
|
|
2308
2477
|
};
|
|
2309
2478
|
/**
|
|
2310
2479
|
* Response from creative library query with filtered results, metadata, and optional enriched data
|
|
@@ -2902,7 +3071,9 @@ export interface DeliveryMetrics {
|
|
|
2902
3071
|
* Number of screens used at this venue
|
|
2903
3072
|
*/
|
|
2904
3073
|
screens_used?: number;
|
|
3074
|
+
[k: string]: unknown;
|
|
2905
3075
|
}[];
|
|
3076
|
+
[k: string]: unknown;
|
|
2906
3077
|
};
|
|
2907
3078
|
[k: string]: unknown;
|
|
2908
3079
|
}
|
|
@@ -3084,13 +3255,10 @@ export interface CreativeManifest {
|
|
|
3084
3255
|
* IMPORTANT: Creative manifest validation MUST be performed in the context of the format specification. The format defines what type each asset_id should be, which eliminates any validation ambiguity.
|
|
3085
3256
|
*/
|
|
3086
3257
|
assets: {
|
|
3087
|
-
|
|
3088
|
-
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
3089
|
-
* via the `patternProperty` "^[a-z0-9_]+$".
|
|
3090
|
-
*/
|
|
3091
|
-
[k: string]: ImageAsset | VideoAsset | AudioAsset | VASTAsset | TextAsset | URLAsset | HTMLAsset | JavaScriptAsset | WebhookAsset | CSSAsset | DAASTAsset | PromotedOfferings;
|
|
3258
|
+
[k: string]: unknown;
|
|
3092
3259
|
};
|
|
3093
3260
|
ext?: ExtensionObject;
|
|
3261
|
+
[k: string]: unknown;
|
|
3094
3262
|
}
|
|
3095
3263
|
/**
|
|
3096
3264
|
* Format identifier this manifest is for. Can be a template format (id only) or a deterministic format (id + dimensions/duration). For dimension-specific creatives, include width/height/unit in the format_id to create a unique identifier (e.g., {id: 'display_static', width: 300, height: 250, unit: 'px'}).
|
|
@@ -3128,6 +3296,7 @@ export interface WebhookAsset {
|
|
|
3128
3296
|
*/
|
|
3129
3297
|
api_key_header?: string;
|
|
3130
3298
|
};
|
|
3299
|
+
[k: string]: unknown;
|
|
3131
3300
|
}
|
|
3132
3301
|
/**
|
|
3133
3302
|
* CSS stylesheet asset
|
|
@@ -3177,7 +3346,7 @@ export type PreviewCreativeRequest = {
|
|
|
3177
3346
|
*/
|
|
3178
3347
|
name: string;
|
|
3179
3348
|
/**
|
|
3180
|
-
* Macro values to use for this preview. Supports all universal macros from the format's supported_macros list. See docs/
|
|
3349
|
+
* Macro values to use for this preview. Supports all universal macros from the format's supported_macros list. See docs/creative/universal-macros.md for available macros.
|
|
3181
3350
|
*/
|
|
3182
3351
|
macros?: {
|
|
3183
3352
|
[k: string]: string;
|
|
@@ -3263,13 +3432,10 @@ export interface CreativeManifest1 {
|
|
|
3263
3432
|
* IMPORTANT: Creative manifest validation MUST be performed in the context of the format specification. The format defines what type each asset_id should be, which eliminates any validation ambiguity.
|
|
3264
3433
|
*/
|
|
3265
3434
|
assets: {
|
|
3266
|
-
|
|
3267
|
-
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
3268
|
-
* via the `patternProperty` "^[a-z0-9_]+$".
|
|
3269
|
-
*/
|
|
3270
|
-
[k: string]: ImageAsset | VideoAsset | AudioAsset | VASTAsset | TextAsset | URLAsset | HTMLAsset | JavaScriptAsset | WebhookAsset | CSSAsset | DAASTAsset | PromotedOfferings;
|
|
3435
|
+
[k: string]: unknown;
|
|
3271
3436
|
};
|
|
3272
3437
|
ext?: ExtensionObject;
|
|
3438
|
+
[k: string]: unknown;
|
|
3273
3439
|
}
|
|
3274
3440
|
/**
|
|
3275
3441
|
* Response containing preview links for one or more creatives. Format matches the request: single preview response for single requests, batch results for batch requests.
|
|
@@ -3323,6 +3489,7 @@ export type PreviewRender = {
|
|
|
3323
3489
|
*/
|
|
3324
3490
|
csp_policy?: string;
|
|
3325
3491
|
};
|
|
3492
|
+
[k: string]: unknown;
|
|
3326
3493
|
} | {
|
|
3327
3494
|
/**
|
|
3328
3495
|
* Unique identifier for this rendered piece within the variant
|
|
@@ -3368,6 +3535,7 @@ export type PreviewRender = {
|
|
|
3368
3535
|
*/
|
|
3369
3536
|
csp_policy?: string;
|
|
3370
3537
|
};
|
|
3538
|
+
[k: string]: unknown;
|
|
3371
3539
|
} | {
|
|
3372
3540
|
/**
|
|
3373
3541
|
* Unique identifier for this rendered piece within the variant
|
|
@@ -3417,6 +3585,7 @@ export type PreviewRender = {
|
|
|
3417
3585
|
*/
|
|
3418
3586
|
csp_policy?: string;
|
|
3419
3587
|
};
|
|
3588
|
+
[k: string]: unknown;
|
|
3420
3589
|
};
|
|
3421
3590
|
/**
|
|
3422
3591
|
* Single preview response - each preview URL returns an HTML page that can be embedded in an iframe
|
|
@@ -3506,6 +3675,7 @@ export type Destination = {
|
|
|
3506
3675
|
* Optional account identifier on the platform
|
|
3507
3676
|
*/
|
|
3508
3677
|
account?: string;
|
|
3678
|
+
[k: string]: unknown;
|
|
3509
3679
|
} | {
|
|
3510
3680
|
/**
|
|
3511
3681
|
* Discriminator indicating this is an agent URL-based deployment
|
|
@@ -3519,6 +3689,7 @@ export type Destination = {
|
|
|
3519
3689
|
* Optional account identifier on the agent
|
|
3520
3690
|
*/
|
|
3521
3691
|
account?: string;
|
|
3692
|
+
[k: string]: unknown;
|
|
3522
3693
|
};
|
|
3523
3694
|
/**
|
|
3524
3695
|
* Types of signal catalogs available for audience targeting
|
|
@@ -3573,6 +3744,7 @@ export interface SignalFilters {
|
|
|
3573
3744
|
* Minimum coverage requirement
|
|
3574
3745
|
*/
|
|
3575
3746
|
min_coverage_percentage?: number;
|
|
3747
|
+
[k: string]: unknown;
|
|
3576
3748
|
}
|
|
3577
3749
|
/**
|
|
3578
3750
|
* 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.
|
|
@@ -3606,6 +3778,7 @@ export type Deployment = {
|
|
|
3606
3778
|
* Timestamp when activation completed (if is_live=true)
|
|
3607
3779
|
*/
|
|
3608
3780
|
deployed_at?: string;
|
|
3781
|
+
[k: string]: unknown;
|
|
3609
3782
|
} | {
|
|
3610
3783
|
/**
|
|
3611
3784
|
* Discriminator indicating this is an agent URL-based deployment
|
|
@@ -3632,6 +3805,7 @@ export type Deployment = {
|
|
|
3632
3805
|
* Timestamp when activation completed (if is_live=true)
|
|
3633
3806
|
*/
|
|
3634
3807
|
deployed_at?: string;
|
|
3808
|
+
[k: string]: unknown;
|
|
3635
3809
|
};
|
|
3636
3810
|
/**
|
|
3637
3811
|
* The key to use for targeting. Only present if is_live=true AND requester has access to this deployment.
|
|
@@ -3645,6 +3819,7 @@ export type ActivationKey = {
|
|
|
3645
3819
|
* The platform-specific segment identifier to use in campaign targeting
|
|
3646
3820
|
*/
|
|
3647
3821
|
segment_id: string;
|
|
3822
|
+
[k: string]: unknown;
|
|
3648
3823
|
} | {
|
|
3649
3824
|
/**
|
|
3650
3825
|
* Key-value pair based targeting
|
|
@@ -3658,6 +3833,7 @@ export type ActivationKey = {
|
|
|
3658
3833
|
* The targeting parameter value
|
|
3659
3834
|
*/
|
|
3660
3835
|
value: string;
|
|
3836
|
+
[k: string]: unknown;
|
|
3661
3837
|
};
|
|
3662
3838
|
/**
|
|
3663
3839
|
* The key to use for targeting. Only present if is_live=true AND requester has access to this deployment.
|
|
@@ -3671,6 +3847,7 @@ export type ActivationKey1 = {
|
|
|
3671
3847
|
* The platform-specific segment identifier to use in campaign targeting
|
|
3672
3848
|
*/
|
|
3673
3849
|
segment_id: string;
|
|
3850
|
+
[k: string]: unknown;
|
|
3674
3851
|
} | {
|
|
3675
3852
|
/**
|
|
3676
3853
|
* Key-value pair based targeting
|
|
@@ -3684,6 +3861,7 @@ export type ActivationKey1 = {
|
|
|
3684
3861
|
* The targeting parameter value
|
|
3685
3862
|
*/
|
|
3686
3863
|
value: string;
|
|
3864
|
+
[k: string]: unknown;
|
|
3687
3865
|
};
|
|
3688
3866
|
/**
|
|
3689
3867
|
* Response payload for get_signals task
|