@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Function listAccountsResponse

    • 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;
                    industries?: string[];
                    data_subject_contestation?: {
                        url?: string;
                        email?: string;
                        languages?: string[];
                    };
                    brand_kit_override?: {
                        logo?: {
                            asset_type: "image";
                            url: string;
                            width: number;
                            height: number;
                            format?: string;
                            alt_text?: string;
                            provenance?: {
                                digital_source_type?: ...;
                                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;
                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: "billing"
                            | "legal"
                            | "creative"
                            | "general";
                            name?: string;
                            email?: string;
                            phone?: string;
                        }[];
                        bank?: {
                            account_holder: string;
                            iban?: string;
                            bic?: string;
                            routing_number?: string;
                            account_number?: string;
                        };
                        ext?: Omit<Omit<{}, "bank">, "authentication"> & {
                            authentication?: unknown;
                        };
                    },
                    "bank",
                >;
                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?: "gzip" | "none";
                    file_retention_days: number;
                    setup_instructions?: string;
                };
                sandbox?: boolean;
                notification_configs?: (
                    Omit<
                        {
                            subscriber_id: string;
                            url: string;
                            event_types: NotificationType[];
                            authentication?: { schemes: (...)[]; credentials?: (...) | (...) };
                            active?: boolean;
                            ext?: Omit<(...), (...)> & { authentication?: ... };
                        },
                        "authentication",
                    > & {
                        authentication?: Omit<
                            { schemes: (...)[]; credentials?: (...) | (...) },
                            "credentials",
                        >;
                    }
                )[];
                ext?: Omit<Omit<{}, "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;
                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<{}, "bank">, "authentication"> & {
                authentication?: unknown;
            };
        }
        • Optionalcontext?: Omit<Omit<{}, "bank">, "authentication"> & { authentication?: unknown }
        • Optionalgovernance_context?: string

          Governance context token issued by the account's governance agent during check_governance. Buyers attach it to governed purchase requests (media buys, rights acquisitions, signal activations, creative services); sellers persist it and include it on all subsequent governance calls for that action's lifecycle. An account binds to one governance agent (see sync_governance); governance is phased across purchase / modification / delivery, not partitioned across specialist agents, so the envelope carries a single token for the full lifecycle.

          Value format: governance agents MUST emit a compact JWS per the AdCP JWS profile (see Security — Signed Governance Context). Sellers MAY verify; sellers that do not verify MUST persist and forward the token unchanged. In 3.1 all sellers MUST verify. Non-JWS values from pre-3.0 governance agents are deprecated.

          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;
                  industries?: string[];
                  data_subject_contestation?: {
                      url?: string;
                      email?: string;
                      languages?: string[];
                  };
                  brand_kit_override?: {
                      logo?: {
                          asset_type: "image";
                          url: string;
                          width: number;
                          height: number;
                          format?: string;
                          alt_text?: string;
                          provenance?: {
                              digital_source_type?: ...;
                              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;
              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: "billing"
                          | "legal"
                          | "creative"
                          | "general";
                          name?: string;
                          email?: string;
                          phone?: string;
                      }[];
                      bank?: {
                          account_holder: string;
                          iban?: string;
                          bic?: string;
                          routing_number?: string;
                          account_number?: string;
                      };
                      ext?: Omit<Omit<{}, "bank">, "authentication"> & {
                          authentication?: unknown;
                      };
                  },
                  "bank",
              >;
              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?: "gzip" | "none";
                  file_retention_days: number;
                  setup_instructions?: string;
              };
              sandbox?: boolean;
              notification_configs?: (
                  Omit<
                      {
                          subscriber_id: string;
                          url: string;
                          event_types: NotificationType[];
                          authentication?: { schemes: (...)[]; credentials?: (...) | (...) };
                          active?: boolean;
                          ext?: Omit<(...), (...)> & { authentication?: ... };
                      },
                      "authentication",
                  > & {
                      authentication?: Omit<
                          { schemes: (...)[]; credentials?: (...) | (...) },
                          "credentials",
                      >;
                  }
              )[];
              ext?: Omit<Omit<{}, "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 an optional authorization object describing what the calling agent is permitted to do on that account.

        • Optionalerrors?: {
              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.

            0

        • Optionalext?: Omit<Omit<{}, "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.