@adcp/client API Reference - v3.3.3
    Preparing search index...

    Interface ListCreativesRequest

    Request parameters for querying creative assets from the centralized library with filtering, sorting, and pagination

    interface ListCreativesRequest {
        filters?: CreativeFilters;
        sort?: { field?: CreativeSortField; direction?: SortDirection };
        pagination?: { limit?: number; offset?: number };
        include_assignments?: boolean;
        include_performance?: boolean;
        include_sub_assets?: boolean;
        fields?: (
            | "format"
            | "creative_id"
            | "name"
            | "tags"
            | "created_date"
            | "updated_date"
            | "status"
            | "assignments"
            | "performance"
            | "sub_assets"
        )[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    filters? sort? pagination? include_assignments? include_performance? include_sub_assets? fields? context? ext?

    Properties

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

    Sorting parameters

    pagination?: { limit?: number; offset?: number }

    Pagination parameters

    Type Declaration

    • Optionallimit?: number

      Maximum number of creatives to return

    • Optionaloffset?: number

      Number of creatives to skip

    include_assignments?: boolean

    Include package assignment information in response

    include_performance?: boolean

    Include aggregated performance metrics in response

    include_sub_assets?: boolean

    Include sub-assets (for carousel/native formats) in response

    fields?: (
        | "format"
        | "creative_id"
        | "name"
        | "tags"
        | "created_date"
        | "updated_date"
        | "status"
        | "assignments"
        | "performance"
        | "sub_assets"
    )[]

    Specific fields to include in response (omit for all fields)

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties