Interface MKAd

Defines basic properties available for every ad type

interface MKAd {
    clickThroughUrl?: string;
    clickThroughUrlOpened?: () => void;
    companionAds?: MKCompanionAd[];
    data?: MKAdData;
    extensions?: MKVastAdExtension[];
    height: number;
    id?: string;
    isLinear: boolean;
    mediaFileUrl?: string;
    verifications?: any[];
    width: number;
}

Properties

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

Properties

OptionalclickThroughUrl

clickThroughUrl?: string

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

OptionalclickThroughUrlOpened

clickThroughUrlOpened?: () => void

Callback function to track the opening of the clickThroughUrl.

OptionalcompanionAds

companionAds?: MKCompanionAd[]

The CompanionAds that should be served with the ad.

Optionaldata

data?: MKAdData

Holds various additional ad data.

Optionalextensions

extensions?: MKVastAdExtension[]

The parsed custom Extension tags

Since

v1.18.0

height

height: number

The height of the ad.

Optionalid

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.

OptionalmediaFileUrl

mediaFileUrl?: string

The corresponding media file for the ad.

Optionalverifications

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

On This Page

Properties