Interface ImaSdkSettings

Returns the current companion backfill mode.

Returns
CompanionBackfillMode	The current value.

Returns whether to disable custom playback on iOS 10+ browsers. The default value is false.

Returns
boolean	Whether to disable custom playback.

Returns an object with keys as feature flags and values as their current state.

Returns
Record<string, unknown>	The feature flags.

Returns the publisher provided locale.

Returns
string	Publisher provided locale.

Returns the maximum number of redirects for subsequent redirects will be denied.

Returns
number	the maximum number of redirects.

Returns the partner provided player type.

Returns
string	Partner player type.

Returns the partner provided player version.

Returns
string	Partner player version.

Returns the publisher provided id.

Returns
string	The publisher provided id.

Sets whether VMAP and ad rules ad breaks are automatically played

Parameters
autoPlayAdBreaks: boolean	Whether to autoPlay the ad breaks.

Sets the companion backfill mode. See the various modes available in ImaSdkSettings.CompanionBackfillMode.

The default mode is ImaSdkSettings.CompanionBackfillMode.ALWAYS.

Parameters
mode: CompanionBackfillMode	The chosen companion backfill mode.

Sets whether to disable custom playback on iOS 10+ browsers. If true, ads will play inline if the content video is inline. This enables TrueView skippable ads. However, the ad will stay inline and not support iOS's native fullscreen. When false, ads will play in the same player as your content. The value set here when an AdDisplayContainer is created is used for the lifetime of the container. The default value is false.

Parameters
disable: boolean	Whether or not to disable custom playback.

Set the value for any feature flags. This should be set as early as possible, before requesting ads. Settings will remain constant until the next ad request. Calling this method again will reset any feature flags for the next ad request.

Parameters
featureFlags: Record<string, unknown>	The feature flags object.

Sets the publisher provided locale. Must be called before creating AdsLoader or AdDisplayContainer. The locale specifies the language in which to display UI elements. The supported codes can be found in Localizing for Language and Locale.

Parameters
locale: string	Publisher-provided locale.

Specifies the maximum number of redirects before the subsequent redirects will be denied, and the ad load aborted. The number of redirects directly affects latency and thus user experience. This applies to all VAST wrapper ads.

Parameters
numRedirects: number	The maximum number of redirects.

Sets the partner provided player type. This setting should be used to specify the name of the player being integrated with the SDK. Player type greater than 20 characters will be truncated. The player type specified should be short and unique. This is an optional setting used to improve SDK usability by tracking player types.

Example:

  settings.setPlayerType('google/gmf-player'); 

Parameters
playerType: string	The type of the partner player.

Sets the partner provided player version. This setting should be used to specify the version of the partner player being integrated with the SDK. Player versions greater than 20 characters will be truncated. This is an optional setting used to improve SDK usability by tracking player version.

Example:

  settings.setPlayerVersion('1.0.0'); 

Parameters
playerVersion: string	The version of the partner player.

Sets the publisher provided id.

Parameters
ppid: string	publisher provided id.

Session ID is a temporary random ID. It is used exclusively for frequency capping. A session ID must be a UUID.

Parameters
sessionId: string	A temporary UUID used for frequency capping.

Sets whether VPAID creatives are allowed.

Parameters
allowVpaid: boolean	Whether to allow VPAID creatives.

Sets VPAID playback mode.

Parameters
vpaidMode: VpaidMode	Sets how VPAID ads will be played. Default is secure mode.