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

    Interface ListCreativeFormatsRequest

    Request parameters for discovering supported creative formats

    interface ListCreativeFormatsRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        format_ids?: FormatReferenceStructuredObject[];
        asset_types?: AssetContentType[];
        max_width?: number;
        max_height?: number;
        min_width?: number;
        min_height?: number;
        is_responsive?: boolean;
        name_search?: string;
        publisher_domain?: string;
        property_id?: string;
        wcag_level?: WCAGLevel;
        disclosure_positions?: DisclosurePosition[];
        disclosure_persistence?: DisclosurePersistence[];
        output_format_ids?: FormatReferenceStructuredObject[];
        input_format_ids?: FormatReferenceStructuredObject[];
        pagination?: PaginationRequest;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    format_ids?: FormatReferenceStructuredObject[]

    Return only these specific format IDs (e.g., from get_products response)

    asset_types?: AssetContentType[]

    Filter to formats that include these asset types. For third-party tags, search for 'html' or 'javascript'. For published-post reference formats, search for 'published_post'. E.g., ['image', 'text'] returns formats with images and text, ['javascript'] returns formats accepting JavaScript tags.

    max_width?: number

    Maximum width in pixels (inclusive). Returns formats where ANY render has width <= this value. For multi-render formats, matches if at least one render fits.

    max_height?: number

    Maximum height in pixels (inclusive). Returns formats where ANY render has height <= this value. For multi-render formats, matches if at least one render fits.

    min_width?: number

    Minimum width in pixels (inclusive). Returns formats where ANY render has width >= this value.

    min_height?: number

    Minimum height in pixels (inclusive). Returns formats where ANY render has height >= this value.

    is_responsive?: boolean

    Filter for responsive formats that adapt to container size. When true, returns formats without fixed dimensions.

    name_search?: string

    Search for formats by name (case-insensitive partial match)

    publisher_domain?: string

    Filter to formats supported by the named publisher. Agents resolve via the three-tier order documented in docs/creative/canonical-formats.mdx#format-discovery (publisher's hosted adagents.json → AAO community mirror → agent-derived from own products' format_options). All fetches in the chain MUST follow the same transport contract as format_schema (https-only, SSRF guards, ≤5s timeout, 1 MiB cap, no redirects — see static/schemas/source/core/product-format-declaration.json#format_schema). Response carries source: "publisher" | "aao_mirror" | "agent_derived" so buyers know which tier produced the list. The pattern below is a syntactic floor — NOT an SSRF guard; agents MUST resolve the hostname and reject private/loopback/link-local/metadata IPs before fetching.

    ^a-z0-9?(.a-z0-9?)*$

    property_id?: string
    wcag_level?: WCAGLevel
    disclosure_positions?: DisclosurePosition[]

    Filter to formats that support all of these disclosure positions. When a format has disclosure_capabilities, match against those positions. Otherwise fall back to supported_disclosure_positions. Use to find formats compatible with a brief's compliance requirements.

    disclosure_persistence?: DisclosurePersistence[]

    Filter to formats where each requested persistence mode is supported by at least one position in disclosure_capabilities. Different positions may satisfy different modes. Use to find formats compatible with jurisdiction-specific persistence requirements (e.g., continuous for EU AI Act).

    output_format_ids?: FormatReferenceStructuredObject[]

    Filter to formats whose output_format_ids includes any of these format IDs. Returns formats that can produce these outputs — inspect each result's input_format_ids to see what inputs they accept.

    input_format_ids?: FormatReferenceStructuredObject[]

    Filter to formats whose input_format_ids includes any of these format IDs. Returns formats that accept these creatives as input — inspect each result's output_format_ids to see what they can produce.

    pagination?: PaginationRequest
    context?: ContextObject
    ext?: ExtensionObject