@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface GetCollectionListResponse

    Response payload for get_collection_list task. Returns resolved collection entries with identification and key metadata for matching. Consumers should cache the resolved collections and refresh based on cache_valid_until.

    interface GetCollectionListResponse {
        list: CollectionList;
        collections?: {
            collection_rid?: string;
            name: string;
            distribution_ids?: { type: DistributionIdentifierType; value: string }[];
            content_rating?: ContentRating;
            genre?: string[];
            genre_taxonomy?: GenreTaxonomy;
            kind?: CollectionKind;
        }[];
        pagination?: PaginationResponse;
        resolved_at?: string;
        cache_valid_until?: string;
        coverage_gaps?: {
            [k: string]: | { type: DistributionIdentifierType; value: string }[]
            | undefined;
        };
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    list collections? pagination? resolved_at? cache_valid_until? coverage_gaps? context? ext?

    Properties

    list: CollectionList
    collections?: {
        collection_rid?: string;
        name: string;
        distribution_ids?: { type: DistributionIdentifierType; value: string }[];
        content_rating?: ContentRating;
        genre?: string[];
        genre_taxonomy?: GenreTaxonomy;
        kind?: CollectionKind;
    }[]

    Resolved collections that passed filters (if resolve=true). Each entry contains identification and key metadata for seller matching.

    Type Declaration

    • Optionalcollection_rid?: string

      Registry-assigned stable identifier for this collection. Present when the collection has been registered in the collection registry.

    • name: string

      Human-readable collection name

    • Optionaldistribution_ids?: { type: DistributionIdentifierType; value: string }[]

      Platform-independent identifiers for cross-publisher matching

    • Optionalcontent_rating?: ContentRating
    • Optionalgenre?: string[]

      Genre tags for this collection

    • Optionalgenre_taxonomy?: GenreTaxonomy
    • Optionalkind?: CollectionKind
    pagination?: PaginationResponse
    resolved_at?: string

    When the list was resolved

    date-time

    cache_valid_until?: string

    Cache expiration timestamp. Re-fetch the list after this time to get updated collections.

    date-time

    coverage_gaps?: {
        [k: string]:
            | { type: DistributionIdentifierType; value: string }[]
            | undefined;
    }

    Collections included in the list despite missing metadata for a filtered dimension. Maps dimension name (e.g., 'genre', 'content_rating') to arrays of distribution identifiers for collections not covered. Only present when filters are applied and some collections lack the filtered metadata.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties