@adcp/sdk API Reference - v10.0.1
    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_version?: string;
        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;
        include_purged?: boolean;
        include_webhook_activity?: boolean;
        webhook_activity_limit?: number;
        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_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: 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.

    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.

    include_purged?: boolean

    Include soft-purged creative tombstones in the result set. When true, creatives destroyed via creative.purged with purge_kind: soft surface as tombstone records carrying purged: true, purged_at, and the purge reason — within the seller's webhook activity retention window (30 days from purged_at, MUST match webhook-activity-record retention). Hard-purged creatives MUST NOT appear regardless of this flag. When false or omitted, the result set excludes all purged creatives — same default as today.

    include_webhook_activity?: boolean

    Include recent webhook activity per creative. When true, each returned creative carries a webhook_activity[] array of the most recent fires scoped to that creative — creative.status_changed and creative.purged deliveries. Adoption of the webhook_activity[] pattern per snapshot-and-log.mdx § Webhook activity log pattern. Retention is 30 days from completed_at (MUST). Three-state presence applies: omitted = seller does not surface; [] = persists but no recent fires; non-empty = actual records.

    webhook_activity_limit?: number

    Maximum number of webhook_activity[] records to return per creative. Only meaningful when include_webhook_activity: true. Sellers MUST respect the cap; structural enforcement is provided by the response schema's maxItems: 200 on the array.

    1

    200

    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