@adcp/sdk 13.0.0-rc.2 → 13.0.0-rc.4

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

@@ -1,5 +1,5 @@
 import type { AudienceConstraints, AudioAssetRequirements, CSSAssetRequirements, DAASTAssetRequirements, HTMLAssetRequirements, ImageAssetRequirements, JavaScriptAssetRequirements, MarkdownAssetRequirements, PurchaseType, TextAssetRequirements, URLAssetRequirements, VASTAssetRequirements, VideoAssetRequirements, WebhookAssetRequirements } from './core.generated.mjs';
-export type { AudienceConstraints, PurchaseType } from './core.generated.mjs';
+export type { AudienceConstraints, CatalogItemDeliveryMetrics, GeoDeliveryMetrics, KeywordDeliveryMetrics, PurchaseType } from './core.generated.mjs';
 /**
  * Request parameters for discovering or refining advertising products. buying_mode declares the buyer's intent: 'brief' for curated discovery, 'wholesale' for raw wholesale product feed access, or 'refine' to iterate on known products and proposals.
  */
@@ -10641,11 +10641,11 @@ export type MissingMetric = {
 /**
  * Delivery metrics row for one catalog item within a package.
  */
-export type CatalogItemDeliveryMetrics = DeliveryMetrics & {
+export type GetMediaBuyDeliveryCatalogItemMetrics = DeliveryMetrics & {
     /**
      * Catalog item identifier (e.g., SKU, GTIN, job_id, offering_id)
      */
-    content_id: string;
+    content_id?: string;
     content_id_type?: ContentIDType;
 };
 /**
@@ -10666,18 +10666,18 @@ export type CreativeDeliveryMetrics = DeliveryMetrics & {
 /**
  * Delivery metrics row for one keyword and match-type pair within a package.
  */
-export type KeywordDeliveryMetrics = DeliveryMetrics & {
+export type GetMediaBuyDeliveryKeywordMetrics = DeliveryMetrics & {
     /**
      * The targeted keyword
      */
-    keyword: string;
-    match_type: MatchType;
+    keyword?: string;
+    match_type?: MatchType;
 };
 /**
  * Delivery metrics row for one geographic area within a package.
  */
-export type GeoDeliveryMetrics = DeliveryMetrics & {
-    geo_level: GeographicTargetingLevel;
+export type GetMediaBuyDeliveryGeoMetrics = DeliveryMetrics & {
+    geo_level?: GeographicTargetingLevel;
     /**
      * Classification system for metro or postal_area levels. Metro rows use metro-system values. Native postal rows use country-local postal-system values with country; deprecated legacy postal rows may use legacy-postal-system values.
      */
@@ -10690,12 +10690,44 @@ export type GeoDeliveryMetrics = DeliveryMetrics & {
     /**
      * Geographic code within the level and system. Country: ISO 3166-1 alpha-2 ('US'). Region: ISO 3166-2 with country prefix ('US-CA'). Metro/postal: system-specific code ('501', '10001').
      */
-    geo_code: string;
+    geo_code?: string;
     /**
      * Human-readable geographic name (e.g., 'United States', 'California', 'New York DMA')
      */
     geo_name?: string;
 };
+export type GetMediaBuyDeliveryDeviceTypeMetrics = DeliveryMetrics & {
+    device_type?: DeviceType;
+};
+export type GetMediaBuyDeliveryDevicePlatformMetrics = DeliveryMetrics & {
+    device_platform?: DevicePlatform;
+};
+export type GetMediaBuyDeliveryAudienceMetrics = DeliveryMetrics & {
+    /**
+     * Audience segment identifier. For 'synced' source, matches audience_id from sync_audiences. For other sources, seller-defined.
+     */
+    audience_id?: string;
+    audience_source?: AudienceSource;
+    /**
+     * Human-readable audience segment name
+     */
+    audience_name?: string;
+};
+export type GetMediaBuyDeliveryPlacementMetrics = DeliveryMetrics & {
+    /**
+     * Placement identifier from the product's placements array
+     */
+    placement_id?: string;
+    /**
+     * Human-readable placement name
+     */
+    placement_name?: string;
+    /**
+     * Canonical publisher domain whose adagents.json namespace this placement belongs to, matching the `publisher_domain` on the product's `placements[]` entry that `placement_id` resolves to (see core/placement.json). Lets buyers attribute delivered impressions to a publisher namespace without re-fetching the product catalog — the common case for multi-publisher buys through a single sales agent. Sellers SHOULD emit it whenever the resolving product placement carries a publisher_domain (always true for `kind: publisher_ref`); sellers MAY omit it only for `seller_inline` placements in a legacy single-publisher context where the seller agent's own domain is the namespace. Single-valued: a placement resolves within exactly one publisher namespace (package-level attribution, where an ad-network product can span publishers, is a separate concern).
+     * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
+     */
+    publisher_domain?: string;
+};
 /**
  * Response payload for get_media_buy_delivery task
  */
@@ -10969,7 +11001,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by catalog item within this package. Available for catalog-driven packages when the seller supports item-level reporting.
              */
-            by_catalog_item?: CatalogItemDeliveryMetrics[];
+            by_catalog_item?: GetMediaBuyDeliveryCatalogItemMetrics[];
             /**
              * Metrics broken down by creative within this package. Available when the seller supports creative-level reporting.
              */
@@ -10977,11 +11009,11 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Metrics broken down by keyword within this package. One row per (keyword, match_type) pair — the same keyword with different match types appears as separate rows. Keyword-grain only: rows reflect aggregate performance of each targeted keyword, not individual search queries. Rows may not sum to package totals when a single impression is attributed to the triggering keyword only. Available for search and retail media packages when the seller supports keyword-level reporting.
              */
-            by_keyword?: KeywordDeliveryMetrics[];
+            by_keyword?: GetMediaBuyDeliveryKeywordMetrics[];
             /**
              * Delivery by geographic area within this package. Available when the buyer requests geo breakdown via reporting_dimensions and the seller supports it. Each dimension's rows are independent slices that should sum to the package total.
              */
-            by_geo?: GeoDeliveryMetrics[];
+            by_geo?: GetMediaBuyDeliveryGeoMetrics[];
             /**
              * Whether by_geo was truncated due to the requested limit or a seller-imposed maximum. Sellers MUST return this flag whenever by_geo is present (false means the list is complete).
              */
@@ -10989,9 +11021,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by device form factor within this package. Available when the buyer requests device_type breakdown via reporting_dimensions and the seller supports it.
              */
-            by_device_type?: (DeliveryMetrics & {
-                device_type?: DeviceType;
-            })[];
+            by_device_type?: GetMediaBuyDeliveryDeviceTypeMetrics[];
             /**
              * Whether by_device_type was truncated. Sellers MUST return this flag whenever by_device_type is present (false means the list is complete).
              */
@@ -10999,9 +11029,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by operating system within this package. Available when the buyer requests device_platform breakdown via reporting_dimensions and the seller supports it. Useful for CTV campaigns where tvOS vs Roku OS vs Fire OS matters.
              */
-            by_device_platform?: (DeliveryMetrics & {
-                device_platform?: DevicePlatform;
-            })[];
+            by_device_platform?: GetMediaBuyDeliveryDevicePlatformMetrics[];
             /**
              * Whether by_device_platform was truncated. Sellers MUST return this flag whenever by_device_platform is present (false means the list is complete).
              */
@@ -11009,17 +11037,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by audience segment within this package. Available when the buyer requests audience breakdown via reporting_dimensions and the seller supports it. Only 'synced' audiences are directly targetable via the targeting overlay; other sources are informational.
              */
-            by_audience?: (DeliveryMetrics & {
-                /**
-                 * Audience segment identifier. For 'synced' source, matches audience_id from sync_audiences. For other sources, seller-defined.
-                 */
-                audience_id?: string;
-                audience_source?: AudienceSource;
-                /**
-                 * Human-readable audience segment name
-                 */
-                audience_name?: string;
-            })[];
+            by_audience?: GetMediaBuyDeliveryAudienceMetrics[];
             /**
              * Whether by_audience was truncated. Sellers MUST return this flag whenever by_audience is present (false means the list is complete).
              */
@@ -11027,21 +11045,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by placement within this package. Available when the buyer requests placement breakdown via reporting_dimensions and the seller supports it. Placement IDs reference the product's placements array.
              */
-            by_placement?: (DeliveryMetrics & {
-                /**
-                 * Placement identifier from the product's placements array
-                 */
-                placement_id?: string;
-                /**
-                 * Human-readable placement name
-                 */
-                placement_name?: string;
-                /**
-                 * Canonical publisher domain whose adagents.json namespace this placement belongs to, matching the `publisher_domain` on the product's `placements[]` entry that `placement_id` resolves to (see core/placement.json). Lets buyers attribute delivered impressions to a publisher namespace without re-fetching the product catalog — the common case for multi-publisher buys through a single sales agent. Sellers SHOULD emit it whenever the resolving product placement carries a publisher_domain (always true for `kind: publisher_ref`); sellers MAY omit it only for `seller_inline` placements in a legacy single-publisher context where the seller agent's own domain is the namespace. Single-valued: a placement resolves within exactly one publisher namespace (package-level attribution, where an ad-network product can span publishers, is a separate concern).
-                 * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
-                 */
-                publisher_domain?: string;
-            })[];
+            by_placement?: GetMediaBuyDeliveryPlacementMetrics[];
             /**
              * Whether by_placement was truncated. Sellers MUST return this flag whenever by_placement is present (false means the list is complete).
              */

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

@@ -1,5 +1,5 @@
 import type { AudienceConstraints, AudioAssetRequirements, CSSAssetRequirements, DAASTAssetRequirements, HTMLAssetRequirements, ImageAssetRequirements, JavaScriptAssetRequirements, MarkdownAssetRequirements, PurchaseType, TextAssetRequirements, URLAssetRequirements, VASTAssetRequirements, VideoAssetRequirements, WebhookAssetRequirements } from './core.generated';
-export type { AudienceConstraints, PurchaseType } from './core.generated';
+export type { AudienceConstraints, CatalogItemDeliveryMetrics, GeoDeliveryMetrics, KeywordDeliveryMetrics, PurchaseType } from './core.generated';
 /**
  * Request parameters for discovering or refining advertising products. buying_mode declares the buyer's intent: 'brief' for curated discovery, 'wholesale' for raw wholesale product feed access, or 'refine' to iterate on known products and proposals.
  */
@@ -10641,11 +10641,11 @@ export type MissingMetric = {
 /**
  * Delivery metrics row for one catalog item within a package.
  */
-export type CatalogItemDeliveryMetrics = DeliveryMetrics & {
+export type GetMediaBuyDeliveryCatalogItemMetrics = DeliveryMetrics & {
     /**
      * Catalog item identifier (e.g., SKU, GTIN, job_id, offering_id)
      */
-    content_id: string;
+    content_id?: string;
     content_id_type?: ContentIDType;
 };
 /**
@@ -10666,18 +10666,18 @@ export type CreativeDeliveryMetrics = DeliveryMetrics & {
 /**
  * Delivery metrics row for one keyword and match-type pair within a package.
  */
-export type KeywordDeliveryMetrics = DeliveryMetrics & {
+export type GetMediaBuyDeliveryKeywordMetrics = DeliveryMetrics & {
     /**
      * The targeted keyword
      */
-    keyword: string;
-    match_type: MatchType;
+    keyword?: string;
+    match_type?: MatchType;
 };
 /**
  * Delivery metrics row for one geographic area within a package.
  */
-export type GeoDeliveryMetrics = DeliveryMetrics & {
-    geo_level: GeographicTargetingLevel;
+export type GetMediaBuyDeliveryGeoMetrics = DeliveryMetrics & {
+    geo_level?: GeographicTargetingLevel;
     /**
      * Classification system for metro or postal_area levels. Metro rows use metro-system values. Native postal rows use country-local postal-system values with country; deprecated legacy postal rows may use legacy-postal-system values.
      */
@@ -10690,12 +10690,44 @@ export type GeoDeliveryMetrics = DeliveryMetrics & {
     /**
      * Geographic code within the level and system. Country: ISO 3166-1 alpha-2 ('US'). Region: ISO 3166-2 with country prefix ('US-CA'). Metro/postal: system-specific code ('501', '10001').
      */
-    geo_code: string;
+    geo_code?: string;
     /**
      * Human-readable geographic name (e.g., 'United States', 'California', 'New York DMA')
      */
     geo_name?: string;
 };
+export type GetMediaBuyDeliveryDeviceTypeMetrics = DeliveryMetrics & {
+    device_type?: DeviceType;
+};
+export type GetMediaBuyDeliveryDevicePlatformMetrics = DeliveryMetrics & {
+    device_platform?: DevicePlatform;
+};
+export type GetMediaBuyDeliveryAudienceMetrics = DeliveryMetrics & {
+    /**
+     * Audience segment identifier. For 'synced' source, matches audience_id from sync_audiences. For other sources, seller-defined.
+     */
+    audience_id?: string;
+    audience_source?: AudienceSource;
+    /**
+     * Human-readable audience segment name
+     */
+    audience_name?: string;
+};
+export type GetMediaBuyDeliveryPlacementMetrics = DeliveryMetrics & {
+    /**
+     * Placement identifier from the product's placements array
+     */
+    placement_id?: string;
+    /**
+     * Human-readable placement name
+     */
+    placement_name?: string;
+    /**
+     * Canonical publisher domain whose adagents.json namespace this placement belongs to, matching the `publisher_domain` on the product's `placements[]` entry that `placement_id` resolves to (see core/placement.json). Lets buyers attribute delivered impressions to a publisher namespace without re-fetching the product catalog — the common case for multi-publisher buys through a single sales agent. Sellers SHOULD emit it whenever the resolving product placement carries a publisher_domain (always true for `kind: publisher_ref`); sellers MAY omit it only for `seller_inline` placements in a legacy single-publisher context where the seller agent's own domain is the namespace. Single-valued: a placement resolves within exactly one publisher namespace (package-level attribution, where an ad-network product can span publishers, is a separate concern).
+     * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
+     */
+    publisher_domain?: string;
+};
 /**
  * Response payload for get_media_buy_delivery task
  */
@@ -10969,7 +11001,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by catalog item within this package. Available for catalog-driven packages when the seller supports item-level reporting.
              */
-            by_catalog_item?: CatalogItemDeliveryMetrics[];
+            by_catalog_item?: GetMediaBuyDeliveryCatalogItemMetrics[];
             /**
              * Metrics broken down by creative within this package. Available when the seller supports creative-level reporting.
              */
@@ -10977,11 +11009,11 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Metrics broken down by keyword within this package. One row per (keyword, match_type) pair — the same keyword with different match types appears as separate rows. Keyword-grain only: rows reflect aggregate performance of each targeted keyword, not individual search queries. Rows may not sum to package totals when a single impression is attributed to the triggering keyword only. Available for search and retail media packages when the seller supports keyword-level reporting.
              */
-            by_keyword?: KeywordDeliveryMetrics[];
+            by_keyword?: GetMediaBuyDeliveryKeywordMetrics[];
             /**
              * Delivery by geographic area within this package. Available when the buyer requests geo breakdown via reporting_dimensions and the seller supports it. Each dimension's rows are independent slices that should sum to the package total.
              */
-            by_geo?: GeoDeliveryMetrics[];
+            by_geo?: GetMediaBuyDeliveryGeoMetrics[];
             /**
              * Whether by_geo was truncated due to the requested limit or a seller-imposed maximum. Sellers MUST return this flag whenever by_geo is present (false means the list is complete).
              */
@@ -10989,9 +11021,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by device form factor within this package. Available when the buyer requests device_type breakdown via reporting_dimensions and the seller supports it.
              */
-            by_device_type?: (DeliveryMetrics & {
-                device_type?: DeviceType;
-            })[];
+            by_device_type?: GetMediaBuyDeliveryDeviceTypeMetrics[];
             /**
              * Whether by_device_type was truncated. Sellers MUST return this flag whenever by_device_type is present (false means the list is complete).
              */
@@ -10999,9 +11029,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by operating system within this package. Available when the buyer requests device_platform breakdown via reporting_dimensions and the seller supports it. Useful for CTV campaigns where tvOS vs Roku OS vs Fire OS matters.
              */
-            by_device_platform?: (DeliveryMetrics & {
-                device_platform?: DevicePlatform;
-            })[];
+            by_device_platform?: GetMediaBuyDeliveryDevicePlatformMetrics[];
             /**
              * Whether by_device_platform was truncated. Sellers MUST return this flag whenever by_device_platform is present (false means the list is complete).
              */
@@ -11009,17 +11037,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by audience segment within this package. Available when the buyer requests audience breakdown via reporting_dimensions and the seller supports it. Only 'synced' audiences are directly targetable via the targeting overlay; other sources are informational.
              */
-            by_audience?: (DeliveryMetrics & {
-                /**
-                 * Audience segment identifier. For 'synced' source, matches audience_id from sync_audiences. For other sources, seller-defined.
-                 */
-                audience_id?: string;
-                audience_source?: AudienceSource;
-                /**
-                 * Human-readable audience segment name
-                 */
-                audience_name?: string;
-            })[];
+            by_audience?: GetMediaBuyDeliveryAudienceMetrics[];
             /**
              * Whether by_audience was truncated. Sellers MUST return this flag whenever by_audience is present (false means the list is complete).
              */
@@ -11027,21 +11045,7 @@ export interface GetMediaBuyDeliveryResponse {
             /**
              * Delivery by placement within this package. Available when the buyer requests placement breakdown via reporting_dimensions and the seller supports it. Placement IDs reference the product's placements array.
              */
-            by_placement?: (DeliveryMetrics & {
-                /**
-                 * Placement identifier from the product's placements array
-                 */
-                placement_id?: string;
-                /**
-                 * Human-readable placement name
-                 */
-                placement_name?: string;
-                /**
-                 * Canonical publisher domain whose adagents.json namespace this placement belongs to, matching the `publisher_domain` on the product's `placements[]` entry that `placement_id` resolves to (see core/placement.json). Lets buyers attribute delivered impressions to a publisher namespace without re-fetching the product catalog — the common case for multi-publisher buys through a single sales agent. Sellers SHOULD emit it whenever the resolving product placement carries a publisher_domain (always true for `kind: publisher_ref`); sellers MAY omit it only for `seller_inline` placements in a legacy single-publisher context where the seller agent's own domain is the namespace. Single-valued: a placement resolves within exactly one publisher namespace (package-level attribution, where an ad-network product can span publishers, is a separate concern).
-                 * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$
-                 */
-                publisher_domain?: string;
-            })[];
+            by_placement?: GetMediaBuyDeliveryPlacementMetrics[];
             /**
              * Whether by_placement was truncated. Sellers MUST return this flag whenever by_placement is present (false means the list is complete).
              */