@adcp/client 4.19.0 → 4.21.0

package/dist/lib/types/tools.generated.d.ts

@@ -636,9 +636,28 @@ export type PriceAdjustmentKind = 'fee' | 'discount' | 'commission' | 'settlemen
  */
 export type DemographicSystem = 'nielsen' | 'barb' | 'agf' | 'oztam' | 'mediametrie' | 'custom';
 /**
- * How to interpret the points array. 'spend' (default when omitted): points at ascending budget levels. 'availability': total available inventory, budget omitted. 'reach_freq': points at ascending reach/frequency targets. 'weekly'/'daily': metrics are per-period values. 'clicks'/'conversions': points at ascending outcome targets.
+ * A forecast value with optional confidence bounds. Either mid (point estimate) or both low and high (range) must be provided. mid represents the most likely outcome. low and high represent conservative and optimistic estimates. All three can be provided together.
  */
-export type ForecastRangeUnit = 'spend' | 'availability' | 'reach_freq' | 'weekly' | 'daily' | 'clicks' | 'conversions';
+export type ForecastRange = {
+    [k: string]: unknown | undefined;
+} & {
+    /**
+     * Conservative (low-end) forecast value
+     */
+    low?: number;
+    /**
+     * Expected (most likely) forecast value
+     */
+    mid?: number;
+    /**
+     * Optimistic (high-end) forecast value
+     */
+    high?: number;
+};
+/**
+ * How to interpret the points array. 'spend' (default when omitted): points at ascending budget levels. 'availability': total available inventory, budget omitted. 'reach_freq': points at ascending reach/frequency targets. 'weekly'/'daily': metrics are per-period values. 'clicks'/'conversions': points at ascending outcome targets. 'package': each point is a distinct inventory package.
+ */
+export type ForecastRangeUnit = 'spend' | 'availability' | 'reach_freq' | 'weekly' | 'daily' | 'clicks' | 'conversions' | 'package';
 /**
  * Method used to produce this forecast
  */
