@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Class AgentClient

    Index

    Constructors

    constructor

    Methods

    getAdcpVersion negotiateMediaBuyLifecycle fromMCPClient handleWebhook verifyAndParseWebhook createWebhookHandler verifyWebhookSignature getProducts listProducts requestProposals declineProposals buyProducts acceptProposal controlMediaBuy reportPlanAdjustment syncAgentNotificationConfigs refineProposals getProductsLegacy listCreativeFormatsLegacy listTransformersLegacy createMediaBuy createMediaBuyLegacy updateMediaBuy updateMediaBuyLegacy syncCreatives syncCreativesLegacy listCreatives listCreativesLegacy getMediaBuys getMediaBuyDelivery getCreativeDelivery providePerformanceFeedback getSignals activateSignal getAdcpCapabilities getCapabilities getIdempotencyReplayTtlSeconds requireSupportedMajor requireV3 previewCreative previewCreativeLegacy buildCreativeLegacy listAccounts syncAccounts syncAudiences createPropertyList getPropertyList updatePropertyList listPropertyLists deletePropertyList listContentStandardsLegacy getContentStandardsLegacy calibrateContentLegacy validateContentDeliveryLegacy siGetOffering siInitiateSession siSendMessage siTerminateSession continueConversation getHistory clearContext resetContext getContextId getPendingTaskId setContextId getAgent getAgentId getAgentName getProtocol getCanonicalUrl resolveCanonicalUrl isSameAgent isSameAgentResolved getResolvedAgent getAgentInfo hasActiveConversation getActiveTasks executeTask executeCustomTask executeTaskLegacy listTasks getTaskInfo onTaskUpdate onTaskEvents getWebhookUrl registerWebhook unregisterWebhook

    Constructors

    Methods

    • Create an AgentClient backed by a pre-connected MCP Client instead of an HTTP endpoint. Useful for in-process compliance testing without spinning up a loopback HTTP server.

      MCP only. This factory wraps an MCP Client from @modelcontextprotocol/sdk. There is no equivalent in-process bridge for A2A today — for A2A agents, run them on a loopback HTTP server and use the standard AgentClient constructor with the agent's agent_uri.

      What this gives you over dispatchTestRequest: All client-side pipeline stages still apply — idempotency key auto-injection, request/response schema validation hooks, governance middleware, and the typed TaskResult<T> discriminated-union response shape. None of these apply when calling dispatchTestRequest() directly.

      Usage:

      import { Client } from '@modelcontextprotocol/sdk/client/index.js';
      import { InMemoryTransport } from '@modelcontextprotocol/sdk/inMemory.js';
      import { AgentClient } from '@adcp/sdk';

      const [clientTransport, serverTransport] = InMemoryTransport.createLinkedPair();
      const mcpClient = new Client({ name: 'test', version: '1.0.0' });
      await Promise.all([
        mcpClient.connect(clientTransport),
        adcpServer.connect(serverTransport),
      ]);

      const agent = AgentClient.fromMCPClient(mcpClient, {
        validation: { requests: 'strict' },
      });
      const result = await agent.createMediaBuy({ ... });

      Unsupported methods on in-process instances: resolveCanonicalUrl, getWebhookUrl, registerWebhook, unregisterWebhook — these require HTTP and will throw Error with a descriptive message. Use getAgentId() / getAgentName() for identification instead.

      Parameters

      • mcpClient: Client

        An already-connected MCP Client (see example above).

      • config: InProcessAgentClientConfig = {}

        Optional narrowed config. HTTP-only fields are excluded.

      Returns AgentClient

    • Handle webhook from agent (async task completion or notifications)

      Parameters

      • payload: MCPWebhookPayload | Task | TaskStatusUpdateEvent

        Webhook payload from agent

      • taskType: string

        Task type (e.g create_media_buy) from url param or url part of the webhook delivery

      • operationId: string

        Operation id (e.g used for client app to track the operation) from the param or url part of the webhook delivery

      • Optionalsignature: WebhookHeaderValue

        Optional signature for verification (X-ADCP-Signature)

      • Optionaltimestamp: WebhookHeaderValue

        Optional timestamp for verification (X-ADCP-Timestamp)

      • OptionalrawBody: string | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>

      Returns Promise<boolean>

      Whether webhook was handled successfully

    • Create a trusted-route HTTP receiver for this specific agent.

      Parameters

      Returns (
          req: WebhookHandlerRequest,
          res: {
              status: (code: number) => { json: (body: unknown) => void };
              json?: unknown;
              writeHead: (code: number, headers: Record<string, string>) => void;
              end: (body: string) => void;
          },
      ) => Promise<void>

    • Verify webhook signature using HMAC-SHA256 per AdCP spec.

      Prefer passing the raw HTTP body string for correct cross-language interop. Passing a parsed object still works but re-serializes with JSON.stringify, which may not match the sender's byte representation.

      Parameters

      • rawBodyOrPayload: unknown

        Raw HTTP body string (preferred) or parsed payload object (deprecated)

      • signature: WebhookHeaderValue

        X-ADCP-Signature header value (format: "sha256=...")

      • timestamp: WebhookHeaderValue

        X-ADCP-Timestamp header value (Unix timestamp)

      Returns boolean

      true if signature is valid

    • Parameters

      Returns Promise<TaskResult<ListTransformersResponseCreativeAgent>>

      Migration-only access to legacy creative transformer declarations.

    • Create a new media buy.

      Discover canonical format_options[] with getProducts(), select a format_option_id, and send only canonical package and creative fields. Compatibility translation for an older seller happens below this method.

      const { data: { products } } = await agent.getProducts({ brief: '...' });
      const product = products[0];
      const format = product.format_options[0];

      await agent.createMediaBuy({
        packages: [{
          package_id: 'pkg-1',
          product_id: product.product_id,
          pricing_option_id: product.pricing_options[0].pricing_option_id,
          format_option_refs: [{
            scope: 'product',
            format_option_id: format.format_option_id
          }],
          creatives: [{
            creative_id: 'hero',
            format_kind: format.format_kind,
            format_option_ref: {
              scope: 'product',
              format_option_id: format.format_option_id
            },
            assets: { image: { url: 'https://cdn.example/hero.png' } }
          }],
          budget: { currency: 'USD', total: 5000 },
        }],
        // ...
      });

      Inline creative fallback. Sellers that do not advertise a creative library (supportsSyncCreatives(await agent.getCapabilities()) === false) can still accept package-scoped creative uploads when they advertise caps.features.inlineCreativeManagement. Use inlineCreativesForPackages(packages, creatives, { assignments }) to project sync_creatives-style creative assets into create-media-buy package payloads without rewriting a raw sync_creatives call. If using assignments for create payloads, give each package a stable key such as context.buyer_ref, or pass a custom packageId resolver.

      Existing applications that still hold old named-format payloads must opt into createMediaBuyLegacy() explicitly.

      Parameters

      Returns Promise<TaskResult<CanonicalCreativeResponse<LegacyCreateMediaBuyResponse>>>

    • Get media buy status, creative approvals, and optional delivery snapshots

      Parameters

      Returns Promise<
          TaskResult<
              {
                  context_id?: string;
                  context?: {};
                  task_id?: string;
                  status: TaskStatus;
                  message?: string;
                  timestamp?: string;
                  replayed?: boolean;
                  adcp_error?: {
                      code: string;
                      message: string;
                      field?: string;
                      suggestion?: string;
                      retry_after?: number;
                      issues?: {
                          pointer: string;
                          message: string;
                          keyword: string;
                          schemaPath?: string;
                          schema_id?: string;
                          discriminator?: { property_name: ...; value: ... }[];
                      }[];
                      details?: {};
                      recovery?: "transient"
                      | "correctable"
                      | "terminal";
                      source?: "producer" | "sdk";
                      sdk_id?: string;
                  };
                  push_notification_config?: {
                      url: string;
                      operation_id?: string;
                      token?: string;
                      authentication?: {
                          schemes: [AuthenticationScheme];
                          credentials: string;
                      };
                  };
                  governance_context?: string;
                  payload?: {};
                  adcp_version?: string;
                  adcp_major_version?: number;
                  media_buys: {
                      media_buy_id: string;
                      name?: string;
                      accepted_proposal_id?: string;
                      accepted_proposal_terms_digest?: string;
                      accepted_proposal?: {
                          proposal_id: string;
                          proposal_kind: | "new_media_buy"
                          | "media_buy_update"
                          | "media_buy_cancellation";
                          parent_proposal_id?: string;
                          media_buy_id: string;
                          opportunity_id?: string;
                          base_media_buy_revision?: number;
                          proposal_status: "accepted";
                          accepted_at?: string;
                          expires_at?: string;
                          name: string;
                          description?: string;
                          brief_alignment?: string;
                          commercial_terms: {
                              source_feed_version?: string;
                              source_pricing_version?: string;
                              brand: {
                                  domain: string;
                                  brand_id?: string;
                                  countries?: [(...), ...(...)[]];
                              };
                              advertiser_industry?: AdvertiserIndustry;
                              purchases: [
                                  {
                                      product_id: string;
                                      pricing_option_id: string;
                                      pricing?: (...)
                                      | (...);
                                      format_option_refs?: (...) | (...);
                                      catalog_ids?: (...) | (...);
                                      budget?: (...) | (...);
                                      daily_budget_cap?: (...) | (...);
                                      min_spend_target?: (...) | (...);
                                      impressions?: (...) | (...);
                                      start_time?: (...) | (...);
                                      end_time?: (...) | (...);
                                      pacing?: (...) | (...);
                                      bidding?: (...) | (...);
                                      targeting_overlay?: (...) | (...);
                                      optimization_goals?: (...) | (...);
                                      audience_evidence_requirements?: (...) | (...);
                                      audience_evidence_pins?: (...) | (...);
                                      agency_estimate_number?: (...) | (...);
                                      context?: (...) | (...);
                                      ext?: (...) | (...);
                                      measurement_terms?: (...) | (...);
                                      performance_standards?: (...) | (...);
                                  },
                                  ...{
                                      product_id: string;
                                      pricing_option_id: string;
                                      pricing?: (...)
                                      | (...);
                                      format_option_refs?: (...) | (...);
                                      catalog_ids?: (...) | (...);
                                      budget?: (...) | (...);
                                      daily_budget_cap?: (...) | (...);
                                      min_spend_target?: (...) | (...);
                                      impressions?: (...) | (...);
                                      start_time?: (...) | (...);
                                      end_time?: (...) | (...);
                                      pacing?: (...) | (...);
                                      bidding?: (...) | (...);
                                      targeting_overlay?: (...) | (...);
                                      optimization_goals?: (...) | (...);
                                      audience_evidence_requirements?: (...) | (...);
                                      audience_evidence_pins?: (...) | (...);
                                      agency_estimate_number?: (...) | (...);
                                      context?: (...) | (...);
                                      ext?: (...) | (...);
                                      measurement_terms?: (...) | (...);
                                      performance_standards?: (...) | (...);
                                  }[],
                              ];
                              start_time: string;
                              end_time: string;
                              total_budget?: { amount: number; currency: string };
                              daily_budget_cap?: number;
                              budget_cap_timezone?: string;
                              budget_allocation?:
                                  | { mode: "fixed" }
                                  | {
                                      mode: "seller_optimized";
                                      optimization_goals: [(...), ...(...)[]];
                                  };
                              pacing?: Pacing;
                              bidding?: {
                                  automatic?: (...)
                                  | (...);
                                  bid_amount?: (...) | (...);
                                  max_bid?: (...) | (...);
                                  cost_per?: (...) | (...);
                                  roas?: (...) | (...);
                              };
                              invoice_recipient?: {
                                  legal_name: string;
                                  vat_id?: (...)
                                  | (...);
                                  tax_id?: (...) | (...);
                                  registration_number?: (...) | (...);
                                  address?: (...) | (...);
                                  contacts?: (...) | (...);
                                  bank?: (...) | (...);
                                  ext?: (...) | (...);
                              };
                              purchase_order_ref?: string;
                              agency_estimate_number?: string;
                              reporting_commitments?: [
                                  { purchase_index: ...; metrics: ... },
                                  ...{ purchase_index: ...; metrics: ... }[],
                              ];
                              cancellation_terms?: {
                                  effective_at: string;
                                  fee?: (...) | (...);
                                  reason?: (...) | (...);
                              };
                          };
                          terms_digest: string;
                          insertion_order?: {
                              io_id: string;
                              terms?: {
                                  advertiser?: ...;
                                  publisher?: ...;
                                  total_budget?: ...;
                                  flight_start?: ...;
                                  flight_end?: ...;
                                  payment_terms?: ...;
                              };
                              terms_url?: string;
                              signing_url?: string;
                              requires_signature: boolean;
                          };
                      };
                      account?: {
                          account_id: string;
                          name: string;
                          advertiser?: string;
                          billing_proxy?: string;
                          status: AccountStatus;
                          brand?: {
                              domain: string;
                              brand_id?: string;
                              countries?: (...)[];
                              industries?: (...)[];
                              data_subject_contestation?: {
                                  url?: ...;
                                  email?: ...;
                                  languages?: ...;
                              };
                              brand_kit_override?: {
                                  logo?: ...;
                                  colors?: ...;
                                  voice?: ...;
                                  tagline?: ...;
                              };
                          };
                          operator?: string;
                          operator_unit?: { id: string; name?: string };
                          revision?: number;
                          identity_change?:
                              | {
                                  status: "pending_approval";
                                  requested_operator_identity: {
                                      operator: string;
                                      operator_unit?: (...)
                                      | (...);
                                  };
                                  requested_at?: string;
                              }
                              | {
                                  status: "rejected";
                                  requested_operator_identity: {
                                      operator: string;
                                      operator_unit?: (...)
                                      | (...);
                                  };
                                  requested_at?: string;
                                  reason: string;
                              };
                          currency?: string;
                          timezone?: string;
                          billing?: BillingParty;
                          billing_entity?: {
                              legal_name: string;
                              vat_id?: string;
                              tax_id?: string;
                              registration_number?: string;
                              address?: {
                                  street: ...;
                                  city: ...;
                                  postal_code: ...;
                                  region?: ...;
                                  country: ...;
                              };
                              contacts?: (...)[];
                              bank?: {
                                  account_holder: ...;
                                  iban?: ...;
                                  bic?: ...;
                                  routing_number?: ...;
                                  account_number?: ...;
                              };
                              ext?: { [key: ...]: ... };
                          };
                          destination_billing_entity?: {};
                          rate_card?: string;
                          payment_terms?: PaymentTerms;
                          credit_limit?: { amount: number; currency: string };
                          setup?: { url?: string; message: string; expires_at?: string };
                          account_scope?: AccountScope;
                          governance_agents?: [{ url: string }];
                          reporting_bucket?: {
                              protocol: CloudStorageProtocol;
                              bucket: string;
                              prefix?: string;
                              region?: string;
                              format?: "jsonl" | "csv" | "parquet" | "avro" | "orc";
                              compression?: "none" | "gzip";
                              file_retention_days: number;
                              setup_instructions?: string;
                          };
                          sandbox?: boolean;
                          notification_configs?: | []
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ]
                          | [
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                              {
                                  subscriber_id: string;
                                  url: string;
                                  event_types: [(...), ...(...)[]];
                                  product_payload_view?: (...) | (...) | (...);
                                  authentication?: (...) | (...);
                                  active?: (...) | (...) | (...);
                                  ext?: (...) | (...);
                              },
                          ];
                          webhook_activity?: {
                              idempotency_key: string;
                              notification_id?: (...)
                              | (...);
                              subscriber_id?: (...) | (...);
                              fired_at: string;
                              completed_at?: (...) | (...) | (...);
                              notification_type: NotificationType;
                              sequence_number?: (...) | (...);
                              attempt: number;
                              status: (...) | (...) | (...) | (...) | (...);
                              url: string;
                              http_status_code?: (...) | (...) | (...);
                              response_time_ms?: (...) | (...) | (...);
                              payload_size_bytes?: (...) | (...);
                              error_message?: (...) | (...) | (...);
                              ext?: (...) | (...);
                          }[];
                          ext?: { [key: string]: unknown };
                      };
                      invoice_recipient?: {
                          legal_name: string;
                          vat_id?: string;
                          tax_id?: string;
                          registration_number?: string;
                          address?: {
                              street: string;
                              city: string;
                              postal_code: string;
                              region?: string;
                              country: string;
                          };
                          contacts?: {
                              role: (...)
                              | (...)
                              | (...)
                              | (...);
                              name?: (...) | (...);
                              email?: (...) | (...);
                              phone?: (...) | (...);
                          }[];
                          bank?: {
                              account_holder: string;
                              iban?: string;
                              bic?: string;
                              routing_number?: string;
                              account_number?: string;
                          };
                          ext?: { [key: string]: unknown };
                      };
                      status: MediaBuyStatus;
                      status_as_of?: string
                      | null;
                      health?: "ok" | "impaired";
                      impairments?: {
                          impairment_id: string;
                          resource_type:
                              | "creative"
                              | "property"
                              | "audience"
                              | "catalog_item"
                              | "event_source";
                          resource_id: string;
                          package_ids: [string, ...string[]];
                          transition: { from?: string; to: ImpairmentOfflineState };
                          reason_code: ImpairmentReasonCode;
                          reason?: string;
                          observed_at: string;
                          remediation?: string;
                      }[];
                      rejection_reason?: string;
                      currency: string;
                      total_budget?: number;
                      daily_budget_cap?: number;
                      budget_cap_timezone?: string;
                      budget_allocation?: | { mode: "fixed" }
                      | {
                          mode: "seller_optimized";
                          optimization_goals: [
                              | {
                                  kind: "metric";
                                  metric: | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...)
                                  | (...);
                                  reach_unit?: (...) | (...);
                                  target_frequency?: (...) | (...);
                                  view_duration_seconds?: (...) | (...);
                                  target?: (...) | (...) | (...);
                                  priority?: (...) | (...);
                              }
                              | {
                                  kind: "event";
                                  event_sources: [(...), ...(...)[]];
                                  target?: (...) | (...) | (...) | (...);
                                  attribution_window?: (...) | (...);
                                  priority?: (...) | (...);
                              }
                              | {
                                  kind: "vendor_metric";
                                  vendor: {
                                      domain: ...;
                                      brand_id?: ...;
                                      countries?: ...;
                                      industries?: ...;
                                      data_subject_contestation?: ...;
                                      brand_kit_override?: ...;
                                  };
                                  metric_id: string;
                                  target?: (...)
                                  | (...)
                                  | (...);
                                  priority?: (...) | (...);
                              },
                              ...(
                                  | {
                                      kind: "metric";
                                      metric: | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                                      reach_unit?: (...) | (...);
                                      target_frequency?: (...) | (...);
                                      view_duration_seconds?: (...) | (...);
                                      target?: (...) | (...) | (...);
                                      priority?: (...) | (...);
                                  }
                                  | {
                                      kind: "event";
                                      event_sources: [(...), ...(...)[]];
                                      target?: (...) | (...) | (...) | (...);
                                      attribution_window?: (...) | (...);
                                      priority?: (...) | (...);
                                  }
                                  | {
                                      kind: "vendor_metric";
                                      vendor: {
                                          domain: ...;
                                          brand_id?: ...;
                                          countries?: ...;
                                          industries?: ...;
                                          data_subject_contestation?: ...;
                                          brand_kit_override?: ...;
                                      };
                                      metric_id: string;
                                      target?: (...)
                                      | (...)
                                      | (...);
                                      priority?: (...) | (...);
                                  }
                              )[],
                          ];
                      };
                      pacing?: Pacing;
                      bidding?: {
                          automatic?: true;
                          bid_amount?: number;
                          max_bid?: number;
                          cost_per?: { amount: number; strength: "cap"
                          | "target" };
                          roas?: { value: number; strength: "target" | "floor" };
                      };
                      start_time?: string;
                      end_time?: string;
                      creative_deadline?: string;
                      confirmed_at?: string
                      | null;
                      cancellation?: {
                          canceled_at: string;
                          canceled_by: CanceledBy;
                          reason?: string;
                      };
                      revision?: number;
                      created_at?: string;
                      updated_at?: string;
                      context?: {};
                      valid_actions?: MediaBuyValidAction[];
                      available_actions?: (
                          | {
                              action: MediaBuyValidAction;
                              mode: MediaBuyActionMode;
                              task?: "sync_creatives"
                              | "control_media_buy"
                              | "refine_proposals";
                              sla?: { response_max?: ...; completion_max?: ... };
                              terms_ref?: string;
                          }
                          | {
                              task: "control_media_buy";
                              action: | "pause"
                              | "resume"
                              | "cancel"
                              | "increase_budget"
                              | "decrease_budget"
                              | "reallocate_budget"
                              | "update_budget_allocation"
                              | "update_targeting"
                              | "update_pacing"
                              | "update_bidding"
                              | "update_frequency_caps"
                              | "update_catalog_assignments"
                              | "update_keywords"
                              | "update_optimization_goals"
                              | "update_impression_goal"
                              | "update_spend_target"
                              | "update_reporting_webhook"
                              | "remove_packages"
                              | "update_name";
                              mode: CanonicalMediaBuyActionMode;
                              sla?: { response_max?: ...; completion_max?: ... };
                              terms_ref?: string;
                          }
                          | {
                              task: "refine_proposals";
                              action: | "cancel"
                              | "extend_flight"
                              | "shorten_flight"
                              | "update_flight_dates"
                              | "increase_budget"
                              | "decrease_budget"
                              | "reallocate_budget"
                              | "update_budget_allocation"
                              | "update_targeting"
                              | "update_pacing"
                              | "update_bidding"
                              | "update_frequency_caps"
                              | "add_packages"
                              | "remove_packages";
                              mode: CanonicalMediaBuyActionMode;
                              sla?: { response_max?: ...; completion_max?: ... };
                              terms_ref?: string;
                          }
                          | {
                              task: "sync_creatives";
                              action: | "replace_creative"
                              | "update_creative_assignments"
                              | "remove_creative";
                              mode: CanonicalMediaBuyActionMode;
                              sla?: { response_max?: ...; completion_max?: ... };
                              terms_ref?: string;
                          }
                      )[];
                      webhook_activity?: {
                          idempotency_key: string;
                          notification_id?: string;
                          subscriber_id?: string;
                          fired_at: string;
                          completed_at?: string
                          | null;
                          notification_type: NotificationType;
                          sequence_number?: number;
                          attempt: number;
                          status:
                              | "failed"
                              | "pending"
                              | "success"
                              | "timeout"
                              | "connection_error";
                          url: string;
                          http_status_code?: number
                          | null;
                          response_time_ms?: number | null;
                          payload_size_bytes?: number;
                          error_message?: string | null;
                          ext?: { [key: string]: unknown };
                      }[];
                      history?: {
                          revision: number;
                          timestamp: string;
                          actor?: string;
                          action: string;
                          summary?: string;
                          package_id?: string;
                          ext?: { [key: string]: unknown };
                      }[];
                      packages: {
                          package_id: string;
                          product_id?: string;
                          budget?: number;
                          min_spend_target?: number;
                          daily_budget_cap?: number;
                          currency?: string;
                          bid_price?: number;
                          bidding?: {
                              automatic?: true;
                              bid_amount?: number;
                              max_bid?: number;
                              cost_per?: { amount: ...; strength: ... };
                              roas?: { value: ...; strength: ... };
                          };
                          optimization_goals?: (
                              | {
                                  kind: ...;
                                  metric: ...;
                                  reach_unit?: ...;
                                  target_frequency?: ...;
                                  view_duration_seconds?: ...;
                                  target?: ...;
                                  priority?: ...;
                              }
                              | {
                                  kind: ...;
                                  event_sources: ...;
                                  target?: ...;
                                  attribution_window?: ...;
                                  priority?: ...;
                              }
                              | {
                                  kind: ...;
                                  vendor: ...;
                                  metric_id: ...;
                                  target?: ...;
                                  priority?: ...;
                              }
                          )[];
                          format_option_refs?: (
                              | { scope: ...; publisher_domain: ...; format_option_id: ... }
                              | { scope: ...; format_option_id: ...; publisher_domain?: ... }
                          )[];
                          format_kind?: CanonicalFormatKind;
                          params?: {};
                          impressions?: number;
                          pacing?: Pacing;
                          targeting_overlay?: {
                              geo_countries?: [(...), ...(...)[]];
                              geo_countries_exclude?: [(...), ...(...)[]];
                              geo_regions?: [(...), ...(...)[]];
                              geo_regions_exclude?: [(...), ...(...)[]];
                              geo_metros?: [(...), ...(...)[]];
                              geo_metros_exclude?: [(...), ...(...)[]];
                              geo_postal_areas?: [(...), ...(...)[]];
                              geo_postal_areas_exclude?: [(...), ...(...)[]];
                              geo_places?: [(...), ...(...)[]];
                              geo_places_exclude?: [(...), ...(...)[]];
                              daypart_targets?: [(...), ...(...)[]];
                              axe_include_segment?: string;
                              axe_exclude_segment?: string;
                              audience_include?: [(...), ...(...)[]];
                              audience_exclude?: [(...), ...(...)[]];
                              signal_targeting_groups?: { operator: ...; groups: ... };
                              signal_targeting?: [(...), ...(...)[]];
                              demographics?: { age: ... };
                              frequency_cap?: {
                                  suppress?: ...;
                                  suppress_minutes?: ...;
                                  max_impressions?: ...;
                                  per?: ...;
                                  window?: ...;
                              };
                              property_list?: { agent_url: ...; list_id: ...; auth_token?: ... };
                              property_list_exclude?: {
                                  agent_url: ...;
                                  list_id: ...;
                                  auth_token?: ...;
                              };
                              collection_list?: { agent_url: ...; list_id: ...; auth_token?: ... };
                              collection_list_exclude?: {
                                  agent_url: ...;
                                  list_id: ...;
                                  auth_token?: ...;
                              };
                              placement_selection?: | { mode: ...; placement_refs: ...; ext?: ... }
                              | { mode: ...; ext?: ... };
                              age_restriction?: {
                                  min: ...;
                                  verification_required?: ...;
                                  accepted_methods?: ...;
                              };
                              device_platform?: [(...), ...(...)[]];
                              device_platform_exclude?: [(...), ...(...)[]];
                              device_type?: [(...), ...(...)[]];
                              device_type_exclude?: [(...), ...(...)[]];
                              browser?: [(...), ...(...)[]];
                              browser_exclude?: [(...), ...(...)[]];
                              store_catchments?: [(...), ...(...)[]];
                              geo_proximity?: [(...), ...(...)[]];
                              language?: [(...), ...(...)[]];
                              keyword_targets?: [(...), ...(...)[]];
                              negative_keywords?: [(...), ...(...)[]];
                          };
                          targeting_resolution?: {
                              demographics: {
                                  requested: { age: ... };
                                  applied: { age: ... };
                                  equivalent: true;
                                  execution: (...) | (...) | (...);
                                  applied_bases?: (...) | (...);
                                  applied_verification_methods?: (...) | (...);
                                  ext?: (...) | (...);
                              };
                              ext?: { [key: ...]: ... };
                          };
                          start_time?: string;
                          end_time?: string;
                          paused?: boolean;
                          canceled?: boolean;
                          cancellation?: {
                              canceled_at: string;
                              canceled_by: CanceledBy;
                              reason?: string;
                          };
                          creative_deadline?: string;
                          context?: {};
                          creative_approvals?: {
                              creative_id: string;
                              approval_status?: (...)
                              | (...);
                              rejection_reason?: (...) | (...);
                              approval_scopes?: (...) | (...);
                              indicators?: (...) | (...);
                              indicator_types_evaluated?: (...) | (...);
                              indicators_as_of?: (...) | (...);
                              indicators_evaluated_scope?: (...) | (...);
                          }[];
                          formats_to_provide?: (
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                          )[];
                          formats_pending?: (
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                              | {
                                  format_option_id?: ...;
                                  publisher_domain?: ...;
                                  display_name?: ...;
                                  sample_render_url?: ...;
                                  applies_to_channels?: ...;
                                  seller_preference?: ...;
                                  locale_policy?: ...;
                                  canonical_formats_only?: ...;
                                  experimental?: ...;
                                  format_shape?: ...;
                                  format_schema?: ...;
                                  format_kind: ...;
                                  params: ...;
                              }
                          )[];
                          snapshot_unavailable_reason?: SnapshotUnavailableReason;
                          snapshot?: {
                              as_of: string;
                              staleness_seconds: number;
                              impressions: number;
                              spend: number;
                              currency?: string;
                              clicks?: number;
                              pacing_index?: number;
                              delivery_status?: DeliveryStatus;
                              ext?: { [key: ...]: ... };
                          };
                          ext?: { [key: string]: unknown };
                          indicator_types_evaluated?: (
                              | "creative_diversity_low"
                              | "audience_saturation"
                              | "inventory_shortfall_forecast"
                              | "pacing_risk"
                              | "budget_constrained"
                          )[];
                          indicators?: { type?: (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...) }[];
                      }[];
                      ext?: { [key: string]: unknown };
                      indicator_types_evaluated?: "budget_constrained"[];
                      indicators?: { type?: "budget_constrained" }[];
                  }[];
                  errors?: {
                      code: string;
                      message: string;
                      field?: string;
                      suggestion?: string;
                      retry_after?: number;
                      issues?: {
                          pointer: string;
                          message: string;
                          keyword: string;
                          schemaPath?: string;
                          schema_id?: string;
                          discriminator?: (...)[];
                      }[];
                      details?: {};
                      recovery?: "transient"
                      | "correctable"
                      | "terminal";
                      source?: "producer" | "sdk";
                      sdk_id?: string;
                  }[];
                  pagination?: { has_more: boolean; cursor?: string; total_count?: number };
                  sandbox?: boolean;
                  ext?: { [key: string]: unknown };
              },
          >,
      >

    • Get media buy delivery information

      Parameters

      Returns Promise<
          TaskResult<
              {
                  context_id?: string;
                  context?: {};
                  task_id?: string;
                  status: TaskStatus;
                  message?: string;
                  timestamp?: string;
                  replayed?: boolean;
                  adcp_error?: {
                      code: string;
                      message: string;
                      field?: string;
                      suggestion?: string;
                      retry_after?: number;
                      issues?: {
                          pointer: string;
                          message: string;
                          keyword: string;
                          schemaPath?: string;
                          schema_id?: string;
                          discriminator?: { property_name: ...; value: ... }[];
                      }[];
                      details?: {};
                      recovery?: "transient"
                      | "correctable"
                      | "terminal";
                      source?: "producer" | "sdk";
                      sdk_id?: string;
                  };
                  push_notification_config?: {
                      url: string;
                      operation_id?: string;
                      token?: string;
                      authentication?: {
                          schemes: [AuthenticationScheme];
                          credentials: string;
                      };
                  };
                  governance_context?: string;
                  payload?: {};
                  adcp_version?: string;
                  adcp_major_version?: number;
                  notification_type?: | "scheduled"
                  | "final"
                  | "delayed"
                  | "adjusted"
                  | "window_update";
                  partial_data?: boolean;
                  unavailable_count?: number;
                  sequence_number?: number;
                  next_expected_at?: string;
                  reporting_period: { start: string; end: string };
                  currency?: string;
                  attribution_window?: {
                      post_click?: {
                          interval: number;
                          unit: "campaign" | "seconds" | "minutes" | "hours" | "days";
                      };
                      post_view?: {
                          interval: number;
                          unit: "campaign"
                          | "seconds"
                          | "minutes"
                          | "hours"
                          | "days";
                      };
                      model?: AttributionModel;
                  };
                  aggregated_totals?: {
                      impressions: number;
                      spend: number;
                      clicks?: number;
                      completed_views?: number;
                      views?: number;
                      conversions?: number;
                      conversion_value?: number;
                      commissionable_value?: number;
                      roas?: number;
                      new_to_brand_rate?: number;
                      cost_per_acquisition?: number;
                      completion_rate?: number
                      | null;
                      reach?: number;
                      reach_unit?: ReachUnit;
                      frequency?: number;
                      media_buy_count: number;
                      metric_aggregates?: (
                          | {
                              scope: "standard";
                              metric_id: AvailableMetric;
                              qualifier?: {
                                  viewability_standard?: ...;
                                  completion_source?: ...;
                                  attribution_methodology?: ...;
                                  attribution_window?: ...;
                                  lift_dimension?: ...;
                              };
                              value: number;
                              measurable_impressions?: number;
                              viewable_impressions?: number;
                              impressions?: number;
                              completed_views?: number;
                              spend?: number;
                              conversions?: number;
                              conversion_value?: number;
                              clicks?: number;
                          }
                          | {
                              scope: "vendor";
                              vendor: {
                                  domain: string;
                                  brand_id?: (...)
                                  | (...);
                                  countries?: (...) | (...);
                                  industries?: (...) | (...);
                                  data_subject_contestation?: (...) | (...);
                                  brand_kit_override?: (...) | (...);
                              };
                              metric_id: string;
                              qualifier?: {};
                              value: number;
                              measurable_impressions?: number;
                          }
                      )[];
                  };
                  media_buy_deliveries: {
                      media_buy_id: string;
                      status: | "active"
                      | "rejected"
                      | "failed"
                      | "pending"
                      | "completed"
                      | "pending_creatives"
                      | "pending_start"
                      | "paused"
                      | "canceled"
                      | "reporting_delayed";
                      expected_availability?: string;
                      is_adjusted?: boolean;
                      is_final?: boolean;
                      finalized_at?: string;
                      pricing_model?: PricingModel;
                      pacing_index?: number;
                      totals: {
                          impressions?: number;
                          spend?: number;
                          clicks?: number;
                          ctr?: number;
                          views?: number;
                          completed_views?: number;
                          completion_rate?: number
                          | null;
                          conversions?: number;
                          conversion_value?: number;
                          commissionable_value?: number;
                          roas?: number;
                          cost_per_acquisition?: number;
                          new_to_brand_rate?: number;
                          leads?: number;
                          incremental_sales_lift?: number;
                          brand_lift?: number;
                          foot_traffic?: number;
                          conversion_lift?: number;
                          brand_search_lift?: number;
                          plays?: number;
                          by_event_type?: {
                              event_type: EventType;
                              event_source_id?: string;
                              count: number;
                              value?: number;
                          }[];
                          grps?: number;
                          reach?: number;
                          reach_unit?: ReachUnit;
                          reach_window?: {
                              kind: "cumulative"
                              | "period"
                              | "rolling";
                              period?: {
                                  interval: number;
                                  unit: (...) | (...) | (...) | (...) | (...);
                              };
                          };
                          frequency?: number;
                          quartile_data?: | {
                              q1_views?: number;
                              q2_views?: number;
                              q3_views?: number;
                              q4_views?: number;
                          }
                          | null;
                          dooh_metrics?: {
                              loop_plays?: number;
                              screens_used?: number;
                              screen_time_seconds?: number;
                              sov_achieved?: number;
                              calculation_notes?: string;
                              venue_breakdown?: {
                                  venue_id: ...;
                                  venue_name?: ...;
                                  venue_type?: ...;
                                  impressions: ...;
                                  loop_plays?: ...;
                                  screens_used?: ...;
                              }[];
                          };
                          viewability?: {
                              vendor?: {
                                  domain: string;
                                  brand_id?: (...)
                                  | (...);
                                  countries?: (...) | (...);
                                  industries?: (...) | (...);
                                  data_subject_contestation?: (...) | (...);
                                  brand_kit_override?: (...) | (...);
                              };
                              measurable_impressions?: number;
                              viewable_impressions?: number;
                              viewable_rate?: number;
                              viewed_seconds?: number;
                              standard?: ViewabilityStandard;
                          };
                          engagements?: number;
                          follows?: number;
                          saves?: number;
                          profile_visits?: number;
                          engagement_rate?: number;
                          cost_per_click?: number;
                          cost_per_completed_view?: number;
                          cpm?: number;
                          downloads?: number;
                          units_sold?: number;
                          new_to_brand_units?: number;
                          by_action_source?: {
                              action_source: ActionSource;
                              event_source_id?: string;
                              count: number;
                              value?: number;
                          }[];
                          vendor_metric_values?: {
                              vendor: {
                                  domain: string;
                                  brand_id?: (...)
                                  | (...);
                                  countries?: (...) | (...);
                                  industries?: (...) | (...);
                                  data_subject_contestation?: (...) | (...);
                                  brand_kit_override?: (...) | (...);
                              };
                              metric_id: string;
                              value: number;
                              unit?: string;
                              measurable_impressions?: number;
                              breakdown?: {};
                          }[];
                          effective_rate?: number;
                      };
                      by_package: {
                          impressions?: number;
                          spend?: number;
                          clicks?: number;
                          ctr?: number;
                          views?: number;
                          completed_views?: number;
                          completion_rate?: number
                          | null;
                          conversions?: number;
                          conversion_value?: number;
                          commissionable_value?: number;
                          roas?: number;
                          cost_per_acquisition?: number;
                          new_to_brand_rate?: number;
                          leads?: number;
                          incremental_sales_lift?: number;
                          brand_lift?: number;
                          foot_traffic?: number;
                          conversion_lift?: number;
                          brand_search_lift?: number;
                          plays?: number;
                          by_event_type?: {
                              event_type: EventType;
                              event_source_id?: (...) | (...);
                              count: number;
                              value?: (...) | (...);
                          }[];
                          grps?: number;
                          reach?: number;
                          reach_unit?: ReachUnit;
                          reach_window?: {
                              kind: "cumulative"
                              | "period"
                              | "rolling";
                              period?: { interval: ...; unit: ... };
                          };
                          frequency?: number;
                          quartile_data?: | {
                              q1_views?: number;
                              q2_views?: number;
                              q3_views?: number;
                              q4_views?: number;
                          }
                          | null;
                          dooh_metrics?: {
                              loop_plays?: number;
                              screens_used?: number;
                              screen_time_seconds?: number;
                              sov_achieved?: number;
                              calculation_notes?: string;
                              venue_breakdown?: (...)[];
                          };
                          viewability?: {
                              vendor?: {
                                  domain: ...;
                                  brand_id?: ...;
                                  countries?: ...;
                                  industries?: ...;
                                  data_subject_contestation?: ...;
                                  brand_kit_override?: ...;
                              };
                              measurable_impressions?: number;
                              viewable_impressions?: number;
                              viewable_rate?: number;
                              viewed_seconds?: number;
                              standard?: ViewabilityStandard;
                          };
                          engagements?: number;
                          follows?: number;
                          saves?: number;
                          profile_visits?: number;
                          engagement_rate?: number;
                          cost_per_click?: number;
                          cost_per_completed_view?: number;
                          cpm?: number;
                          downloads?: number;
                          units_sold?: number;
                          new_to_brand_units?: number;
                          by_action_source?: {
                              action_source: ActionSource;
                              event_source_id?: (...)
                              | (...);
                              count: number;
                              value?: (...) | (...);
                          }[];
                          vendor_metric_values?: {
                              vendor: {
                                  domain: ...;
                                  brand_id?: ...;
                                  countries?: ...;
                                  industries?: ...;
                                  data_subject_contestation?: ...;
                                  brand_kit_override?: ...;
                              };
                              metric_id: string;
                              value: number;
                              unit?: (...)
                              | (...);
                              measurable_impressions?: (...) | (...);
                              breakdown?: (...) | (...);
                          }[];
                          package_id: string;
                          pacing_index?: number;
                          pricing_model?: PricingModel;
                          rate?: number;
                          currency?: string;
                          delivery_status?: DeliveryStatus;
                          paused?: boolean;
                          is_final?: boolean;
                          finalized_at?: string;
                          measurement_window?: string;
                          supersedes_window?: string;
                          missing_metrics?: (
                              | { scope: ...; metric_id: ...; qualifier?: ... }
                              | { scope: ...; vendor: ...; metric_id: ... }
                          )[];
                          by_catalog_item?: {
                              impressions?: (...) | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              content_id?: (...) | (...);
                              content_id_type?: (...) | (...);
                          }[];
                          by_creative?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              creative_id: string;
                              weight?: (...) | (...);
                          }[];
                          by_keyword?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              keyword?: (...) | (...);
                              match_type?: (...) | (...);
                          }[];
                          by_geo?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              geo_level?: (...) | (...);
                              system?: (...) | (...);
                              country?: (...) | (...);
                              geo_code?: (...) | (...);
                              geo_name?: (...) | (...);
                          }[];
                          by_geo_truncated?: boolean;
                          by_device_type?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              device_type?: (...) | (...);
                          }[];
                          by_device_type_truncated?: boolean;
                          by_device_platform?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              device_platform?: (...) | (...);
                          }[];
                          by_device_platform_truncated?: boolean;
                          by_audience?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              audience_id?: (...) | (...);
                              audience_source?: (...) | (...);
                              audience_name?: (...) | (...);
                          }[];
                          by_audience_truncated?: boolean;
                          by_demographic?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              demographic: string;
                              demographic_system: DemographicSystem;
                              age?: (...) | (...);
                          }[];
                          by_demographic_truncated?: boolean;
                          by_demographic_suppressed?: boolean;
                          by_placement?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              placement_id?: (...) | (...);
                              placement_name?: (...) | (...);
                              publisher_domain?: (...) | (...);
                          }[];
                          by_placement_truncated?: boolean;
                          by_spot?: {
                              impressions?: (...)
                              | (...);
                              spend?: (...) | (...);
                              clicks?: (...) | (...);
                              ctr?: (...) | (...);
                              views?: (...) | (...);
                              completed_views?: (...) | (...);
                              completion_rate?: (...) | (...) | (...);
                              conversions?: (...) | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              cost_per_acquisition?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                              leads?: (...) | (...);
                              incremental_sales_lift?: (...) | (...);
                              brand_lift?: (...) | (...);
                              foot_traffic?: (...) | (...);
                              conversion_lift?: (...) | (...);
                              brand_search_lift?: (...) | (...);
                              plays?: (...) | (...);
                              by_event_type?: (...) | (...);
                              grps?: (...) | (...);
                              reach?: (...) | (...);
                              reach_unit?: (...) | (...);
                              reach_window?: (...) | (...);
                              frequency?: (...) | (...);
                              quartile_data?: (...) | (...) | (...);
                              dooh_metrics?: (...) | (...);
                              viewability?: (...) | (...);
                              engagements?: (...) | (...);
                              follows?: (...) | (...);
                              saves?: (...) | (...);
                              profile_visits?: (...) | (...);
                              engagement_rate?: (...) | (...);
                              cost_per_click?: (...) | (...);
                              cost_per_completed_view?: (...) | (...);
                              cpm?: (...) | (...);
                              downloads?: (...) | (...);
                              units_sold?: (...) | (...);
                              new_to_brand_units?: (...) | (...);
                              by_action_source?: (...) | (...);
                              vendor_metric_values?: (...) | (...);
                              spot_id: string;
                              aired_at: string;
                              network?: (...) | (...);
                              station?: (...) | (...);
                              daypart?: (...) | (...);
                          }[];
                          by_spot_truncated?: boolean;
                          daily_breakdown?: {
                              date: string;
                              impressions: number;
                              spend: number;
                              conversions?: (...)
                              | (...);
                              conversion_value?: (...) | (...);
                              commissionable_value?: (...) | (...);
                              roas?: (...) | (...);
                              new_to_brand_rate?: (...) | (...);
                          }[];
                      }[];
                      windows?: {
                          window_start: string;
                          window_end: string;
                          totals: {
                              impressions?: number;
                              spend?: number;
                              clicks?: number;
                              ctr?: number;
                              views?: number;
                              completed_views?: number;
                              completion_rate?: number
                              | null;
                              conversions?: number;
                              conversion_value?: number;
                              commissionable_value?: number;
                              roas?: number;
                              cost_per_acquisition?: number;
                              new_to_brand_rate?: number;
                              leads?: number;
                              incremental_sales_lift?: number;
                              brand_lift?: number;
                              foot_traffic?: number;
                              conversion_lift?: number;
                              brand_search_lift?: number;
                              plays?: number;
                              by_event_type?: (...)[];
                              grps?: number;
                              reach?: number;
                              reach_unit?: ReachUnit;
                              reach_window?: { kind: ...; period?: ... };
                              frequency?: number;
                              quartile_data?:
                                  | {
                                      q1_views?: ...;
                                      q2_views?: ...;
                                      q3_views?: ...;
                                      q4_views?: ...;
                                  }
                                  | null;
                              dooh_metrics?: {
                                  loop_plays?: ...;
                                  screens_used?: ...;
                                  screen_time_seconds?: ...;
                                  sov_achieved?: ...;
                                  calculation_notes?: ...;
                                  venue_breakdown?: ...;
                              };
                              viewability?: {
                                  vendor?: ...;
                                  measurable_impressions?: ...;
                                  viewable_impressions?: ...;
                                  viewable_rate?: ...;
                                  viewed_seconds?: ...;
                                  standard?: ...;
                              };
                              engagements?: number;
                              follows?: number;
                              saves?: number;
                              profile_visits?: number;
                              engagement_rate?: number;
                              cost_per_click?: number;
                              cost_per_completed_view?: number;
                              cpm?: number;
                              downloads?: number;
                              units_sold?: number;
                              new_to_brand_units?: number;
                              by_action_source?: (...)[];
                              vendor_metric_values?: (...)[];
                          };
                          by_package?: {
                              impressions?: ...;
                              spend?: ...;
                              clicks?: ...;
                              ctr?: ...;
                              views?: ...;
                              completed_views?: ...;
                              completion_rate?: ...;
                              conversions?: ...;
                              conversion_value?: ...;
                              commissionable_value?: ...;
                              roas?: ...;
                              cost_per_acquisition?: ...;
                              new_to_brand_rate?: ...;
                              leads?: ...;
                              incremental_sales_lift?: ...;
                              brand_lift?: ...;
                              foot_traffic?: ...;
                              conversion_lift?: ...;
                              brand_search_lift?: ...;
                              plays?: ...;
                              by_event_type?: ...;
                              grps?: ...;
                              reach?: ...;
                              reach_unit?: ...;
                              reach_window?: ...;
                              frequency?: ...;
                              quartile_data?: ...;
                              dooh_metrics?: ...;
                              viewability?: ...;
                              engagements?: ...;
                              follows?: ...;
                              saves?: ...;
                              profile_visits?: ...;
                              engagement_rate?: ...;
                              cost_per_click?: ...;
                              cost_per_completed_view?: ...;
                              cpm?: ...;
                              downloads?: ...;
                              units_sold?: ...;
                              new_to_brand_units?: ...;
                              by_action_source?: ...;
                              vendor_metric_values?: ...;
                              package_id: ...;
                          }[];
                          is_final?: boolean;
                          measurement_window?: string;
                      }[];
                      daily_breakdown?: {
                          date: string;
                          impressions: number;
                          spend: number;
                          conversions?: number;
                          conversion_value?: number;
                          commissionable_value?: number;
                          roas?: number;
                          new_to_brand_rate?: number;
                      }[];
                  }[];
                  errors?: {
                      code: string;
                      message: string;
                      field?: string;
                      suggestion?: string;
                      retry_after?: number;
                      issues?: {
                          pointer: string;
                          message: string;
                          keyword: string;
                          schemaPath?: string;
                          schema_id?: string;
                          discriminator?: (...)[];
                      }[];
                      details?: {};
                      recovery?: "transient"
                      | "correctable"
                      | "terminal";
                      source?: "producer" | "sdk";
                      sdk_id?: string;
                  }[];
                  sandbox?: boolean;
                  ext?: { [key: string]: unknown };
              },
          >,
      >

    • Retrieve canonical creative-level and variant-level delivery metrics.

      Parameters

      Returns Promise<
          TaskResult<
              {
                  context_id?: string;
                  context?: {};
                  task_id?: string;
                  status: TaskStatus;
                  message?: string;
                  timestamp?: string;
                  replayed?: boolean;
                  adcp_error?: {
                      code: string;
                      message: string;
                      field?: string;
                      suggestion?: string;
                      retry_after?: number;
                      issues?: {
                          pointer: string;
                          message: string;
                          keyword: string;
                          schemaPath?: string;
                          schema_id?: string;
                          discriminator?: { property_name: ...; value: ... }[];
                      }[];
                      details?: {};
                      recovery?: "transient"
                      | "correctable"
                      | "terminal";
                      source?: "producer" | "sdk";
                      sdk_id?: string;
                  };
                  push_notification_config?: {
                      url: string;
                      operation_id?: string;
                      token?: string;
                      authentication?: {
                          schemes: [AuthenticationScheme];
                          credentials: string;
                      };
                  };
                  governance_context?: string;
                  payload?: {};
                  adcp_version?: string;
                  adcp_major_version?: number;
                  account_id?: string;
                  media_buy_id?: string;
                  currency: string;
                  reporting_period: { start: string; end: string; timezone?: string };
                  creatives: {
                      creative_id: string;
                      media_buy_id?: string;
                      format_kind?: CanonicalFormatKind;
                      format_option_ref?:
                          | {
                              scope: "publisher";
                              publisher_domain: string;
                              format_option_id: string;
                          }
                          | {
                              scope: "product";
                              format_option_id: string;
                              publisher_domain?: undefined;
                          };
                      totals?: {
                          impressions?: number;
                          spend?: number;
                          clicks?: number;
                          ctr?: number;
                          views?: number;
                          completed_views?: number;
                          completion_rate?: number
                          | null;
                          conversions?: number;
                          conversion_value?: number;
                          commissionable_value?: number;
                          roas?: number;
                          cost_per_acquisition?: number;
                          new_to_brand_rate?: number;
                          leads?: number;
                          incremental_sales_lift?: number;
                          brand_lift?: number;
                          foot_traffic?: number;
                          conversion_lift?: number;
                          brand_search_lift?: number;
                          plays?: number;
                          by_event_type?: {
                              event_type: EventType;
                              event_source_id?: (...) | (...);
                              count: number;
                              value?: (...) | (...);
                          }[];
                          grps?: number;
                          reach?: number;
                          reach_unit?: ReachUnit;
                          reach_window?: {
                              kind: "cumulative"
                              | "period"
                              | "rolling";
                              period?: { interval: ...; unit: ... };
                          };
                          frequency?: number;
                          quartile_data?: | {
                              q1_views?: number;
                              q2_views?: number;
                              q3_views?: number;
                              q4_views?: number;
                          }
                          | null;
                          dooh_metrics?: {
                              loop_plays?: number;
                              screens_used?: number;
                              screen_time_seconds?: number;
                              sov_achieved?: number;
                              calculation_notes?: string;
                              venue_breakdown?: (...)[];
                          };
                          viewability?: {
                              vendor?: {
                                  domain: ...;
                                  brand_id?: ...;
                                  countries?: ...;
                                  industries?: ...;
                                  data_subject_contestation?: ...;
                                  brand_kit_override?: ...;
                              };
                              measurable_impressions?: number;
                              viewable_impressions?: number;
                              viewable_rate?: number;
                              viewed_seconds?: number;
                              standard?: ViewabilityStandard;
                          };
                          engagements?: number;
                          follows?: number;
                          saves?: number;
                          profile_visits?: number;
                          engagement_rate?: number;
                          cost_per_click?: number;
                          cost_per_completed_view?: number;
                          cpm?: number;
                          downloads?: number;
                          units_sold?: number;
                          new_to_brand_units?: number;
                          by_action_source?: {
                              action_source: ActionSource;
                              event_source_id?: (...)
                              | (...);
                              count: number;
                              value?: (...) | (...);
                          }[];
                          vendor_metric_values?: {
                              vendor: {
                                  domain: ...;
                                  brand_id?: ...;
                                  countries?: ...;
                                  industries?: ...;
                                  data_subject_contestation?: ...;
                                  brand_kit_override?: ...;
                              };
                              metric_id: string;
                              value: number;
                              unit?: (...)
                              | (...);
                              measurable_impressions?: (...) | (...);
                              breakdown?: (...) | (...);
                          }[];
                      };
                      variant_count?: number;
                      variants: {
                          impressions?: number;
                          spend?: number;
                          clicks?: number;
                          ctr?: number;
                          views?: number;
                          completed_views?: number;
                          completion_rate?: number
                          | null;
                          conversions?: number;
                          conversion_value?: number;
                          commissionable_value?: number;
                          roas?: number;
                          cost_per_acquisition?: number;
                          new_to_brand_rate?: number;
                          leads?: number;
                          incremental_sales_lift?: number;
                          brand_lift?: number;
                          foot_traffic?: number;
                          conversion_lift?: number;
                          brand_search_lift?: number;
                          plays?: number;
                          by_event_type?: {
                              event_type: EventType;
                              event_source_id?: (...) | (...);
                              count: number;
                              value?: (...) | (...);
                          }[];
                          grps?: number;
                          reach?: number;
                          reach_unit?: ReachUnit;
                          reach_window?: {
                              kind: "cumulative"
                              | "period"
                              | "rolling";
                              period?: { interval: ...; unit: ... };
                          };
                          frequency?: number;
                          quartile_data?: | {
                              q1_views?: number;
                              q2_views?: number;
                              q3_views?: number;
                              q4_views?: number;
                          }
                          | null;
                          dooh_metrics?: {
                              loop_plays?: number;
                              screens_used?: number;
                              screen_time_seconds?: number;
                              sov_achieved?: number;
                              calculation_notes?: string;
                              venue_breakdown?: (...)[];
                          };
                          viewability?: {
                              vendor?: {
                                  domain: ...;
                                  brand_id?: ...;
                                  countries?: ...;
                                  industries?: ...;
                                  data_subject_contestation?: ...;
                                  brand_kit_override?: ...;
                              };
                              measurable_impressions?: number;
                              viewable_impressions?: number;
                              viewable_rate?: number;
                              viewed_seconds?: number;
                              standard?: ViewabilityStandard;
                          };
                          engagements?: number;
                          follows?: number;
                          saves?: number;
                          profile_visits?: number;
                          engagement_rate?: number;
                          cost_per_click?: number;
                          cost_per_completed_view?: number;
                          cpm?: number;
                          downloads?: number;
                          units_sold?: number;
                          new_to_brand_units?: number;
                          by_action_source?: {
                              action_source: ActionSource;
                              event_source_id?: (...)
                              | (...);
                              count: number;
                              value?: (...) | (...);
                          }[];
                          vendor_metric_values?: {
                              vendor: {
                                  domain: ...;
                                  brand_id?: ...;
                                  countries?: ...;
                                  industries?: ...;
                                  data_subject_contestation?: ...;
                                  brand_kit_override?: ...;
                              };
                              metric_id: string;
                              value: number;
                              unit?: (...)
                              | (...);
                              measurable_impressions?: (...) | (...);
                              breakdown?: (...) | (...);
                          }[];
                          variant_id: string;
                          locale_variant_id?: string;
                          manifest?: | {
                              format_kind?: CanonicalFormatKind;
                              format_option_ref?: | {
                                  scope: ...;
                                  publisher_domain: ...;
                                  format_option_id: ...;
                              }
                              | { scope: ...; format_option_id: ...; publisher_domain?: ... };
                              assets: {
                                  [key: string]:
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                              };
                              brand?: {
                                  domain: ...;
                                  brand_id?: ...;
                                  countries?: ...;
                                  industries?: ...;
                                  data_subject_contestation?: ...;
                                  brand_kit_override?: ...;
                              };
                              rights?: (...)[];
                              industry_identifiers?: (...)[];
                              provenance?: {
                                  digital_source_type?: ...;
                                  synthetic_depiction?: ...;
                                  ai_tool?: ...;
                                  human_oversight?: ...;
                                  declared_by?: ...;
                                  declared_at?: ...;
                                  created_time?: ...;
                                  c2pa?: ...;
                                  embedded_provenance?: ...;
                                  watermarks?: ...;
                                  disclosure?: ...;
                                  verification?: ...;
                                  ext?: ...;
                              };
                              ext?: { [key: ...]: ... };
                          }
                          | {
                              format_kind?: CanonicalFormatKind;
                              format_option_ref?: | {
                                  scope: ...;
                                  publisher_domain: ...;
                                  format_option_id: ...;
                              }
                              | { scope: ...; format_option_id: ...; publisher_domain?: ... };
                              assets: {
                                  [key: string]:
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                              };
                              brand?: {
                                  domain: ...;
                                  brand_id?: ...;
                                  countries?: ...;
                                  industries?: ...;
                                  data_subject_contestation?: ...;
                                  brand_kit_override?: ...;
                              };
                              rights?: (...)[];
                              industry_identifiers?: (...)[];
                              provenance?: {
                                  digital_source_type?: ...;
                                  synthetic_depiction?: ...;
                                  ai_tool?: ...;
                                  human_oversight?: ...;
                                  declared_by?: ...;
                                  declared_at?: ...;
                                  created_time?: ...;
                                  c2pa?: ...;
                                  embedded_provenance?: ...;
                                  watermarks?: ...;
                                  disclosure?: ...;
                                  verification?: ...;
                                  ext?: ...;
                              };
                              ext?: { [key: ...]: ... };
                          };
                          generation_context?: {
                              context_type?: string;
                              artifact?: { property_id: ...; artifact_id: ... };
                              ext?: { [key: ...]: ... };
                          };
                      }[];
                  }[];
                  pagination?: {
                      limit: number;
                      offset: number;
                      has_more: boolean;
                      total_count?: number;
                      total?: number;
                  };
                  errors?: {
                      code: string;
                      message: string;
                      field?: string;
                      suggestion?: string;
                      retry_after?: number;
                      issues?: {
                          pointer: string;
                          message: string;
                          keyword: string;
                          schemaPath?: string;
                          schema_id?: string;
                          discriminator?: (...)[];
                      }[];
                      details?: {};
                      recovery?: "transient"
                      | "correctable"
                      | "terminal";
                      source?: "producer" | "sdk";
                      sdk_id?: string;
                  }[];
                  ext?: { [key: string]: unknown };
              },
          >,
      >

    • Return the seller's declared adcp.idempotency.replay_ttl_seconds, or throw when a v3 seller omits the (required) declaration.

      Returns undefined for v2 agents — v2 pre-dates the idempotency envelope.

      Returns Promise<number | undefined>

    • Assert that the seller's capabilities corroborate this client's pinned AdCP major (per getAdcpVersion()). Throws VersionUnsupportedError otherwise. Set ADCP_ALLOW_V2=1 to bypass.

      Parameters

      • taskType: string = 'request'

      Returns Promise<void>

    • Parameters

      • params: {
            adcp_version?: string;
            adcp_major_version?: number;
            request_type: "single" | "batch" | "variant";
            creative_manifest?: LegacyCreativeManifest;
            target_capability_id?: string;
            format_id?: LegacyFormatReferenceStructuredObject;
            inputs?: {
                name: string;
                macros?: { [k: string]: string | undefined };
                context_description?: string;
            }[];
            template_id?: string;
            quality?: CreativeQuality;
            output_format?: PreviewOutputFormat;
            item_limit?: number;
            requests?: {
                target_capability_id?: string;
                format_id?: LegacyFormatReferenceStructuredObject;
                creative_manifest?: LegacyCreativeManifest;
                creative_id?: string;
                inputs?: {
                    name: string;
                    macros?: { [k: string]: string
                    | undefined };
                    context_description?: string;
                }[];
                template_id?: string;
                quality?: CreativeQuality;
                output_format?: PreviewOutputFormat;
                item_limit?: number;
            }[];
            variant_id?: string;
            creative_id?: string;
            allow_async?: boolean;
            push_notification_config?: PushNotificationConfig;
            context?: ContextObject;
            ext?: ExtensionObject;
        }
        • Optionaladcp_version?: string

          Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

        • Optionaladcp_major_version?: number

          DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

        • request_type: "single" | "batch" | "variant"

          Preview mode. 'single' previews one creative manifest. 'batch' previews multiple creatives in one call. 'variant' replays a post-flight variant by ID.

        • Optionalcreative_manifest?: LegacyCreativeManifest
        • Optionaltarget_capability_id?: string

          Canonical preview-operation selector. Identifies one get_adcp_capabilities creative.supported_formats[].capability_id entry whose operations contains preview. In single mode it selects the renderer for this request; in batch mode it is the default for items that omit their own target_capability_id. When omitted, the agent MAY resolve the renderer only if exactly one advertised preview capability satisfies the manifest's canonical declaration; zero matches or multiple matches MUST be rejected with FORMAT_NOT_SUPPORTED rather than choosing nondeterministically. Mutually exclusive with deprecated format_id.

          ^[a-zA-Z0-9_-]+$

        • Optionalformat_id?: LegacyFormatReferenceStructuredObject
        • Optionalinputs?: {
              name: string;
              macros?: { [k: string]: string | undefined };
              context_description?: string;
          }[]

          Array of input sets for generating multiple preview variants. Each input set defines macros and context values for one preview rendering. Used in single mode.

        • Optionaltemplate_id?: string

          Specific template ID for custom format rendering. Used in single mode.

        • Optionalquality?: CreativeQuality
        • Optionaloutput_format?: PreviewOutputFormat
        • Optionalitem_limit?: number

          Maximum number of catalog items to render per preview variant. Used in single mode. Creative agents SHOULD default to a reasonable sample when omitted and the catalog is large.

          1

        • Optionalrequests?: {
              target_capability_id?: string;
              format_id?: LegacyFormatReferenceStructuredObject;
              creative_manifest?: LegacyCreativeManifest;
              creative_id?: string;
              inputs?: {
                  name: string;
                  macros?: { [k: string]: string | undefined };
                  context_description?: string;
              }[];
              template_id?: string;
              quality?: CreativeQuality;
              output_format?: PreviewOutputFormat;
              item_limit?: number;
          }[]

          Array of preview requests (1-50 items). Required when request_type is 'batch'. Each item follows the single request structure.

        • Optionalvariant_id?: string

          Platform-assigned variant identifier from get_creative_delivery response. Required when request_type is 'variant'.

        • Optionalcreative_id?: string

          Creative-library identifier. In single mode, previews the stored canonical creative without requiring the caller to reconstruct its manifest. Also available as context in variant mode.

        • Optionalallow_async?: boolean

          Opt in to an asynchronous preview response. When true, the creative agent MAY return status 'submitted' with a task_id only when rendering has been handed to a queue or external renderer and will continue after the request connection is released. Active processing on an open connection uses working progress instead. The buyer polls get_task_status for completion. When false or absent, the agent MUST return a synchronous preview response or a terminal protocol error; it MUST NOT return the submitted shape. This field applies to preview_creative only; build_creative already defines its own async lifecycle.

        • Optionalpush_notification_config?: PushNotificationConfig
        • Optionalcontext?: ContextObject
        • Optionalext?: ExtensionObject
      • OptionalinputHandler: InputHandler
      • Optionaloptions: TaskOptions

      Returns Promise<TaskResult<LegacyPreviewCreativeResponse>>

      Migration-only access to legacy format_id-based creative preview.

    • Continue the conversation with a natural language message

      Type Parameters

      • T = any

      Parameters

      • message: string

        Natural language message to send to the agent

      • OptionalinputHandler: InputHandler

        Handler for any clarification requests

      • Optionaloptions: TaskOptions

      Returns Promise<TaskResult<T>>

      const agent = multiClient.agent('my-agent');
      await agent.getProducts({ brief: 'Tech products' });

      // Continue the conversation
      const refined = await agent.continueConversation(
        'Focus only on laptops under $1000'
      );

    • Clear the conversation context (start fresh).

      Equivalent to resetContext() — clears both the retained contextId and any pending server-side taskId, and drops cached history.

      Returns void

    • Reset conversation state. Call with no args to start a fresh conversation; pass a seed to rehydrate a persisted session id (e.g., across a process restart).

      Always clears the retained pending-task handle — a persisted contextId places the next send into the same server-side session, but any old taskId is stale.

      Parameters

      • Optionalseed: string

      Returns void

    • Get the pending server-side taskId from the last non-terminal response, if any. Populated when the server returned input-required / working / submitted / auth-required; cleared when the task reaches a terminal state.

      Persist this alongside getContextId() if you need to resume a specific task (not just a conversation) across a process restart.

      Returns string | undefined

    • Get the canonical base URL for this agent

      Returns the canonical URL if already resolved, or computes it synchronously. For guaranteed canonical URL (especially for A2A), use resolveCanonicalUrl() first.

      Returns string

    • Resolve and return the canonical base URL for this agent

      For A2A: Fetches the agent card and uses its 'url' field For MCP: Performs endpoint discovery and strips /mcp suffix

      Not supported on in-process instances (created via fromMCPClient). Use getAgentId() / getAgentName() for identification instead.

      Returns Promise<string>

    • Get agent information including capabilities

      Parameters

      • Optionaloptions: Pick<TaskOptions, "signal" | "transport">

      Returns Promise<
          {
              name: string;
              description?: string;
              protocol: "mcp"
              | "a2a";
              url: string;
              tools: {
                  name: string;
                  description?: string;
                  inputSchema?: Record<string, unknown>;
                  parameters?: string[];
              }[];
          },
      >

    • Explicit raw-task compatibility escape hatch for conformance and migration tooling.

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<TaskResult<T>>

      Application code should use typed primary methods or executeTask().

    • Get detailed information about a specific task

      Parameters

      • taskId: string

      Returns Promise<TaskInfo | null>

    • Subscribe to task notifications for this agent

      Parameters

      • callback: (task: TaskInfo) => void

      Returns () => void

    • Subscribe to all task events

      Parameters

      • callbacks: {
            onTaskCreated?: (task: TaskInfo) => void;
            onTaskUpdated?: (task: TaskInfo) => void;
            onTaskCompleted?: (task: TaskInfo) => void;
            onTaskFailed?: (task: TaskInfo, error: string) => void;
        }

      Returns () => void

    • Generate webhook URL for a specific task and operation.

      Not supported on in-process instances (created via fromMCPClient). In-process clients have no HTTP listener to receive webhook callbacks.

      Parameters

      • taskType: string
      • operationId: string

      Returns string

    • Register webhook for task notifications.

      Not supported on in-process instances (created via fromMCPClient).

      Parameters

      • webhookUrl: string
      • OptionaltaskTypes: string[]

      Returns Promise<void>

    • Unregister webhook notifications.

      Not supported on in-process instances (created via fromMCPClient).

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    getAdcpVersionnegotiateMediaBuyLifecyclefromMCPClienthandleWebhookverifyAndParseWebhookcreateWebhookHandlerverifyWebhookSignaturegetProductslistProductsrequestProposalsdeclineProposalsbuyProductsacceptProposalcontrolMediaBuyreportPlanAdjustmentsyncAgentNotificationConfigsrefineProposalsgetProductsLegacylistCreativeFormatsLegacylistTransformersLegacycreateMediaBuycreateMediaBuyLegacyupdateMediaBuyupdateMediaBuyLegacysyncCreativessyncCreativesLegacylistCreativeslistCreativesLegacygetMediaBuysgetMediaBuyDeliverygetCreativeDeliveryprovidePerformanceFeedbackgetSignalsactivateSignalgetAdcpCapabilitiesgetCapabilitiesgetIdempotencyReplayTtlSecondsrequireSupportedMajorrequireV3previewCreativepreviewCreativeLegacybuildCreativeLegacylistAccountssyncAccountssyncAudiencescreatePropertyListgetPropertyListupdatePropertyListlistPropertyListsdeletePropertyListlistContentStandardsLegacygetContentStandardsLegacycalibrateContentLegacyvalidateContentDeliveryLegacysiGetOfferingsiInitiateSessionsiSendMessagesiTerminateSessioncontinueConversationgetHistoryclearContextresetContextgetContextIdgetPendingTaskIdsetContextIdgetAgentgetAgentIdgetAgentNamegetProtocolgetCanonicalUrlresolveCanonicalUrlisSameAgentisSameAgentResolvedgetResolvedAgentgetAgentInfohasActiveConversationgetActiveTasksexecuteTaskexecuteCustomTaskexecuteTaskLegacylistTasksgetTaskInfoonTaskUpdateonTaskEventsgetWebhookUrlregisterWebhookunregisterWebhook