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

    Interface V2ProductFormatDeclaration

    v2 ProductFormatDeclaration. The params object is canonical-specific and stays loose at this layer — the projection algorithm reads only format_kind, v1_format_ref, and canonical_formats_only. Width / height (for image canonicals) are surfaced as optional top-level fields the registry reverse-lookup can read without unwrapping params.

    interface V2ProductFormatDeclaration {
        format_kind: CanonicalFormatKind;
        params: Record<string, unknown>;
        capability_id?: string;
        format_option_id?: string;
        publisher_domain?: string;
        display_name?: string;
        seller_preference?: "preferred" | "accepted" | "discouraged";
        applies_to_channels?: string[];
        canonical_formats_only?: boolean;
        experimental?: boolean;
        format_shape?: string;
        v1_format_ref?: V1FormatId[];
        format_schema?: { uri: string; digest: string };
    }
    Index

    Properties

    format_kind params capability_id? format_option_id? publisher_domain? display_name? seller_preference? applies_to_channels? canonical_formats_only? experimental? format_shape? v1_format_ref? format_schema?

    Properties

    format_kind: CanonicalFormatKind
    params: Record<string, unknown>
    capability_id?: string
    format_option_id?: string
    publisher_domain?: string
    display_name?: string
    seller_preference?: "preferred" | "accepted" | "discouraged"
    applies_to_channels?: string[]
    canonical_formats_only?: boolean
    experimental?: boolean
    format_shape?: string
    v1_format_ref?: V1FormatId[]

    Authoritative v2 → v1 link. Always an array (3.1-beta normative): single-ref is [{...}], multi-size carries one entry per size. v1-only buyers see every entry via format_ids[] dual-emission. When v1_format_ref.length < params.sizes.length, SDKs emit FORMAT_DECLARATION_V1_LOSSY_MULTI_SIZE to signal incomplete coverage.

    format_schema?: { uri: string; digest: string }

    Settings

    Member Visibility

    On This Page

    Properties