Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ImaAdvertisingConfig

Hierarchy

Index

Properties

Optional adBreaks

adBreaks: AdConfig[]

Defines a collection of ad breaks which will be played at the specified position in each AdBreakConfig.

Optional adContainer

adContainer: undefined | function

Defines a function which returns a container that is used for displaying ads.

Optional allowedUiElements

allowedUiElements: string[]

Defines an array of UI elements that should be displayed when an ad is active. Customizable UI elements are defined at https://developers.google.com/interactive-media-ads/docs/sdks/html5/v3/apis#ima.UiElements.

Setting this property to an empty array will not show the UI elements mentioned in the link above.

Optional beforeInitialization

beforeInitialization: undefined | function

Callback that provides access to the google.ima.ImaSdkSettings before any initialization happens.

Optional companionAdContainers

companionAdContainers: undefined | function

Defines a function which returns an array of containers for the ad module to fill with companion ads.

Optional onAdContainerAvailable

onAdContainerAvailable: undefined | function

Callback that provides access to the ad container.

Optional onAdsManagerAvailable

onAdsManagerAvailable: undefined | function

Callback that provides access to the google.ima.AdsManager.

Optional placeholders

placeholders: AdTagPlaceholders

List of placeholder strings that will be replaced in the ad manifest URL with the corresponding values.

since

8.1.0

Optional sdkUrl

sdkUrl: undefined | string

The URL of the Google IMA Framework.

Default URL: https://imasdk.googleapis.com/js/sdkloader/ima3.js

Optional strategy

Defines an object with two functions which will be called if an ad break is about to start or when ads are seeked over. If this property is not set manually, then only the last ad that was seeked over will be played.

Optional videoLoadTimeout

videoLoadTimeout: undefined | number

Specifies the amount of milliseconds before the loading of an ad from a given ad manifest times out. Default is 8000.

Optional withCredentials

withCredentials: undefined | false | true

Specifies whether to send credentials such as cookies or authorization headers along with the ad requests. The server needs to explicitly accept them for CORS requests, otherwise the request will fail. Default is true.

Generated using TypeDoc