@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Function legacyListAccountsResponse

    • Parameters

      • data: {
            context?: Omit<Omit<{}, "bank">, "authentication"> & {
                authentication?: unknown;
            };
            governance_context?: string;
            accounts: {
                account_id: string;
                name: string;
                advertiser?: string;
                billing_proxy?: string;
                status: AccountStatus;
                brand?: {
                    domain: string;
                    brand_id?: string;
                    countries?: string[];
                    industries?: string[];
                    data_subject_contestation?: Omit<Omit<{}, "bank">, "authentication"> & {
                        authentication?: unknown;
                    };
                    brand_kit_override?: {
                        logo?: {
                            asset_type: "image";
                            url: string;
                            width: number;
                            height: number;
                            file_size_bytes?: number;
                            pixel_ratio?: number;
                            state_id?: string;
                            breakpoint_id?: string;
                            focal_point?: (...)[];
                            format?: string;
                            alt_text?: string;
                            provenance?: {
                                digital_source_type?: ...;
                                synthetic_depiction?: ...;
                                ai_tool?: ...;
                                human_oversight?: ...;
                                declared_by?: ...;
                                declared_at?: ...;
                                created_time?: ...;
                                c2pa?: ...;
                                embedded_provenance?: ...;
                                watermarks?: ...;
                                disclosure?: ...;
                                verification?: ...;
                                ext?: ...;
                            };
                        };
                        colors?: { primary?: string; secondary?: string; accent?: string };
                        voice?: string;
                        tagline?: string;
                    };
                };
                operator?: string;
                operator_unit?: { id: string; name?: string };
                revision?: number;
                identity_change?:
                    | {
                        status: "pending_approval";
                        requested_operator_identity: {
                            operator: string;
                            operator_unit?: { id: string; name?: string };
                        };
                        requested_at?: string;
                    }
                    | {
                        status: "rejected";
                        requested_operator_identity: {
                            operator: string;
                            operator_unit?: { id: string; name?: string };
                        };
                        requested_at?: string;
                        reason: string;
                    };
                currency?: string;
                timezone?: string;
                billing?: BillingParty;
                billing_entity?: Omit<
                    {
                        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: "creative"
                            | "billing"
                            | "legal"
                            | "general";
                            name?: string;
                            email?: string;
                            phone?: string;
                        }[];
                        bank?: {
                            account_holder: string;
                            iban?: string;
                            bic?: string;
                            routing_number?: string;
                            account_number?: string;
                        };
                        ext?: Omit<Omit<{ [key: ...]: ... }, "bank">, "authentication"> & {
                            authentication?: unknown;
                        };
                    },
                    "bank",
                >;
                destination_billing_entity?: Omit<Omit<{}, "bank">, "authentication"> & {
                    authentication?: unknown;
                };
                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?: (
                    Omit<
                        {
                            subscriber_id: string;
                            url: string;
                            event_types: (
                                | "creative.status_changed"
                                | "creative.assignment_changed"
                                | "indicators.changed"
                                | "creative.purged"
                                | "account.status_changed"
                                | "account.change_recorded"
                                | "product.created"
                                | "product.updated"
                                | "product.priced"
                                | "product.removed"
                                | "signal.created"
                                | "signal.updated"
                                | "signal.priced"
                                | "signal.removed"
                                | "wholesale_feed.bulk_change"
                                | "reporting.delivery_ready"
                                | "reporting.status_changed"
                                | "reporting.ledger_changed"
                            )[];
                            product_payload_view?: "canonical"
                            | "legacy";
                            authentication?: { schemes: (...)[]; credentials?: (...) | (...) };
                            active?: boolean;
                            ext?: Omit<(...), (...)> & { authentication?: ... };
                        },
                        "authentication",
                    > & {
                        authentication?: Omit<
                            { schemes: (...)[]; credentials?: (...) | (...) },
                            "credentials",
                        >;
                    }
                )[];
                reporting_delivery_configs?: {
                    configuration: {
                        delivery_config_id: string;
                        delivery_config_version: number;
                        offering_id: string;
                        active: boolean;
                        feed_purpose: ReportingFeedPurpose;
                        report_definition_id: string;
                        reporting_profile: string;
                        scope: { all_media_buys?: true; media_buy_ids?: string[] };
                        coverage_requirement: "full" | "allow_partial";
                        required_finality: ReportingFinality;
                        reconciliation_mode: ReportingReconciliationMode;
                        authoritative_party?: "seller" | "consumer";
                        schedule: {
                            period_duration: string;
                            alignment: ReportingScheduleAlignment;
                            period_anchor?: string;
                            period_timezone?: string;
                            delivery_sla: string;
                        };
                        method?: | {
                            pattern: "file_transfer";
                            transport: string;
                            orchestration: ReportingOrchestration;
                            destination: | { mode: ...; destination_ref: ... }
                            | { mode: ...; provider: ...; location: ...; access_mode?: ... };
                            format: "jsonl" | "csv" | "parquet" | "avro" | "orc";
                        }
                        | {
                            pattern: "dataset_share";
                            transport: string;
                            orchestration: ReportingOrchestration;
                            destination: | { mode: ...; destination_ref: ... }
                            | { mode: ...; provider: ...; access_mode: ...; recipient: ... };
                        }
                        | {
                            pattern: "warehouse_materialization";
                            transport: string;
                            orchestration: ReportingOrchestration;
                            destination: | { mode: ...; destination_ref: ... }
                            | { mode: ...; provider: ...; location: ...; access_mode?: ... };
                        };
                        revocation_effective_at?: string;
                    };
                    state: ReportingDeliveryConfigurationLifecycleState;
                    destination_ref?: string;
                    validated_at?: string;
                    activated_at?: string;
                    deactivated_at?: string;
                    publication_stopped_at?: string;
                    seller_managed_access_ends_at?: string;
                    current_coverage?: {
                        status: "unknown"
                        | "none"
                        | "full"
                        | "partial";
                        evaluated_at: string;
                        media_buy_ids: string[];
                        fully_covered_media_buy_ids: string[];
                        partially_covered_media_buy_ids: string[];
                        unsupported_media_buy_ids: string[];
                        unknown_media_buy_ids: string[];
                        package_ids: string[];
                        covered_package_ids: string[];
                        unsupported_package_ids: string[];
                        unknown_package_ids: string[];
                        limitations: {
                            reason: (...) | (...) | (...) | (...) | (...);
                            media_buy_id: string;
                            package_ids?: (...) | (...);
                        }[];
                    };
                    setup?: {
                        action: | "grant_access"
                        | "activate_recipient"
                        | "authorize_provider"
                        | "repair_access";
                        message: string;
                        url?: string;
                        expires_at?: string;
                    };
                    issues?: {
                        issue_id: string;
                        code: | "REPORT_OVERDUE"
                        | "PRODUCTION_FAILED"
                        | "DELIVERY_FAILED"
                        | "ACCESS_REQUIRED"
                        | "CONFIGURATION_REQUIRED"
                        | "REPORTING_COVERAGE_INCOMPLETE"
                        | "RESOURCE_EXPIRED"
                        | "READER_INCOMPATIBLE"
                        | "HISTORY_UNAVAILABLE"
                        | "RECEIPT_REQUIRED"
                        | "RECEIPT_REJECTED"
                        | "ADJUSTMENT_RECEIPT_REQUIRED"
                        | "ADJUSTMENT_RECEIPT_REJECTED"
                        | "CONSUMER_STATUS_MISMATCH";
                        severity: ReportingStatusSeverity;
                        opened_at?: string;
                        issue_state?: "open"
                        | "acknowledged"
                        | "resolved"
                        | "waived";
                        external_ref?: string;
                        responsible_party: "buyer" | "seller" | "provider";
                        recommended_action:
                            | "repair_access"
                            | "wait_for_retry"
                            | "contact_buyer"
                            | "contact_seller"
                            | "contact_provider"
                            | "update_configuration"
                            | "change_reporting_scope"
                            | "use_supported_reader";
                        message?: string;
                        reporting_obligation_id?: string;
                        reporting_status_id?: string;
                        delivery_config_id?: string;
                        delivery_config_version?: number;
                        feed_purpose?: ReportingFeedPurpose;
                        media_buy_ids?: (...)[];
                        package_ids?: (...)[];
                        period_start?: string;
                        period_end?: string;
                        expected_at?: 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?: Omit<Omit<{ [key: ...]: ... }, "bank">, "authentication"> & {
                        authentication?: unknown;
                    };
                }[];
                ext?: Omit<Omit<{ [key: string]: unknown }, "bank">, "authentication"> & {
                    authentication?: unknown;
                };
                authorization?: {
                    allowed_tasks: string[];
                    field_scopes?: Omit<
                        Omit<{ [key: string]: (...) | (...) }, "bank">,
                        "authentication",
                    > & { authentication?: unknown };
                    scope_name?: string;
                    read_only?: boolean;
                };
            }[];
            errors?: {
                code: string;
                message: string;
                buyer_reason?: { 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: string;
                        value: (...) | (...) | (...) | (...) | (...);
                    }[];
                }[];
                details?: Omit<Omit<{}, "bank">, "authentication"> & {
                    authentication?: unknown;
                };
                recovery?: "transient"
                | "correctable"
                | "terminal";
                source?: "producer" | "sdk";
                sdk_id?: string;
            }[];
            pagination?: { has_more: boolean; cursor?: string; total_count?: number };
            ext?: Omit<Omit<{ [key: string]: unknown }, "bank">, "authentication"> & {
                authentication?: unknown;
            };
        }
        • Optionalcontext?: Omit<Omit<{}, "bank">, "authentication"> & { authentication?: unknown }
        • Optionalgovernance_context?: string

          Opaque authorization context issued only by an approved check_governance decision. Buyers attach it to governed requests across protocol roles (media buys, rights acquisitions, signal activations, creative services); receiving services persist it and forward it on subsequent execution and lifecycle checks. The context is the authoritative plan binding at service boundaries, so a service MUST NOT require a separate plan_id.

          Governance agents MUST emit a compact JWS per the AdCP JWS profile. Verifiers validate standard authorization claims such as signature, issuer, audience, expiry, and replay protection, but intermediaries MUST NOT interpret embedded governance state for business logic. A conditions or denied verdict never carries an authorization context.

          This is the primary correlation key for audit and reporting across the governance lifecycle.

        • accounts: {
              account_id: string;
              name: string;
              advertiser?: string;
              billing_proxy?: string;
              status: AccountStatus;
              brand?: {
                  domain: string;
                  brand_id?: string;
                  countries?: string[];
                  industries?: string[];
                  data_subject_contestation?: Omit<Omit<{}, "bank">, "authentication"> & {
                      authentication?: unknown;
                  };
                  brand_kit_override?: {
                      logo?: {
                          asset_type: "image";
                          url: string;
                          width: number;
                          height: number;
                          file_size_bytes?: number;
                          pixel_ratio?: number;
                          state_id?: string;
                          breakpoint_id?: string;
                          focal_point?: (...)[];
                          format?: string;
                          alt_text?: string;
                          provenance?: {
                              digital_source_type?: ...;
                              synthetic_depiction?: ...;
                              ai_tool?: ...;
                              human_oversight?: ...;
                              declared_by?: ...;
                              declared_at?: ...;
                              created_time?: ...;
                              c2pa?: ...;
                              embedded_provenance?: ...;
                              watermarks?: ...;
                              disclosure?: ...;
                              verification?: ...;
                              ext?: ...;
                          };
                      };
                      colors?: { primary?: string; secondary?: string; accent?: string };
                      voice?: string;
                      tagline?: string;
                  };
              };
              operator?: string;
              operator_unit?: { id: string; name?: string };
              revision?: number;
              identity_change?:
                  | {
                      status: "pending_approval";
                      requested_operator_identity: {
                          operator: string;
                          operator_unit?: { id: string; name?: string };
                      };
                      requested_at?: string;
                  }
                  | {
                      status: "rejected";
                      requested_operator_identity: {
                          operator: string;
                          operator_unit?: { id: string; name?: string };
                      };
                      requested_at?: string;
                      reason: string;
                  };
              currency?: string;
              timezone?: string;
              billing?: BillingParty;
              billing_entity?: Omit<
                  {
                      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: "creative"
                          | "billing"
                          | "legal"
                          | "general";
                          name?: string;
                          email?: string;
                          phone?: string;
                      }[];
                      bank?: {
                          account_holder: string;
                          iban?: string;
                          bic?: string;
                          routing_number?: string;
                          account_number?: string;
                      };
                      ext?: Omit<Omit<{ [key: ...]: ... }, "bank">, "authentication"> & {
                          authentication?: unknown;
                      };
                  },
                  "bank",
              >;
              destination_billing_entity?: Omit<Omit<{}, "bank">, "authentication"> & {
                  authentication?: unknown;
              };
              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?: (
                  Omit<
                      {
                          subscriber_id: string;
                          url: string;
                          event_types: (
                              | "creative.status_changed"
                              | "creative.assignment_changed"
                              | "indicators.changed"
                              | "creative.purged"
                              | "account.status_changed"
                              | "account.change_recorded"
                              | "product.created"
                              | "product.updated"
                              | "product.priced"
                              | "product.removed"
                              | "signal.created"
                              | "signal.updated"
                              | "signal.priced"
                              | "signal.removed"
                              | "wholesale_feed.bulk_change"
                              | "reporting.delivery_ready"
                              | "reporting.status_changed"
                              | "reporting.ledger_changed"
                          )[];
                          product_payload_view?: "canonical"
                          | "legacy";
                          authentication?: { schemes: (...)[]; credentials?: (...) | (...) };
                          active?: boolean;
                          ext?: Omit<(...), (...)> & { authentication?: ... };
                      },
                      "authentication",
                  > & {
                      authentication?: Omit<
                          { schemes: (...)[]; credentials?: (...) | (...) },
                          "credentials",
                      >;
                  }
              )[];
              reporting_delivery_configs?: {
                  configuration: {
                      delivery_config_id: string;
                      delivery_config_version: number;
                      offering_id: string;
                      active: boolean;
                      feed_purpose: ReportingFeedPurpose;
                      report_definition_id: string;
                      reporting_profile: string;
                      scope: { all_media_buys?: true; media_buy_ids?: string[] };
                      coverage_requirement: "full" | "allow_partial";
                      required_finality: ReportingFinality;
                      reconciliation_mode: ReportingReconciliationMode;
                      authoritative_party?: "seller" | "consumer";
                      schedule: {
                          period_duration: string;
                          alignment: ReportingScheduleAlignment;
                          period_anchor?: string;
                          period_timezone?: string;
                          delivery_sla: string;
                      };
                      method?: | {
                          pattern: "file_transfer";
                          transport: string;
                          orchestration: ReportingOrchestration;
                          destination: | { mode: ...; destination_ref: ... }
                          | { mode: ...; provider: ...; location: ...; access_mode?: ... };
                          format: "jsonl" | "csv" | "parquet" | "avro" | "orc";
                      }
                      | {
                          pattern: "dataset_share";
                          transport: string;
                          orchestration: ReportingOrchestration;
                          destination: | { mode: ...; destination_ref: ... }
                          | { mode: ...; provider: ...; access_mode: ...; recipient: ... };
                      }
                      | {
                          pattern: "warehouse_materialization";
                          transport: string;
                          orchestration: ReportingOrchestration;
                          destination: | { mode: ...; destination_ref: ... }
                          | { mode: ...; provider: ...; location: ...; access_mode?: ... };
                      };
                      revocation_effective_at?: string;
                  };
                  state: ReportingDeliveryConfigurationLifecycleState;
                  destination_ref?: string;
                  validated_at?: string;
                  activated_at?: string;
                  deactivated_at?: string;
                  publication_stopped_at?: string;
                  seller_managed_access_ends_at?: string;
                  current_coverage?: {
                      status: "unknown"
                      | "none"
                      | "full"
                      | "partial";
                      evaluated_at: string;
                      media_buy_ids: string[];
                      fully_covered_media_buy_ids: string[];
                      partially_covered_media_buy_ids: string[];
                      unsupported_media_buy_ids: string[];
                      unknown_media_buy_ids: string[];
                      package_ids: string[];
                      covered_package_ids: string[];
                      unsupported_package_ids: string[];
                      unknown_package_ids: string[];
                      limitations: {
                          reason: (...) | (...) | (...) | (...) | (...);
                          media_buy_id: string;
                          package_ids?: (...) | (...);
                      }[];
                  };
                  setup?: {
                      action: | "grant_access"
                      | "activate_recipient"
                      | "authorize_provider"
                      | "repair_access";
                      message: string;
                      url?: string;
                      expires_at?: string;
                  };
                  issues?: {
                      issue_id: string;
                      code: | "REPORT_OVERDUE"
                      | "PRODUCTION_FAILED"
                      | "DELIVERY_FAILED"
                      | "ACCESS_REQUIRED"
                      | "CONFIGURATION_REQUIRED"
                      | "REPORTING_COVERAGE_INCOMPLETE"
                      | "RESOURCE_EXPIRED"
                      | "READER_INCOMPATIBLE"
                      | "HISTORY_UNAVAILABLE"
                      | "RECEIPT_REQUIRED"
                      | "RECEIPT_REJECTED"
                      | "ADJUSTMENT_RECEIPT_REQUIRED"
                      | "ADJUSTMENT_RECEIPT_REJECTED"
                      | "CONSUMER_STATUS_MISMATCH";
                      severity: ReportingStatusSeverity;
                      opened_at?: string;
                      issue_state?: "open"
                      | "acknowledged"
                      | "resolved"
                      | "waived";
                      external_ref?: string;
                      responsible_party: "buyer" | "seller" | "provider";
                      recommended_action:
                          | "repair_access"
                          | "wait_for_retry"
                          | "contact_buyer"
                          | "contact_seller"
                          | "contact_provider"
                          | "update_configuration"
                          | "change_reporting_scope"
                          | "use_supported_reader";
                      message?: string;
                      reporting_obligation_id?: string;
                      reporting_status_id?: string;
                      delivery_config_id?: string;
                      delivery_config_version?: number;
                      feed_purpose?: ReportingFeedPurpose;
                      media_buy_ids?: (...)[];
                      package_ids?: (...)[];
                      period_start?: string;
                      period_end?: string;
                      expected_at?: 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?: Omit<Omit<{ [key: ...]: ... }, "bank">, "authentication"> & {
                      authentication?: unknown;
                  };
              }[];
              ext?: Omit<Omit<{ [key: string]: unknown }, "bank">, "authentication"> & {
                  authentication?: unknown;
              };
              authorization?: {
                  allowed_tasks: string[];
                  field_scopes?: Omit<
                      Omit<{ [key: string]: (...) | (...) }, "bank">,
                      "authentication",
                  > & { authentication?: unknown };
                  scope_name?: string;
                  read_only?: boolean;
              };
          }[]

          Array of accounts accessible to the authenticated agent. Each entry is the full Account object plus optional authorization. Buyer-declared entries include brand, operator, and any operator_unit, fixed currency, buyer-selected account timezone, and sandbox qualifiers so the natural AccountRef round-trips after a cold start.

        • Optionalerrors?: {
              code: string;
              message: string;
              buyer_reason?: { 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: string;
                      value: (...) | (...) | (...) | (...) | (...);
                  }[];
              }[];
              details?: Omit<Omit<{}, "bank">, "authentication"> & {
                  authentication?: unknown;
              };
              recovery?: "transient"
              | "correctable"
              | "terminal";
              source?: "producer" | "sdk";
              sdk_id?: string;
          }[]

          Task-specific errors and warnings

        • Optionalpagination?: { has_more: boolean; cursor?: string; total_count?: number }
          • has_more: boolean

            Whether more results are available beyond this page

          • Optionalcursor?: string

            Opaque cursor to pass in the next request to fetch the next page. Only present when has_more is true.

          • Optionaltotal_count?: number

            Total number of items matching the query across all pages. Optional because not all backends can efficiently compute this.

        • Optionalext?: Omit<Omit<{ [key: string]: unknown }, "bank">, "authentication"> & {
              authentication?: unknown;
          }
      • Optionalsummary: string

      Returns McpToolResponse

      v6: createAdcpServerFromPlatform constructs wire responses from typed platform returns. Direct use is for v5 raw-handler adopters mid-migration only.