@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface PlacementPresentationDocument

    Declarative, non-executable placement frame. Consumers create the canvas, paint behind_creative decorations in array order, fit and clip the selected creative render into creative_slot, then paint in_front_of_creative decorations in array order. Text is plain text and image assets are immutable, digest-pinned resources; scripts, HTML, CSS, event handlers, and arbitrary style properties are forbidden.

    interface PlacementPresentationDocument {
        schema_version: "1.0";
        canvas: { width: number; height: number; background_color?: string };
        creative_slot: {
            x: number;
            y: number;
            width: number;
            height: number;
            fit: "contain" | "cover" | "stretch";
            clip: true;
        };
        decorations?: (BoxDecoration | TextDecoration | ImageDecoration)[];
    }
    Index
    schema_version: "1.0"
    canvas: { width: number; height: number; background_color?: string }

    Type Declaration

    • width: number

      1

      8192

      int

    • height: number

      1

      8192

      int

    • Optionalbackground_color?: string

      ^#[0-9A-Fa-f]{6}$

    creative_slot: {
        x: number;
        y: number;
        width: number;
        height: number;
        fit: "contain" | "cover" | "stretch";
        clip: true;
    }

    Rectangle into which the selected creative render is fitted and clipped without changing its manifest or renderer.

    Type Declaration

    • x: number

      0

      8192

      int

    • y: number

      0

      8192

      int

    • width: number

      1

      8192

      int

    • height: number

      1

      8192

      int

    • fit: "contain" | "cover" | "stretch"

      How the creative render is scaled into the slot. contain preserves the whole render, cover fills and crops, and stretch fills without preserving aspect ratio.

    • clip: true

      Slot overflow is always clipped so composition is deterministic.

    decorations?: (BoxDecoration | TextDecoration | ImageDecoration)[]

    100