@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Interface LegacyCreativeFilters

    Filter criteria for querying creatives from a creative library. By default, archived creatives are excluded from results. To include archived creatives, explicitly filter by status='archived' or include 'archived' in the statuses array.

    interface LegacyCreativeFilters {
        accounts?: [AccountReference, ...AccountReference[]];
        statuses?: [CreativeStatus, ...CreativeStatus[]];
        tags?: [string, ...string[]];
        tags_any?: [string, ...string[]];
        name_contains?: string;
        creative_ids?: [string, ...string[]];
        created_after?: string;
        created_before?: string;
        updated_after?: string;
        updated_before?: string;
        assigned_to_packages?: [string, ...string[]];
        media_buy_ids?: [string, ...string[]];
        unassigned?: boolean;
        has_served?: boolean;
        indicator_types?: [IndicatorType, ...IndicatorType[]];
        concept_ids?: [string, ...string[]];
        format_ids?: [
            LegacyFormatReferenceStructuredObject,
            ...LegacyFormatReferenceStructuredObject[],
        ];
        format_kinds?: [CanonicalFormatKind, ...CanonicalFormatKind[]];
        asset_types?: [AssetContentType, ...AssetContentType[]];
        has_variables?: boolean;
        ext?: ExtensionObject;
    }
    Index

    Properties

    accounts? statuses? tags? tags_any? name_contains? creative_ids? created_after? created_before? updated_after? updated_before? assigned_to_packages? media_buy_ids? unassigned? has_served? indicator_types? concept_ids? format_ids? format_kinds? asset_types? has_variables? ext?

    Properties

    accounts?: [AccountReference, ...AccountReference[]]

    Filter creatives by owning accounts. Useful for agencies managing multiple client accounts.

    1

    statuses?: [CreativeStatus, ...CreativeStatus[]]

    Filter by creative approval statuses

    1

    tags?: [string, ...string[]]

    Filter by creative tags (all tags must match)

    1

    tags_any?: [string, ...string[]]

    Filter by creative tags (any tag must match)

    1

    name_contains?: string

    Filter by creative names containing this text (case-insensitive)

    creative_ids?: [string, ...string[]]

    Filter by specific creative IDs

    1

    100

    created_after?: string

    Filter creatives created after this date (ISO 8601)

    created_before?: string

    Filter creatives created before this date (ISO 8601)

    updated_after?: string

    Filter creatives last updated after this date (ISO 8601)

    updated_before?: string

    Filter creatives last updated before this date (ISO 8601)

    assigned_to_packages?: [string, ...string[]]

    Filter creatives assigned to any of these packages. Sales-agent-specific — standalone creative agents SHOULD ignore this filter.

    1

    media_buy_ids?: [string, ...string[]]

    Filter creatives assigned to any of these media buys. Sales-agent-specific — standalone creative agents SHOULD ignore this filter.

    1

    unassigned?: boolean

    Filter for unassigned creatives when true, assigned creatives when false. Sales-agent-specific — standalone creative agents SHOULD ignore this filter.

    has_served?: boolean

    When true, return only creatives that have served at least one impression. When false, return only creatives that have never served.

    indicator_types?: [IndicatorType, ...IndicatorType[]]

    Return creatives with at least one package assignment carrying any requested current indicator type. Values within this field use OR logic; this field composes with other filters using AND logic. Sales-agent-specific: sellers support this filter only when media_buy.relationship_notifications.projection_tasks includes list_creatives. Other agents SHOULD ignore it and apply remaining filters. Buyers needing exact results MUST verify capability support and paginate the outer result set; assignment_projection: matching bounds nested rows.

    1

    concept_ids?: [string, ...string[]]

    Filter by creative concept IDs. Concepts group related creatives across sizes and formats (e.g., Flashtalking concepts, Celtra campaign folders, CM360 creative groups).

    1

    format_ids?: [
        LegacyFormatReferenceStructuredObject,
        ...LegacyFormatReferenceStructuredObject[],
    ]

    Deprecated in AdCP 3.2; removed in AdCP 4.0. Filter legacy named-format creatives. Use format_kinds for canonical libraries.

    1

    format_kinds?: [CanonicalFormatKind, ...CanonicalFormatKind[]]

    Filter by canonical format kinds. Returns creatives matching any supplied kind.

    1

    asset_types?: [AssetContentType, ...AssetContentType[]]

    Filter by asset types present on direct object values in the creative's top-level assets map. A creative matches when any directly assigned object has an asset_type in this array (OR within this field); this filter is conjunctive with every other active filter (AND across fields). Do not inspect array-valued slots or recurse into nested asset fields such as cards[].media; broader traversal is deferred. Agents that do not implement this filter MUST ignore it and apply the remaining filters rather than reject the request. Exact asset-type values use the shared AssetContentType vocabulary; published_post selects existing-published-post reference creatives without relying on publisher-specific format IDs.

    1

    has_variables?: boolean

    When true, return only creatives with dynamic variables (DCO). When false, return only static creatives.

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties