@adcp/client API Reference - v4.19.0
    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: PaginationResponse;
        creatives: {
            creative_id: string;
            account?: Account;
            name: string;
            format_id: FormatID;
            status: CreativeStatus;
            created_date: string;
            updated_date: string;
            assets?: {
                [k: string]: | Catalog
                | VASTAsset
                | DAASTAsset
                | CreativeBrief
                | ImageAsset
                | VideoAsset
                | AudioAsset
                | TextAsset
                | URLAsset
                | HTMLAsset
                | JavaScriptAsset
                | WebhookAsset
                | CSSAsset
                | MarkdownAsset;
            };
            tags?: string[];
            concept_id?: string;
            concept_name?: string;
            variables?: CreativeVariable[];
            assignments?: {
                assignment_count: number;
                assigned_packages?: { package_id: string; assigned_date: string }[];
            };
            snapshot?: {
                as_of: string;
                staleness_seconds: number;
                impressions: number;
                last_served?: string;
            };
            snapshot_unavailable_reason?: | "SNAPSHOT_UNSUPPORTED"
            | "SNAPSHOT_TEMPORARILY_UNAVAILABLE"
            | "SNAPSHOT_PERMISSION_DENIED";
            items?: CreativeItem[];
        }[];
        format_summary?: { [k: string]: number
        | undefined };
        status_summary?: {
            processing?: number;
            approved?: number;
            pending_review?: number;
            rejected?: number;
            archived?: number;
        };
        errors?: Error[];
        sandbox?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    query_summary pagination creatives format_summary? status_summary? errors? sandbox? 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: PaginationResponse
    creatives: {
        creative_id: string;
        account?: Account;
        name: string;
        format_id: FormatID;
        status: CreativeStatus;
        created_date: string;
        updated_date: string;
        assets?: {
            [k: string]:
                | Catalog
                | VASTAsset
                | DAASTAsset
                | CreativeBrief
                | ImageAsset
                | VideoAsset
                | AudioAsset
                | TextAsset
                | URLAsset
                | HTMLAsset
                | JavaScriptAsset
                | WebhookAsset
                | CSSAsset
                | MarkdownAsset;
        };
        tags?: string[];
        concept_id?: string;
        concept_name?: string;
        variables?: CreativeVariable[];
        assignments?: {
            assignment_count: number;
            assigned_packages?: { package_id: string; assigned_date: string }[];
        };
        snapshot?: {
            as_of: string;
            staleness_seconds: number;
            impressions: number;
            last_served?: string;
        };
        snapshot_unavailable_reason?: | "SNAPSHOT_UNSUPPORTED"
        | "SNAPSHOT_TEMPORARILY_UNAVAILABLE"
        | "SNAPSHOT_PERMISSION_DENIED";
        items?: CreativeItem[];
    }[]

    Array of creative assets matching the query

    Type Declaration

    • creative_id: string

      Unique identifier for the creative

    • Optionalaccount?: Account
    • name: string

      Human-readable creative name

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

      When the creative was created

    • updated_date: string

      When the creative was last modified

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

      Assets for this creative, keyed by asset_id

    • Optionaltags?: string[]

      User-defined tags for organization and searchability

    • Optionalconcept_id?: string

      Creative concept this creative belongs to. Concepts group related creatives across sizes and formats.

    • Optionalconcept_name?: string

      Human-readable concept name

    • Optionalvariables?: CreativeVariable[]

      Dynamic content variables (DCO slots) for this creative. Included when include_variables=true.

    • Optionalassignments?: {
          assignment_count: number;
          assigned_packages?: { package_id: string; assigned_date: string }[];
      }

      Current package assignments (included when include_assignments=true)

      • assignment_count: number

        Total number of active package assignments

      • Optionalassigned_packages?: { package_id: string; assigned_date: string }[]

        List of packages this creative is assigned to

    • Optionalsnapshot?: {
          as_of: string;
          staleness_seconds: number;
          impressions: number;
          last_served?: string;
      }

      Lightweight delivery snapshot (included when include_snapshot=true). For detailed performance analytics, use get_creative_delivery.

      • as_of: string

        When this snapshot was captured by the platform

      • staleness_seconds: number

        Maximum age of this data in seconds. For example, 3600 means the data may be up to 1 hour old.

      • impressions: number

        Lifetime impressions across all assignments. Not scoped to any date range.

      • Optionallast_served?: string

        Last time this creative served an impression. Absent when the creative has never served.

    • Optionalsnapshot_unavailable_reason?:
          | "SNAPSHOT_UNSUPPORTED"
          | "SNAPSHOT_TEMPORARILY_UNAVAILABLE"
          | "SNAPSHOT_PERMISSION_DENIED"

      Machine-readable reason the snapshot is omitted. Present only when include_snapshot was true and snapshot data is unavailable for this creative.

    • Optionalitems?: CreativeItem[]

      Items for multi-asset formats like carousels and native ads (included when include_items=true)

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

    Breakdown of creatives by format. Keys are agent-defined format identifiers, optionally including dimensions (e.g., 'display_static_300x250', 'video_30s_vast'). Key construction is platform-specific — there is no required format.

    Type Declaration

    • [k: string]: number | undefined

      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?: {
        processing?: number;
        approved?: number;
        pending_review?: number;
        rejected?: number;
        archived?: number;
    }

    Breakdown of creatives by status

    Type Declaration

    • Optionalprocessing?: number

      Number of creatives being processed

    • 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

    errors?: Error[]

    Task-specific errors (e.g., invalid filters, account not found)

    sandbox?: boolean

    When true, this response contains simulated data from sandbox mode.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties