Interface GoogleImaConfiguration

Describes the configuration of Google IMA.

interface GoogleImaConfiguration {
    bitrate?: number;
    language?: string;
    uiElements?: string[];
    useAdUiElementForSsai?: boolean;
}

Properties

bitrate? language? uiElements? useAdUiElementForSsai?

Properties

Optionalbitrate

bitrate?: number

The maximum recommended bitrate in kbit/s. Ads with a bitrate below the specified maximum will be picked.

Remarks


- When set to -1, it will select the ad with the highest bitrate.
- If there is no ad below the specified maximum, the ad closest to the bitrate will be picked.

Default Value

-1

Optionallanguage

language?: string

The language code of the UI elements. See localization docs for more information.

Remarks


- This will default to UIConfiguration.language when not specified.

OptionaluiElements

uiElements?: string[]

The UI elements passed to Google IMA. See Google IMA docs for more information.

Remarks


- Available since v6.13.0.

OptionaluseAdUiElementForSsai

useAdUiElementForSsai?: boolean

Whether to use an ad UI element for clickthrough and displaying other ad UI.

Remarks


- Optional toggle for turning on usage of the adUiElement when using Google DAI SSAI. This is necessary for showing ads if they have UI specified, such as UI for GDPR compliance. If ads have extra UI elements specified and this is not enabled, ads with UI will not play. Enabling this option will remove the Learn More button and disable keyboard interactions with the ad.
- This only applies to Google DAI SSAI content. IMA CSAI always uses the adUiElement.

Settings

Member Visibility

On This Page

Properties