@adcp/client API Reference - v3.3.3
    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: FormatID1;
        assets: {
            [k: string]:
                | ImageAsset
                | VideoAsset
                | VASTAsset
                | DAASTAsset
                | AudioAsset
                | TextAsset
                | HTMLAsset
                | CSSAsset
                | JavaScriptAsset
                | PromotedOfferings
                | URLAsset;
        };
        inputs?: {
            name: string;
            macros?: { [k: string]: string };
            context_description?: string;
        }[];
        tags?: string[];
        approved?: boolean;
        weight?: number;
        placement_ids?: [string, ...string[]];
    }
    Index

    Properties

    creative_id name format_id assets inputs? tags? approved? weight? placement_ids?

    Properties

    creative_id: string

    Unique identifier for the creative

    name: string

    Human-readable creative name

    format_id: FormatID1
    assets: {
        [k: string]:
            | ImageAsset
            | VideoAsset
            | VASTAsset
            | DAASTAsset
            | AudioAsset
            | TextAsset
            | HTMLAsset
            | CSSAsset
            | JavaScriptAsset
            | PromotedOfferings
            | URLAsset;
    }

    Assets required by the format, keyed by asset_role

    Type Declaration

    • [k: string]:
          | ImageAsset
          | VideoAsset
          | VASTAsset
          | DAASTAsset
          | AudioAsset
          | TextAsset
          | HTMLAsset
          | CSSAsset
          | JavaScriptAsset
          | PromotedOfferings
          | URLAsset

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

    inputs?: {
        name: string;
        macros?: { [k: string]: string };
        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 }

      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

    approved?: boolean

    For generative creatives: set to true to approve and finalize, false to request regeneration with updated assets/message. Omit for non-generative creatives.

    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, ...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.

    1

    Settings

    Member Visibility

    On This Page

    Properties