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

    Type Alias VASTAsset

    VASTAsset: {
        asset_type: "vast";
        vast_version?: VASTVersion;
        vpaid_enabled?: boolean;
        duration_ms?: number;
        tracking_events?: VASTTrackingEvent[];
        captions_url?: string;
        audio_description_url?: string;
        provenance?: Provenance;
    } & (
        | { delivery_type: "url"; url: string }
        | { delivery_type: "inline"; content: string }
    )

    VAST (Video Ad Serving Template) tag for third-party video ad serving. Unlike the hosted video asset, a VAST tag carries no width/height: a VAST response can return multiple renditions of differing dimensions, and the player selects one per device at serve time, so there is no single width/height for the ad. Dimensional, duration, and codec constraints for a placement live on the format/requirements layer, not on this asset.

    Type Declaration

    • asset_type: "vast"

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

    • Optionalvast_version?: VASTVersion
    • Optionalvpaid_enabled?: boolean

      Whether VPAID (Video Player-Ad Interface Definition) is supported

    • Optionalduration_ms?: number

      Expected video duration in milliseconds (if known)

      0

    • Optionaltracking_events?: VASTTrackingEvent[]

      Tracking events supported by this VAST tag

    • Optionalcaptions_url?: string

      URL to captions file (WebVTT, SRT, etc.)

    • Optionalaudio_description_url?: string

      URL to audio description track for visually impaired users

    • Optionalprovenance?: Provenance
    • { delivery_type: "url"; url: string }
      • delivery_type: "url"

        Discriminator indicating VAST is delivered via URL endpoint

      • url: string

        URL endpoint that returns VAST XML. May carry unsubstituted ad-server macros — VAST-style [MACRO] and ${MACRO} placeholders are accepted as-is (RFC 6570 syntax); buyers MUST NOT pre-encode macro delimiters, since players match the literal token at substitution time.

    • { delivery_type: "inline"; content: string }
      • delivery_type: "inline"

        Discriminator indicating VAST is delivered as inline XML content

      • content: string

        Inline VAST XML content

    Settings

    Member Visibility