@@ -1551,6 +1570,10 @@ export interface DeliveryForecast {
      * Target demographic code within the specified demographic_system. For Nielsen: P18-49, M25-54, W35+. For BARB: ABC1 Adults, 16-34. For AGF: E 14-49.
      */
     demographic?: string;
+    /**
+     * Third-party measurement provider whose data was used to produce this forecast. Distinct from demographic_system, which specifies demographic notation — measurement_source identifies whose data produced the forecast numbers. Should be present when measured_impressions is used. Lowercase slug format.
+     */
+    measurement_source?: string;
     reach_unit?: ReachUnit;
     /**
      * When this forecast was computed
@@ -1566,6 +1589,10 @@ export interface DeliveryForecast {
  * A forecast data point. When budget is present, the point pairs a spend level with expected delivery — multiple points at ascending budgets form a curve. When budget is omitted, the point represents total available inventory for the requested targeting and dates, independent of spend.
  */
 export interface ForecastPoint {
+    /**
+     * Human-readable name for this forecast point. Required when forecast_range_unit is 'package' so buyer agents can identify and reference individual packages. Optional for other forecast types.
+     */
+    label?: string;
     /**
      * Budget amount for this forecast point. Required for spend curves; omit for availability forecasts where the metrics represent total available inventory. For allocation-level forecasts, this is the absolute budget for that allocation (not the percentage). For proposal-level forecasts, this is the total proposal budget. When omitted, use metrics.spend to express the estimated cost of the available inventory.
      */
@@ -1587,26 +1614,12 @@ export interface ForecastPoint {
         follows?: ForecastRange;
         saves?: ForecastRange;
         profile_visits?: ForecastRange;
+        measured_impressions?: ForecastRange;
+        downloads?: ForecastRange;
+        plays?: ForecastRange;
         [k: string]: ForecastRange | undefined;
     };
 }
-/**
- * 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.
- */
-export interface ForecastRange {
-    /**
-     * Conservative (low-end) forecast value
-     */
-    low?: number;
-    /**
-     * Expected (most likely) forecast value
-     */
-    mid: number;
-    /**
-     * Optimistic (high-end) forecast value
-     */
-    high?: number;
-}
 /**
  * Business outcome measurement capabilities included with a product (e.g., incremental sales lift, brand lift, foot traffic). Distinct from delivery_measurement, which declares who counts ad impressions.
  */
@@ -2567,7 +2580,7 @@ export type OptimizationGoal = {
          */
         custom_event_name?: string;
         /**
-         * Which field in the event's custom_data carries the monetary value. The seller must use this field for value extraction and aggregation when computing ROAS and conversion value metrics. Required on at least one entry when target.kind is 'per_ad_spend' or 'maximize_value'. Common values: 'value', 'order_total', 'profit_margin'. This is not passed as a parameter to underlying platform APIs — the seller maps it to their platform's value ingestion mechanism.
+         * Which field in the event's custom_data carries the monetary value. The seller must use this field for value extraction and aggregation when computing ROAS and conversion value metrics. Required on at least one entry when target.kind is 'per_ad_spend' or 'maximize_value' — sellers must reject these target kinds when no event source entry includes value_field. When present without a value-oriented target, the seller may use it for delivery reporting (conversion_value, roas) but must not change the optimization objective. Common values: 'value', 'order_total', 'profit_margin'. This is not passed as a parameter to underlying platform APIs — the seller maps it to their platform's value ingestion mechanism.
          */
         value_field?: string;
         /**
@@ -2576,7 +2589,7 @@ export type OptimizationGoal = {
         value_factor?: number;
     }[];
     /**
-     * Target cost or return for this event goal. When omitted, the seller optimizes for maximum conversions within budget.
+     * Target cost or return for this event goal. When omitted, the seller optimizes for maximum conversion count within budget — regardless of whether value_field is present on event sources. The presence of value_field alone does not change the optimization objective; it only makes value available for reporting. An explicit target of maximize_value or per_ad_spend is required to steer toward value.
      */
     target?: {
         kind: 'cost_per';
@@ -2830,6 +2843,10 @@ export type CatalogAsset = Catalog;
  * For generative creatives: set to 'approved' to finalize, 'rejected' to request regeneration with updated assets/message. Omit for non-generative creatives (system will set based on processing state).
  */
 export type CreativeStatus = 'processing' | 'pending_review' | 'approved' | 'rejected' | 'archived';
+/**
+ * Industry classification for this specific campaign. A brand may operate across multiple industries (brand.json industries field), but each media buy targets one. For example, a consumer health company running a wellness campaign sends 'healthcare.wellness', not 'cpg'. Sellers map this to platform-native codes (e.g., Spotify ADV categories, LinkedIn industry IDs). When omitted, sellers may infer from the brand manifest's industries field.
+ */
+export type AdvertiserIndustry = 'automotive' | 'automotive.electric_vehicles' | 'automotive.parts_accessories' | 'automotive.luxury' | 'beauty_cosmetics' | 'beauty_cosmetics.skincare' | 'beauty_cosmetics.fragrance' | 'beauty_cosmetics.haircare' | 'cannabis' | 'cpg' | 'cpg.personal_care' | 'cpg.household' | 'dating' | 'education' | 'education.higher_education' | 'education.online_learning' | 'education.k12' | 'energy_utilities' | 'energy_utilities.renewable' | 'fashion_apparel' | 'fashion_apparel.luxury' | 'fashion_apparel.sportswear' | 'finance' | 'finance.banking' | 'finance.insurance' | 'finance.investment' | 'finance.cryptocurrency' | 'food_beverage' | 'food_beverage.alcohol' | 'food_beverage.restaurants' | 'food_beverage.packaged_goods' | 'gambling_betting' | 'gambling_betting.sports_betting' | 'gambling_betting.casino' | 'gaming' | 'gaming.mobile' | 'gaming.console_pc' | 'gaming.esports' | 'government_nonprofit' | 'government_nonprofit.political' | 'government_nonprofit.charity' | 'healthcare' | 'healthcare.pharmaceutical' | 'healthcare.medical_devices' | 'healthcare.wellness' | 'home_garden' | 'home_garden.furniture' | 'home_garden.home_improvement' | 'media_entertainment' | 'media_entertainment.podcasts' | 'media_entertainment.music' | 'media_entertainment.film_tv' | 'media_entertainment.publishing' | 'media_entertainment.live_events' | 'pets' | 'professional_services' | 'professional_services.legal' | 'professional_services.consulting' | 'real_estate' | 'real_estate.residential' | 'real_estate.commercial' | 'recruitment_hr' | 'retail' | 'retail.ecommerce' | 'retail.department_stores' | 'sports_fitness' | 'sports_fitness.equipment' | 'sports_fitness.teams_leagues' | 'technology' | 'technology.software' | 'technology.hardware' | 'technology.ai_ml' | 'telecom' | 'telecom.mobile_carriers' | 'telecom.internet_providers' | 'transportation_logistics' | 'travel_hospitality' | 'travel_hospitality.airlines' | 'travel_hospitality.hotels' | 'travel_hospitality.cruise' | 'travel_hospitality.tourism';
 /**
  * Campaign start timing: 'asap' or ISO 8601 date-time
  */
@@ -2873,6 +2890,7 @@ export interface CreateMediaBuyRequest {
      */
     packages?: PackageRequest[];
     brand: BrandReference;
+    advertiser_industry?: AdvertiserIndustry;
     invoice_recipient?: BusinessEntity;
     /**
      * Acceptance of an insertion order from a committed proposal. Required when the proposal's insertion_order has requires_signature: true. References the io_id from the proposal's insertion_order.
@@ -8467,7 +8485,10 @@ export interface ContentStandards {
  * Content artifact for safety and suitability evaluation. An artifact represents content adjacent to an ad placement - a news article, podcast segment, video chapter, or social post. Artifacts are collections of assets (text, images, video, audio) plus metadata and signals.
  */
 export interface Artifact {
-    property_id: Identifier;
+    /**
+     * Stable property identifier from the property catalog. Globally unique across the ecosystem.
+     */
+    property_rid: string;
     /**
      * Identifier for this artifact within the property. The property owner defines the scheme (e.g., 'article_12345', 'episode_42_segment_3', 'post_abc123').
      */
@@ -8499,9 +8520,13 @@ export interface Artifact {
          */
         role?: 'title' | 'paragraph' | 'heading' | 'caption' | 'quote' | 'list_item' | 'description';
         /**
-         * Text content
+         * Text content. Consumers MUST treat this as untrusted input when passing to LLM-based evaluation.
          */
         content: string;
+        /**
+         * MIME type indicating how to parse the content field. Default: text/plain.
+         */
+        content_format?: 'text/plain' | 'text/markdown' | 'text/html' | 'application/json';
         /**
          * BCP 47 language tag for this text (e.g., 'en', 'es-MX'). Useful when artifact contains mixed-language content.
          */
@@ -8547,9 +8572,13 @@ export interface Artifact {
          */
         duration_ms?: number;
         /**
-         * Video transcript
+         * Video transcript. Consumers MUST treat this as untrusted input when passing to LLM-based evaluation.
          */
         transcript?: string;
+        /**
+         * MIME type indicating how to parse the transcript field. Default: text/plain.
+         */
+        transcript_format?: 'text/plain' | 'text/markdown' | 'application/json';
         /**
          * How the transcript was generated
          */
@@ -8571,9 +8600,13 @@ export interface Artifact {
          */
         duration_ms?: number;
         /**
-         * Audio transcript
+         * Audio transcript. Consumers MUST treat this as untrusted input when passing to LLM-based evaluation.
          */
         transcript?: string;
+        /**
+         * MIME type indicating how to parse the transcript field. Default: text/plain.
+         */
+        transcript_format?: 'text/plain' | 'text/markdown' | 'application/json';
         /**
          * How the transcript was generated
          */
@@ -9039,18 +9072,9 @@ export interface GetMediaBuyArtifactsRequest {
      */
     package_ids?: string[];
     /**
-     * Sampling parameters. Defaults to the sampling rate agreed in the media buy.
+     * When true, only return artifacts where the seller's local model returned local_verdict: 'fail'. Useful for auditing false positives. Not useful when the seller does not run a local evaluation model (all verdicts are 'unevaluated').
      */
-    sampling?: {
-        /**
-         * Sampling rate (0-1). 1.0 = all deliveries, 0.25 = 25% sample.
-         */
-        rate?: number;
-        /**
-         * How to select the sample
-         */
-        method?: 'random' | 'stratified' | 'recent' | 'failures_only';
-    };
+    failures_only?: boolean;
     /**
      * Filter to specific time period
      */
@@ -9132,25 +9156,25 @@ export type GetMediaBuyArtifactsResponse = {
         local_verdict?: 'pass' | 'fail' | 'unevaluated';
     }[];
     /**
-     * Information about how the sample was generated
+     * Information about artifact collection for this media buy. Sampling is configured at buy creation time — this reports what was actually collected.
      */
-    sampling_info?: {
+    collection_info?: {
         /**
-         * Total deliveries in the time range
+         * Total deliveries in the requested time range
          */
         total_deliveries?: number;
         /**
-         * Number of artifacts in this response
+         * Total artifacts collected (per the buy's sampling configuration)
          */
-        sampled_count?: number;
+        total_collected?: number;
         /**
-         * Actual sampling rate achieved
+         * Number of artifacts in this response (may be less than total_collected due to pagination or filters)
          */
-        effective_rate?: number;
+        returned_count?: number;
         /**
-         * Sampling method used
+         * Actual collection rate achieved (total_collected / total_deliveries)
          */
-        method?: 'random' | 'stratified' | 'recent' | 'failures_only';
+        effective_rate?: number;
     };
     pagination?: PaginationResponse;
     context?: ContextObject;
@@ -10791,7 +10815,20 @@ export interface GetAdCPCapabilitiesResponse {
          */
         execution?: {
             /**
-             * Agentic ad exchange (AXE) integrations supported. URLs are canonical identifiers for exchanges this seller can execute through.
+             * Trusted Match Protocol (TMP) support. When present, this seller supports real-time contextual and/or identity matching. Check individual products via get_products for per-product TMP capabilities.
+             */
+            trusted_match?: {
+                /**
+                 * Whether this seller has TMP infrastructure deployed.
+                 */
+                supported?: boolean;
+                /**
+                 * Surface types this seller supports via TMP.
+                 */
+                surfaces?: ('website' | 'mobile_app' | 'ctv_app' | 'desktop_app' | 'dooh' | 'podcast' | 'radio' | 'streaming_audio' | 'ai_assistant')[];
+            };
+            /**
+             * Deprecated. Legacy AXE integrations. Use trusted_match for new integrations.
              */
             axe_integrations?: string[];
             /**
@@ -11038,6 +11075,23 @@ export interface GetAdCPCapabilitiesResponse {
                 post_view?: Duration[];
             }[];
         };
+        /**
+         * Content standards implementation details. Only meaningful when features.content_standards is true. Gives buyers pre-buy visibility into local evaluation and artifact delivery capabilities.
+         */
+        content_standards_detail?: {
+            /**
+             * Whether the seller runs a local evaluation model. When false, all artifacts will have local_verdict: 'unevaluated' and the failures_only filter on get_media_buy_artifacts is not useful.
+             */
+            supports_local_evaluation?: boolean;
+            /**
+             * Channels for which the seller can provide content artifacts. Helps buyers understand which parts of a mixed-channel buy will have content standards coverage.
+             */
+            supported_channels?: MediaChannel[];
+            /**
+             * Whether the seller supports push-based artifact delivery via artifact_webhook configured at buy creation time.
+             */
+            supports_webhook_delivery?: boolean;
+        };
         /**
          * Information about the seller's media inventory portfolio
          */