Interface AdsConfiguration

Describes the configuration of advertisement.

interface AdsConfiguration {
    allowedMimeTypes?: string[];
    googleIma?: GoogleImaConfiguration;
    preload?: AdPreloadType;
    showCountdown?: boolean;
    theoads?: boolean;
    vpaidMode?: VPAIDMode;
}

Properties

allowedMimeTypes? googleIma? preload? showCountdown? theoads? vpaidMode?

Properties

OptionalallowedMimeTypes

allowedMimeTypes?: string[]

Allows configuring which mime types are allowed during ad playback.

Remarks


- If set to an array, all ads with another mime types will be ignored.
- If set to undefined:

  • for Google IMA, the ad system will pick media based on the browser's capabilities.
  • for the other integrations, the ad system will ignore all streaming ads.

Default Value

undefined

OptionalgoogleIma

googleIma?: GoogleImaConfiguration

The Google IMA configuration.

Optionalpreload

preload?: AdPreloadType

Whether media files of mid- and postrolls are preloaded.

Remarks


- This feature is only available for Google IMA.

Default Value

'midroll-and-postroll'

OptionalshowCountdown

showCountdown?: boolean

Whether an advertisement duration countdown will be shown in the UI.

Deprecated

use GoogleImaConfiguration.uiElements instead

Remarks


- Available since v2.22.9.
- This feature is only available for Google IMA.

Default Value

true

Optionaltheoads

theoads?: boolean

Whether to enable THEOads support.

Remarks


- Available since 8.2.0.
- This must be set to true in order to schedule a TheoAdDescription.

Default Value

false

OptionalvpaidMode

vpaidMode?: VPAIDMode

The iframe policy for VPAID ads.

Remarks


- This feature is only available for Google IMA and SpotX.

Default Value

'enabled'

Settings

Member Visibility

On This Page

Properties