@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Type Alias VASTAsset

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

    VAST (Video Ad Serving Template) tag for third-party video or audio ad serving. Unlike a hosted media asset, a VAST tag carries no single width/height: a response can return multiple renditions and the player selects one at serve time. Standardized VAST audio support begins at 4.1 and uses MediaFile width and height values of 0; older audio-in-VAST versions are seller-declared legacy interoperability. Dimensional, duration, MIME-type, and codec constraints 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
    • Optionalmacro_declarations?: [MacroDeclaration, ...MacroDeclaration[]]

      One declaration per exact occurrence in a field carried by this asset. A URL-delivered asset can declare only occurrences in its locator url; tokens discovered later in a fetched VAST response require document validation evidence or an inline/snapshotted asset and MUST NOT be guessed from the locator. IAB tokens cite a registry namespace and revision rather than copying the live registry into AdCP.

      1

    • Optionalvpaid_enabled?: boolean

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

    • Optionalduration_ms?: number

      Expected media duration in milliseconds (if known)

    • 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: MacroBearingURL;
          macro_declarations?: { location?: { field?: "url" } }[];
      }
      • delivery_type: "url"

        Discriminator indicating VAST is delivered via URL endpoint

      • url: MacroBearingURL
      • Optionalmacro_declarations?: { location?: { field?: "url" } }[]
    • {
          delivery_type: "inline";
          content: string;
          macro_declarations?: { location?: { field?: "content" } }[];
      }
      • delivery_type: "inline"

        Discriminator indicating VAST is delivered as inline XML content

      • content: string

        Inline VAST XML content

      • Optionalmacro_declarations?: { location?: { field?: "content" } }[]

    Settings
    Member Visibility