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

    Function listCollectionListsResponse

    • 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;
                        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?: (...)
                                | (...);
                                alt_text?: (...) | (...);
                                provenance?: (...) | (...);
                            };
                            colors?: {
                                primary?: (...)
                                | (...);
                                secondary?: (...) | (...);
                                accent?: (...) | (...);
                            };
                            voice?: string;
                            tagline?: string;
                        };
                    };
                    operator: string;
                    sandbox?: boolean;
                };
                base_collections?: (
                    | {
                        selection_type: "distribution_ids";
                        identifiers: { 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;
                    }[];
                    production_quality?: ProductionQuality[];
                };
                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;
                    };
                };
                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<{}, "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.

        • lists: {
              list_id: string;
              name: string;
              description?: string;
              account?:
                  | { account_id: string }
                  | {
                      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?: (...)
                                  | (...);
                                  alt_text?: (...) | (...);
                                  provenance?: (...) | (...);
                              };
                              colors?: {
                                  primary?: (...)
                                  | (...);
                                  secondary?: (...) | (...);
                                  accent?: (...) | (...);
                              };
                              voice?: string;
                              tagline?: string;
                          };
                      };
                      operator: string;
                      sandbox?: boolean;
                  };
              base_collections?: (
                  | {
                      selection_type: "distribution_ids";
                      identifiers: { 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;
                  }[];
                  production_quality?: ProductionQuality[];
              };
              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;
                  };
              };
              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.

            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.