@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface CreativeAsset

    Creative asset for upload to library - supports static assets, generative formats, and third-party snippets

    interface CreativeAsset {
        creative_id: string;
        name: string;
        format_id: FormatID;
        assets: {
            [k: string]:
                | Catalog
                | VASTAsset
                | DAASTAsset
                | CreativeBrief
                | ImageAsset
                | VideoAsset
                | AudioAsset
                | TextAsset
                | URLAsset
                | HTMLAsset
                | JavaScriptAsset
                | WebhookAsset
                | CSSAsset
                | MarkdownAsset;
        };
        inputs?: {
            name: string;
            macros?: { [k: string]: string
            | undefined };
            context_description?: string;
        }[];
        tags?: string[];
        status?: CreativeStatus;
        weight?: number;
        placement_ids?: string[];
        provenance?: Provenance;
    }
    Index

    Properties

    creative_id name format_id assets inputs? tags? status? weight? placement_ids? provenance?

    Properties

    creative_id: string

    Unique identifier for the creative

    name: string

    Human-readable creative name

    format_id: FormatID
    assets: {
        [k: string]:
            | Catalog
            | VASTAsset
            | DAASTAsset
            | CreativeBrief
            | ImageAsset
            | VideoAsset
            | AudioAsset
            | TextAsset
            | URLAsset
            | HTMLAsset
            | JavaScriptAsset
            | WebhookAsset
            | CSSAsset
            | MarkdownAsset;
    }

    Assets required by the format, keyed by asset_id

    Type Declaration

    inputs?: {
        name: string;
        macros?: { [k: string]: string | undefined };
        context_description?: string;
    }[]

    Preview contexts for generative formats - defines what scenarios to generate previews for

    Type Declaration

    • name: string

      Human-readable name for this preview variant

    • Optionalmacros?: { [k: string]: string | undefined }

      Macro values to apply for this preview

    • Optionalcontext_description?: string

      Natural language description of the context for AI-generated content

    tags?: string[]

    User-defined tags for organization and searchability

    status?: CreativeStatus
    weight?: number

    Optional delivery weight for creative rotation when uploading via create_media_buy or update_media_buy (0-100). If omitted, platform determines rotation. Only used during upload to media buy - not stored in creative library.

    placement_ids?: string[]

    Optional array of placement IDs where this creative should run when uploading via create_media_buy or update_media_buy. References placement_id values from the product's placements array. If omitted, creative runs on all placements. Only used during upload to media buy - not stored in creative library.

    provenance?: Provenance

    Settings

    Member Visibility

    On This Page

    Properties