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

    Interface GetCollectionListRequest

    Request parameters for retrieving a collection list with resolved collections

    interface GetCollectionListRequest {
        adcp_major_version?: number;
        list_id: string;
        account?: AccountReference;
        resolve?: boolean;
        pagination?: { max_results?: number; cursor?: string };
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version? list_id account? resolve? pagination? context? ext?

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    list_id: string

    ID of the collection list to retrieve

    account?: AccountReference
    resolve?: boolean

    Whether to apply filters and return resolved collections (default: true)

    pagination?: { max_results?: number; cursor?: string }

    Pagination parameters. Uses higher limits than standard pagination because collection lists can contain thousands of entries.

    Type Declaration

    • Optionalmax_results?: number

      Maximum number of collections to return per page

      1

      10000

    • Optionalcursor?: string

      Opaque cursor from a previous response to fetch the next page

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties