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

    Function legacyListCollectionListsResponse

    • Parameters

      • data: {
            context?: Omit<Omit<{}, "bank">, "authentication"> & {
                authentication?: unknown;
            };
            governance_context?: string;
            lists: {
                list_id: string;
                name: string;
                description?: string;
                account?: | { account_id: string }
                | {
                    brand: {
                        domain: string;
                        brand_id?: string;
                        countries?: 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;
                                file_size_bytes?: (...)
                                | (...);
                                pixel_ratio?: (...) | (...);
                                format?: (...) | (...);
                                alt_text?: (...) | (...);
                                provenance?: (...) | (...);
                            };
                            colors?: {
                                primary?: (...)
                                | (...);
                                secondary?: (...) | (...);
                                accent?: (...) | (...);
                            };
                            voice?: string;
                            tagline?: string;
                        };
                    };
                    operator: string;
                    operator_unit?: { id: string; name?: string };
                    currency?: string;
                    timezone?: string;
                    sandbox?: boolean;
                };
                base_collections?: (
                    | {
                        selection_type: "distribution_ids";
                        identifiers: (
                            | { type: DistributionIdentifierType; value: string }
                            | { type: DistributionIdentifierType; value: string }
                        )[];
                    }
                    | {
                        selection_type: "publisher_collections";
                        publisher_domain: string;
                        collection_ids: string[];
                    }
                    | {
                        selection_type: "publisher_genres";
                        publisher_domain: string;
                        genres: string[];
                        genre_taxonomy: GenreTaxonomy;
                    }
                )[];
                filters?: {
                    content_ratings_exclude?: {
                        system: ContentRatingSystem;
                        rating: string;
                    }[];
                    content_ratings_include?: { system: ContentRatingSystem; rating: string }[];
                    genres_exclude?: string[];
                    genres_include?: string[];
                    genre_taxonomy?: GenreTaxonomy;
                    kinds?: CollectionKind[];
                    exclude_distribution_ids?: (
                        | { type: DistributionIdentifierType; value: string }
                        | { type: DistributionIdentifierType; value: string }
                    )[];
                    production_quality?: ProductionQuality[];
                };
                brand?: {
                    domain: string;
                    brand_id?: string;
                    countries?: 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;
                            file_size_bytes?: number;
                            pixel_ratio?: number;
                            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;
                    };
                };
                webhook_url?: string;
                cache_duration_hours?: number;
                created_at?: string;
                updated_at?: string;
                collection_count?: number;
            }[];
            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.

        • lists: {
              list_id: string;
              name: string;
              description?: string;
              account?:
                  | { account_id: string }
                  | {
                      brand: {
                          domain: string;
                          brand_id?: string;
                          countries?: 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;
                                  file_size_bytes?: (...)
                                  | (...);
                                  pixel_ratio?: (...) | (...);
                                  format?: (...) | (...);
                                  alt_text?: (...) | (...);
                                  provenance?: (...) | (...);
                              };
                              colors?: {
                                  primary?: (...)
                                  | (...);
                                  secondary?: (...) | (...);
                                  accent?: (...) | (...);
                              };
                              voice?: string;
                              tagline?: string;
                          };
                      };
                      operator: string;
                      operator_unit?: { id: string; name?: string };
                      currency?: string;
                      timezone?: string;
                      sandbox?: boolean;
                  };
              base_collections?: (
                  | {
                      selection_type: "distribution_ids";
                      identifiers: (
                          | { type: DistributionIdentifierType; value: string }
                          | { type: DistributionIdentifierType; value: string }
                      )[];
                  }
                  | {
                      selection_type: "publisher_collections";
                      publisher_domain: string;
                      collection_ids: string[];
                  }
                  | {
                      selection_type: "publisher_genres";
                      publisher_domain: string;
                      genres: string[];
                      genre_taxonomy: GenreTaxonomy;
                  }
              )[];
              filters?: {
                  content_ratings_exclude?: {
                      system: ContentRatingSystem;
                      rating: string;
                  }[];
                  content_ratings_include?: { system: ContentRatingSystem; rating: string }[];
                  genres_exclude?: string[];
                  genres_include?: string[];
                  genre_taxonomy?: GenreTaxonomy;
                  kinds?: CollectionKind[];
                  exclude_distribution_ids?: (
                      | { type: DistributionIdentifierType; value: string }
                      | { type: DistributionIdentifierType; value: string }
                  )[];
                  production_quality?: ProductionQuality[];
              };
              brand?: {
                  domain: string;
                  brand_id?: string;
                  countries?: 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;
                          file_size_bytes?: number;
                          pixel_ratio?: number;
                          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;
                  };
              };
              webhook_url?: string;
              cache_duration_hours?: number;
              created_at?: string;
              updated_at?: string;
              collection_count?: number;
          }[]

          Array of collection lists (metadata only, not resolved collections)

        • 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.