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

    Type Alias VASTTrackerAsset

    VASTTrackerAsset: {} & {
        asset_type: "vast_tracker";
        vast_event: VASTTrackingEvent & {};
        url: string;
        offset?: string;
        target?: "linear" | "non_linear" | "companion";
        provenance?: Provenance;
    }

    A single tracker URL bound to a VAST TrackingEvents event. Emitted by the creative agent as a decomposed VAST-event URL; the sales agent assembles these into the VAST TrackingEvents block at serve time. IMPORTANT: this asset type is for TrackingEvents URLs only (start, quartiles, complete, pause, mute, etc.). The Impression URL MUST be modeled as a url asset with url_type: "tracker_pixel", not as a vast_tracker with vast_event: "impression". Decomposed trackers let format requirements bind specific measurement events (e.g., MRC viewable) without forcing the buyer to construct a full VAST tag.

    Type Declaration

      • asset_type: "vast_tracker"

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

      • vast_event: VASTTrackingEvent & {}

        The VAST tracking event this URL fires on. Maps 1:1 to the VAST Tracking event="..." attribute inside TrackingEvents. MUST NOT be impression (belongs in the VAST Impression element — model as a url asset with url_type: "tracker_pixel"), clickTracking / customClick (belong in VideoClicks), error (VAST Error element), or any of viewable / notViewable / viewUndetermined / measurableImpression / viewableImpression (children of the VAST ViewableImpression element, not TrackingEvents).

      • url: string

        Tracker URL that fires when vast_event occurs. May carry AdCP universal macros (e.g., {SKU}, {MEDIA_BUY_ID}); the sales agent or ad server URL-encodes substituted values at serve time. See docs/creative/universal-macros.mdx.

      • Optionaloffset?: string

        VAST offset attribute. Required when vast_event is progress; ignored otherwise. Format matches the VAST 4.2 XSD Tracking@offset pattern: HH:MM:SS or HH:MM:SS.mmm for absolute time (two-digit hours, minutes 00–59, seconds 00–59), or an integer percentage 0–100 suffixed with %. Negative offsets are NOT permitted — the VAST 4.2 XSD pattern does not allow a leading minus.

      • Optionaltarget?: "linear" | "non_linear" | "companion"

        Which VAST creative element this tracker scopes to — linear for <Linear>/<TrackingEvents>, non_linear for <NonLinearAds>/<TrackingEvents>, companion for <CompanionAds>/<Companion>/<TrackingEvents>. VAST 4.2 places these under separate XML elements with separate event semantics (e.g., acceptInvitation is meaningful on non-linear / companion; closeLinear only on linear). Defaults to linear. Sales agents use this to place the tracker in the correct location during VAST assembly.

      • Optionalprovenance?: Provenance

      Settings

      Member Visibility