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

    Interface ListCreativesResponse

    Response from creative library query with filtered results, metadata, and optional enriched data

    interface ListCreativesResponse {
        query_summary: {
            total_matching: number;
            returned: number;
            filters_applied?: string[];
            sort_applied?: { field?: string; direction?: SortDirection };
        };
        pagination: {
            limit: number;
            offset: number;
            has_more: boolean;
            total_pages?: number;
            current_page?: number;
        };
        creatives: {
            creative_id: string;
            name: string;
            format_id: FormatID;
            status: CreativeStatus;
            created_date: string;
            updated_date: string;
            assets?: {
                [k: string]: | ImageAsset
                | VideoAsset
                | VASTAsset
                | DAASTAsset
                | AudioAsset
                | TextAsset
                | HTMLAsset
                | CSSAsset
                | JavaScriptAsset
                | PromotedOfferings
                | URLAsset;
            };
            tags?: string[];
            assignments?: {
                assignment_count: number;
                assigned_packages?: {
                    package_id: string;
                    package_name?: string;
                    assigned_date: string;
                    status: "active"
                    | "paused"
                    | "ended";
                }[];
            };
            performance?: {
                impressions?: number;
                clicks?: number;
                ctr?: number;
                conversion_rate?: number;
                performance_score?: number;
                last_updated: string;
            };
            sub_assets?: SubAsset[];
        }[];
        format_summary?: { [k: string]: number };
        status_summary?: {
            approved?: number;
            pending_review?: number;
            rejected?: number;
            archived?: number;
        };
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    query_summary pagination creatives format_summary? status_summary? context? ext?

    Properties

    query_summary: {
        total_matching: number;
        returned: number;
        filters_applied?: string[];
        sort_applied?: { field?: string; direction?: SortDirection };
    }

    Summary of the query that was executed

    Type Declaration

    • total_matching: number

      Total number of creatives matching filters (across all pages)

    • returned: number

      Number of creatives returned in this response

    • Optionalfilters_applied?: string[]

      List of filters that were applied to the query

    • Optionalsort_applied?: { field?: string; direction?: SortDirection }

      Sort order that was applied

    pagination: {
        limit: number;
        offset: number;
        has_more: boolean;
        total_pages?: number;
        current_page?: number;
    }

    Pagination information for navigating results

    Type Declaration

    • limit: number

      Maximum number of results requested

    • offset: number

      Number of results skipped

    • has_more: boolean

      Whether more results are available

    • Optionaltotal_pages?: number

      Total number of pages available

    • Optionalcurrent_page?: number

      Current page number (1-based)

    creatives: {
        creative_id: string;
        name: string;
        format_id: FormatID;
        status: CreativeStatus;
        created_date: string;
        updated_date: string;
        assets?: {
            [k: string]:
                | ImageAsset
                | VideoAsset
                | VASTAsset
                | DAASTAsset
                | AudioAsset
                | TextAsset
                | HTMLAsset
                | CSSAsset
                | JavaScriptAsset
                | PromotedOfferings
                | URLAsset;
        };
        tags?: string[];
        assignments?: {
            assignment_count: number;
            assigned_packages?: {
                package_id: string;
                package_name?: string;
                assigned_date: string;
                status: "active"
                | "paused"
                | "ended";
            }[];
        };
        performance?: {
            impressions?: number;
            clicks?: number;
            ctr?: number;
            conversion_rate?: number;
            performance_score?: number;
            last_updated: string;
        };
        sub_assets?: SubAsset[];
    }[]

    Array of creative assets matching the query

    Type Declaration

    • creative_id: string

      Unique identifier for the creative

    • name: string

      Human-readable creative name

    • format_id: FormatID
    • status: CreativeStatus
    • created_date: string

      When the creative was uploaded to the library

    • updated_date: string

      When the creative was last modified

    • Optionalassets?: {
          [k: string]:
              | ImageAsset
              | VideoAsset
              | VASTAsset
              | DAASTAsset
              | AudioAsset
              | TextAsset
              | HTMLAsset
              | CSSAsset
              | JavaScriptAsset
              | PromotedOfferings
              | URLAsset;
      }

      Assets for this creative, keyed by asset_role

    • Optionaltags?: string[]

      User-defined tags for organization and searchability

    • Optionalassignments?: {
          assignment_count: number;
          assigned_packages?: {
              package_id: string;
              package_name?: string;
              assigned_date: string;
              status: "active" | "paused" | "ended";
          }[];
      }

      Current package assignments (included when include_assignments=true)

      • assignment_count: number

        Total number of active package assignments

      • Optionalassigned_packages?: {
            package_id: string;
            package_name?: string;
            assigned_date: string;
            status: "active" | "paused" | "ended";
        }[]

        List of packages this creative is assigned to

    • Optionalperformance?: {
          impressions?: number;
          clicks?: number;
          ctr?: number;
          conversion_rate?: number;
          performance_score?: number;
          last_updated: string;
      }

      Aggregated performance metrics (included when include_performance=true)

      • Optionalimpressions?: number

        Total impressions across all assignments

      • Optionalclicks?: number

        Total clicks across all assignments

      • Optionalctr?: number

        Click-through rate (clicks/impressions)

      • Optionalconversion_rate?: number

        Conversion rate across all assignments

      • Optionalperformance_score?: number

        Aggregated performance score (0-100)

      • last_updated: string

        When performance data was last updated

    • Optionalsub_assets?: SubAsset[]

      Sub-assets for multi-asset formats (included when include_sub_assets=true)

    format_summary?: { [k: string]: number }

    Breakdown of creatives by format type

    Type Declaration

    • [k: string]: number

      Number of creatives with this format

      This interface was referenced by undefined's JSON-Schema definition via the patternProperty "^[a-zA-Z0-9_-]+$".

    status_summary?: {
        approved?: number;
        pending_review?: number;
        rejected?: number;
        archived?: number;
    }

    Breakdown of creatives by status

    Type Declaration

    • Optionalapproved?: number

      Number of approved creatives

    • Optionalpending_review?: number

      Number of creatives pending review

    • Optionalrejected?: number

      Number of rejected creatives

    • Optionalarchived?: number

      Number of archived creatives

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties