@adcp/client API Reference - v3.3.3
    Preparing search index...

    Interface FormatID

    Structured format identifier with agent URL and format name. Can reference: (1) a concrete format with fixed dimensions (id only), (2) a template format without parameters (id only), or (3) a template format with parameters (id + dimensions/duration). Template formats accept parameters in format_id while concrete formats have fixed dimensions in their definition. Parameterized format IDs create unique, specific format variants.

    interface FormatID {
        agent_url: string;
        id: string;
        width?: number;
        height?: number;
        duration_ms?: number;
    }
    Index

    Properties

    agent_url id width? height? duration_ms?

    Properties

    agent_url: string

    URL of the agent that defines this format (e.g., 'https://creatives.adcontextprotocol.org' for standard formats, or 'https://publisher.com/.well-known/adcp/sales' for custom formats)

    id: string

    Format identifier within the agent's namespace (e.g., 'display_static', 'video_hosted', 'audio_standard'). When used alone, references a template format. When combined with dimension/duration fields, creates a parameterized format ID for a specific variant.

    width?: number

    Width in pixels for visual formats. When specified, height must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.

    height?: number

    Height in pixels for visual formats. When specified, width must also be specified. Both fields together create a parameterized format ID for dimension-specific variants.

    duration_ms?: number

    Duration in milliseconds for time-based formats (video, audio). When specified, creates a parameterized format ID. Omit to reference a template format without parameters.

    Settings

    Member Visibility

    On This Page

    Properties