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

    Interface ListCreativesRequest

    Request parameters for querying creative assets from a creative library with filtering, sorting, and pagination. Implemented by any agent that hosts a creative library — creative agents (ad servers, creative platforms) and sales agents that manage creatives.

    interface ListCreativesRequest {
        adcp_major_version?: number;
        filters?: CreativeFilters;
        sort?: { field?: CreativeSortField; direction?: SortDirection };
        pagination?: PaginationRequest;
        include_assignments?: boolean;
        include_snapshot?: boolean;
        include_items?: boolean;
        include_variables?: boolean;
        include_pricing?: boolean;
        account?: AccountReference;
        fields?: (
            | "name"
            | "status"
            | "created_date"
            | "updated_date"
            | "creative_id"
            | "format_id"
            | "tags"
            | "assignments"
            | "snapshot"
            | "items"
            | "variables"
            | "concept"
            | "pricing_options"
        )[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version? filters? sort? pagination? include_assignments? include_snapshot? include_items? include_variables? include_pricing? account? fields? 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

    filters?: CreativeFilters
    sort?: { field?: CreativeSortField; direction?: SortDirection }

    Sorting parameters

    pagination?: PaginationRequest
    include_assignments?: boolean

    Include package assignment information in response

    include_snapshot?: boolean

    Include a lightweight delivery snapshot per creative (lifetime impressions and last-served date). For detailed performance analytics, use get_creative_delivery.

    include_items?: boolean

    Include items for multi-asset formats like carousels and native ads

    include_variables?: boolean

    Include dynamic content variable definitions (DCO slots) for each creative

    include_pricing?: boolean

    Include pricing_options on each creative. Requires account to be provided. When false or omitted, pricing is not computed.

    account?: AccountReference
    fields?: (
        | "name"
        | "status"
        | "created_date"
        | "updated_date"
        | "creative_id"
        | "format_id"
        | "tags"
        | "assignments"
        | "snapshot"
        | "items"
        | "variables"
        | "concept"
        | "pricing_options"
    )[]

    Specific fields to include in response (omit for all fields). The 'concept' value returns both concept_id and concept_name.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties