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

    Interface Overlay

    A publisher-controlled element that renders on top of buyer creative content within the ad placement. Creative agents should avoid placing critical content (CTAs, logos, key copy) within overlay bounds.

    interface Overlay {
        id: string;
        description?: string;
        visual?: { url?: string; light?: string; dark?: string };
        bounds: {
            x: number;
            y: number;
            width: number;
            height: number;
            unit: "px" | "fraction" | "inches" | "cm" | "mm" | "pt";
        };
    }
    Index

    Properties

    id description? visual? bounds

    Properties

    id: string

    Identifier for this overlay (e.g., 'play_pause', 'volume', 'publisher_logo', 'carousel_prev', 'carousel_next')

    description?: string

    Human-readable explanation of what this overlay is and how buyers should account for it

    visual?: { url?: string; light?: string; dark?: string }

    Optional visual reference for this overlay element. Useful for creative agents compositing previews and for buyers understanding what will appear over their content. Must include at least one of: url, light, or dark.

    Type Declaration

    • Optionalurl?: string

      URL to a theme-neutral overlay graphic (SVG or PNG). Use when a single file works for all backgrounds, e.g. an SVG using CSS custom properties or currentColor.

    • Optionallight?: string

      URL to the overlay graphic for use on light/bright backgrounds (SVG or PNG)

    • Optionaldark?: string

      URL to the overlay graphic for use on dark backgrounds (SVG or PNG)

    bounds: {
        x: number;
        y: number;
        width: number;
        height: number;
        unit: "px" | "fraction" | "inches" | "cm" | "mm" | "pt";
    }

    Position and size of the overlay relative to the asset's own top-left corner. See 'unit' for coordinate interpretation.

    Type Declaration

    • x: number

      Horizontal offset from the asset's left edge

    • y: number

      Vertical offset from the asset's top edge

    • width: number

      Width of the overlay

    • height: number

      Height of the overlay

    • unit: "px" | "fraction" | "inches" | "cm" | "mm" | "pt"

      'px' = absolute pixels from asset top-left. 'fraction' = proportional to asset dimensions (0.0 = edge, 1.0 = opposite edge). 'inches', 'cm', 'mm', 'pt' (1/72 inch) = physical units for print overlays, measured from asset top-left.

    Settings

    Member Visibility

    On This Page

    Properties