Represents a single linear ad, synonymous with a VAST Ad element with a single Linear creative. It may include any number of companion creatives, as well.

A linear ad is always contained within a linear ad roll (represented by LinearAdRoll).

interface LinearAd {
    absoluteEndTime(): number;
    absoluteStartTime(): number;
    ad(): Record<string, unknown>;
    adParameters(): string;
    adSystem(): string;
    adTitle(): string;
    advertiser(): string;
    clickThroughUrl(): string;
    companionTrackingEvents(): CompanionAdTrackingEvents;
    companions(): Record<string, unknown>[];
    description(): string;
    duration(): number;
    error(): string;
    isPending(): boolean;
    isSlate(): boolean;
    populate(ad): void;
    primaryCreative(): Record<string, unknown>;
    skipOffset(): number;
    trackingEvents(): LinearAdTrackingEvents;
    update(ad): LinearAd;
    updateTiming(time): void;
}

Methods

  • Returns number

  • Returns number

  • Returns Record<string, unknown>

  • Returns string

  • Returns string

  • Returns string

  • Returns string

  • Returns string

  • Returns Record<string, unknown>[]

  • Returns string

  • Returns number

  • Returns string

  • Returns boolean

  • Returns boolean

  • Parameters

    • ad: Record<string, unknown>

    Returns void

  • Returns Record<string, unknown>

  • Returns number

  • Parameters

    • time: number

    Returns void