@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Interface ZipAsset

    Bundled creative asset delivered as a zip archive — typically an HTML5 banner with index.html plus supporting CSS, JS, images, and fonts. Receivers unpack the zip, validate internal structure, and serve contents from CDN. Distinct from inline HTML (html asset) and from third-party tag URLs (url asset with url_type tracker_script).

    interface ZipAsset {
        asset_type: "zip";
        url: string;
        max_file_size_kb?: number;
        entry_point?: string;
        allowed_inner_extensions?: string[];
        backup_image_url?: string;
        digest?: string;
        accessibility?: {
            alt_text?: string;
            keyboard_navigable?: boolean;
            motion_control?: boolean;
            screen_reader_tested?: boolean;
        };
        provenance?: Provenance;
    }
    Index

    Properties

    asset_type url max_file_size_kb? entry_point? allowed_inner_extensions? backup_image_url? digest? accessibility? provenance?

    Properties

    asset_type: "zip"

    Discriminator identifying this as a zip-bundled asset. See /schemas/creative/asset-types for the registry.

    url: string

    URL where the zip archive is hosted. Must be HTTPS.

    max_file_size_kb?: number

    Maximum file size in kilobytes. Receivers should reject zips exceeding this.

    Optionalentry_point

    entry_point?: string

    Relative path to the entry file within the zip (typically 'index.html'). Receivers default to 'index.html' if absent.

    allowed_inner_extensions?: string[]

    File extensions permitted inside the zip (e.g., ['html', 'css', 'js', 'png', 'jpg', 'svg', 'webp', 'json', 'woff2']). Receivers may reject zips containing other extensions.

    backup_image_url?: string

    Fallback image URL for environments that cannot render the bundled creative (e.g., non-HTML5 endpoints, ad blockers). Recommended for HTML5 banners.

    digest?: string

    Optional SHA-256 content digest of the zip archive (sha256:) for integrity verification. Lets receivers detect tampered or stale archives.

    accessibility?: {
        alt_text?: string;
        keyboard_navigable?: boolean;
        motion_control?: boolean;
        screen_reader_tested?: boolean;
    }

    Self-declared accessibility properties for this opaque creative

    Type Declaration

    • Optionalalt_text?: string

      Text alternative describing the creative content

    • Optionalkeyboard_navigable?: boolean

      Whether the creative can be fully operated via keyboard

    • Optionalmotion_control?: boolean

      Whether the creative respects prefers-reduced-motion or provides pause/stop controls

    • Optionalscreen_reader_tested?: boolean

      Whether the creative has been tested with screen readers

    provenance?: Provenance

    Settings

    Member Visibility

    On This Page

    Properties