Interface OverlayAd

Ad which gets displayed during content playback

interface OverlayAd {
    clickThroughUrl?: string;
    clickThroughUrlOpened?: (() => void);
    companionAds?: CompanionAd[];
    data?: AdData;
    extensions?: VastAdExtension[];
    height: number;
    id?: string;
    isLinear: boolean;
    mediaFileUrl?: string;
    verifications?: any[];
    width: number;
}

Hierarchy (view full)

  • Ad
    • OverlayAd

Properties

clickThroughUrl? clickThroughUrlOpened? companionAds? data? extensions? height id? isLinear mediaFileUrl? verifications? width

Properties

Optional clickThroughUrl

clickThroughUrl?: string

The url the user should be redirected to when clicking the ad.

Optional clickThroughUrlOpened

clickThroughUrlOpened?: (() => void)

Callback function to track the opening of the clickThroughUrl.

Type declaration

    • (): void

    • Returns void

Optional companionAds

companionAds?: CompanionAd[]

The CompanionAds that should be served with the ad.

Optional data

data?: AdData

Holds various additional ad data.

Optional extensions

extensions?: VastAdExtension[]

The parsed custom Extension tags

Since

8.39.0

height

height: number

The height of the ad.

Optional id

id?: string

Identifier for the ad. This might be autogenerated.

isLinear

isLinear: boolean

Determines whether an ad is linear, i.e. playback of main content needs to be paused for the ad.

Optional mediaFileUrl

mediaFileUrl?: string

The corresponding media file for the ad.

Optional verifications

verifications?: any[]

The parsed Verification tags of the corresponding AdVerifications tag. Every tag is handled as an array and the property names are the exact same as the tag/attribute names found in the manifest (case-sensitive). The text content of a tag is saved to a content property.

width

width: number

The width of the ad.

Settings

Member Visibility

Theme

On This Page

clickThroughUrlclickThroughUrlOpenedcompanionAdsdataextensionsheightidisLinearmediaFileUrlverificationswidth