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

    Interface CreateCollectionListRequest

    Request parameters for creating a new collection list

    interface CreateCollectionListRequest {
        adcp_major_version?: number;
        account?: AccountReference;
        name: string;
        description?: string;
        base_collections?: BaseCollectionSource[];
        filters?: CollectionListFilters;
        brand?: BrandReference;
        idempotency_key: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version? account? name description? base_collections? filters? brand? idempotency_key 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

    account?: AccountReference
    name: string

    Human-readable name for the list

    description?: string

    Description of the list's purpose

    base_collections?: BaseCollectionSource[]

    Array of collection sources to evaluate. Each entry is a discriminated union: distribution_ids (platform-independent identifiers), publisher_collections (publisher_domain + collection_ids), or publisher_genres (publisher_domain + genres). If omitted, queries the agent's entire collection database.

    filters?: CollectionListFilters
    brand?: BrandReference
    idempotency_key: string

    Client-generated unique key for this request. Prevents duplicate collection list creation on retries. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.

    16

    255

    ^[A-Za-z0-9_.:-]{16,255}$

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties