*** ** * ** *** This class contains SDK-wide settings. | Methods || |---|---| | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getCompanionBackfill` | Returns the current companion backfill mode. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getDisableCustomPlaybackForIOS10Plus` | Returns whether to disable custom playback on iOS 10+ browsers. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getFeatureFlags` | Returns an object with keys as feature flags and values as their current state. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getLocale` | Returns the publisher provided locale. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getNumRedirects` | Returns the maximum number of redirects for subsequent redirects will be denied. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getPlayerType` | Returns the partner provided player type. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getPlayerVersion` | Returns the partner provided player version. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getPpid` | Returns the publisher provided id. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.getPreloadTimeSeconds` | Gets the ad break preload time in seconds. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setAutoPlayAdBreaks` | Sets whether VMAP and ad rules ad breaks are automatically played. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setCompanionBackfill` | Sets the companion backfill mode. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setDisableCustomPlaybackForIOS10Plus` | Sets whether to disable custom playback on iOS 10+ browsers. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setFeatureFlags` | Set the value for any feature flags. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setLocale` | Sets the publisher provided locale. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setNumRedirects` | Specifies the maximum number of redirects before the subsequent redirects will be denied, and the ad load aborted. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setPlayerType` | Sets the partner provided player type. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setPlayerVersion` | Sets the partner provided player version. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setPpid` | Sets the publisher provided id. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setPreloadTimeSeconds` | Sets the preloading time for midroll ads only. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setSessionId` | Session ID is a temporary random ID. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setVpaidAllowed` | **Deprecated.**Sets whether VPAID creatives are allowed. | | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/interface/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.setVpaidMode` | Sets VPAID playback mode. | ## Methods *** ** * ** *** ### getCompanionBackfill `getCompanionBackfill(): https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.CompanionBackfillMode` Returns the current companion backfill mode. | Returns || |---|---| | `https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.CompanionBackfillMode` | The current value. | *** ** * ** *** ### getDisableCustomPlaybackForIOS10Plus `getDisableCustomPlaybackForIOS10Plus(): boolean` Returns whether to disable custom playback on iOS 10+ browsers. The default value is false. | Returns || |---|---| | `boolean` | Whether to disable custom playback. | *** ** * ** *** ### getFeatureFlags `getFeatureFlags(): Record` Returns an object with keys as feature flags and values as their current state. | Returns || |---|---| | `Record` | The feature flags. | *** ** * ** *** ### getLocale `getLocale(): string` Returns the publisher provided locale. | Returns || |---|---| | `string` | Publisher provided locale. | *** ** * ** *** ### getNumRedirects `getNumRedirects(): number` Returns the maximum number of redirects for subsequent redirects will be denied. | Returns || |---|---| | `number` | the maximum number of redirects. | *** ** * ** *** ### getPlayerType `getPlayerType(): string` Returns the partner provided player type. | Returns || |---|---| | `string` | Partner player type. | *** ** * ** *** ### getPlayerVersion `getPlayerVersion(): string` Returns the partner provided player version. | Returns || |---|---| | `string` | Partner player version. | *** ** * ** *** ### getPpid `getPpid(): string` Returns the publisher provided id. | Returns || |---|---| | `string` | The publisher provided id. | *** ** * ** *** ### getPreloadTimeSeconds `getPreloadTimeSeconds(): number` Gets the ad break preload time in seconds. | Returns || |---|---| | `number` | The preload time in seconds. | *** ** * ** *** ### setAutoPlayAdBreaks `setAutoPlayAdBreaks(autoPlayAdBreaks: boolean): void` Sets whether VMAP and ad rules ad breaks are automatically played | Parameters || |---|---| | `autoPlayAdBreaks: boolean` | Whether to autoPlay the ad breaks. | *** ** * ** *** ### setCompanionBackfill `setCompanionBackfill(mode: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.CompanionBackfillMode): void` Sets the companion backfill mode. See the various modes available in ImaSdkSettings.CompanionBackfillMode. The default mode is ImaSdkSettings.CompanionBackfillMode.ALWAYS. | Parameters || |---|---| | `mode: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.CompanionBackfillMode` | The chosen companion backfill mode. | *** ** * ** *** ### setDisableCustomPlaybackForIOS10Plus `setDisableCustomPlaybackForIOS10Plus(disable: boolean): void` 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. You must set this value before creating the `AdDisplayContainer`. The default value is false. | Parameters || |---|---| | `disable: boolean` | Whether or not to disable custom playback. | *** ** * ** *** ### setFeatureFlags `setFeatureFlags(featureFlags: Record): void` 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` | The feature flags object. | *** ** * ** *** ### setLocale `setLocale(locale: string): void` 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](https://developers.google.com/interactive-media-ads/docs/sdks/html5/localization). | Parameters || |---|---| | `locale: string` | Publisher-provided locale. | *** ** * ** *** ### setNumRedirects `setNumRedirects(numRedirects: number): void` 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. | *** ** * ** *** ### setPlayerType `setPlayerType(playerType: string): void` 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. | *** ** * ** *** ### setPlayerVersion `setPlayerVersion(playerVersion: string): void` 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. | *** ** * ** *** ### setPpid `setPpid(ppid: string): void` Sets the publisher provided id. | Parameters || |---|---| | `ppid: string` | publisher provided id. | *** ** * ** *** ### setPreloadTimeSeconds `setPreloadTimeSeconds(preloadTimeSeconds: number): void` Sets the preloading time for midroll ads only. If left null, the default value of 8 seconds will be used. For more info see [our guide to preloading media](https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/preload). | Parameters || |---|---| | `preloadTimeSeconds: number` | The preload time in seconds. | *** ** * ** *** ### setSessionId `setSessionId(sessionId: string): void` 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. | *** ** * ** *** ### setVpaidAllowed `setVpaidAllowed(allowVpaid: boolean): void` Sets whether VPAID creatives are allowed. > [!WARNING] > **Deprecated:** Use setVpaidMode. | Parameters || |---|---| | `allowVpaid: boolean` | Whether to allow VPAID creatives. | *** ** * ** *** ### setVpaidMode `setVpaidMode(vpaidMode: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.VpaidMode): void` Sets VPAID playback mode. | Parameters || |---|---| | `vpaidMode: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/namespace/google.ima.ImaSdkSettings#google.ima.ImaSdkSettings.VpaidMode` | Sets how VPAID ads will be played. Default is secure mode. |