@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface PreviewCreativeSingleResponse

    Single preview response - each preview URL returns an HTML page that can be embedded in an iframe

    interface PreviewCreativeSingleResponse {
        response_type: "single";
        previews: {
            preview_id: string;
            renders: PreviewRender[];
            input: {
                name: string;
                macros?: { [k: string]: string | undefined };
                context_description?: string;
            };
        }[];
        interactive_url?: string;
        expires_at?: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    response_type previews interactive_url? expires_at? context? ext?

    Properties

    response_type: "single"

    Discriminator indicating this is a single preview response

    previews: {
        preview_id: string;
        renders: PreviewRender[];
        input: {
            name: string;
            macros?: { [k: string]: string | undefined };
            context_description?: string;
        };
    }[]

    Array of preview variants. Each preview corresponds to an input set from the request. If no inputs were provided, returns a single default preview.

    Type Declaration

    • preview_id: string

      Unique identifier for this preview variant

    • renders: PreviewRender[]

      Array of rendered pieces for this preview variant. Most formats render as a single piece. Companion ad formats (video + banner), multi-placement formats, and adaptive formats render as multiple pieces.

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

      The input parameters that generated this preview variant. Echoes back the request input or shows defaults used.

      • name: string

        Human-readable name for this variant

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

        Macro values applied to this variant

      • Optionalcontext_description?: string

        Context description applied to this variant

    interactive_url?: string

    Optional URL to an interactive testing page that shows all preview variants with controls to switch between them, modify macro values, and test different scenarios.

    expires_at?: string

    ISO 8601 timestamp when preview links expire. Optional. Omit when preview URLs do not expire (some creative agents serve perpetually-valid preview URLs — e.g., signed asset URLs with no TTL, or session-scoped previews that the agent retires explicitly via revocation). When present, consumers MUST treat the URLs as invalid after this timestamp; when omitted, consumers MAY assume the preview URLs are valid until the creative agent revokes them out-of-band (no protocol-level revocation signal exists in 3.x — buyers requiring expiry guarantees SHOULD require sellers that publish expires_at).

    date-time

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties