[interactive_media_ads] Adds support to set general SDK settings (#9648)

Adds support for:

https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/api/reference/com/google/ads/interactivemedia/v3/api/ImaSdkSettings.html
https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/reference/Classes/IMASettings.html

## Pre-Review Checklist

**Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.

Author: bparrishMines

packages/interactive_media_ads/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.5
+
+* Adds support to set general SDK settings. See `ImaSettings` and `AdsLoader.settings`.
+
 ## 0.2.4+2
 
 * Bumps gradle from 8.9.0 to 8.11.1.

packages/interactive_media_ads/android/src/main/kotlin/dev/flutter/packages/interactive_media_ads/AdsRequestProxyApi.kt

@@ -21,7 +21,7 @@ class AdsRequestProxyApi(override val pigeonRegistrar: ProxyApiRegistrar) :
      *
      * This must match the version in pubspec.yaml.
      */
-    const val pluginVersion = "0.2.4+2"
+    const val pluginVersion = "0.2.5"
   }
 
   override fun setAdTagUrl(pigeon_instance: AdsRequest, adTagUrl: String) {

packages/interactive_media_ads/android/src/main/kotlin/dev/flutter/packages/interactive_media_ads/InteractiveMediaAdsLibrary.g.kt

@@ -1,7 +1,7 @@
 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-// Autogenerated from Pigeon (v25.5.0), do not edit directly.
+// Autogenerated from Pigeon (v26.0.0), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 @file:Suppress("UNCHECKED_CAST", "ArrayInDataClass")
 

packages/interactive_media_ads/ios/interactive_media_ads/Sources/interactive_media_ads/AdsRequestProxyAPIDelegate.swift

@@ -13,7 +13,7 @@ class AdsRequestProxyAPIDelegate: PigeonApiDelegateIMAAdsRequest {
   /// The current version of the `interactive_media_ads` plugin.
   ///
   /// This must match the version in pubspec.yaml.
-  static let pluginVersion = "0.2.4+2"
+  static let pluginVersion = "0.2.5"
 
   func pigeonDefaultConstructor(
     pigeonApi: PigeonApiIMAAdsRequest, adTagUrl: String, adDisplayContainer: IMAAdDisplayContainer,

packages/interactive_media_ads/ios/interactive_media_ads/Sources/interactive_media_ads/InteractiveMediaAdsLibrary.g.swift

@@ -1,7 +1,7 @@
 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-// Autogenerated from Pigeon (v25.5.0), do not edit directly.
+// Autogenerated from Pigeon (v26.0.0), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 
 import Foundation

packages/interactive_media_ads/lib/interactive_media_ads.dart

@@ -11,6 +11,7 @@ export 'src/android/android_interactive_media_ads.dart'
     show AndroidInteractiveMediaAds;
 export 'src/companion_ad_slot.dart';
 export 'src/content_progress_provider.dart';
+export 'src/ima_settings.dart';
 export 'src/ios/ios_interactive_media_ads.dart' show IOSInteractiveMediaAds;
 export 'src/platform_interface/platform_interface.dart'
     show

packages/interactive_media_ads/lib/src/ads_loader.dart

@@ -8,6 +8,7 @@ import 'ad_display_container.dart';
 import 'ads_manager_delegate.dart';
 import 'ads_rendering_settings.dart';
 import 'ads_request.dart';
+import 'ima_settings.dart';
 import 'platform_interface/platform_interface.dart';
 
 /// Allows publishers to request ads from ad servers or a dynamic ad insertion
@@ -42,9 +43,11 @@ class AdsLoader {
     required AdDisplayContainer container,
     required void Function(OnAdsLoadedData data) onAdsLoaded,
     required void Function(AdsLoadErrorData data) onAdsLoadError,
+    ImaSettings? settings,
   }) : this.fromPlatformCreationParams(
           PlatformAdsLoaderCreationParams(
             container: container.platform,
+            settings: settings?.platform ?? ImaSettings().platform,
             onAdsLoaded: (PlatformOnAdsLoadedData data) {
               onAdsLoaded(OnAdsLoadedData._(platform: data));
             },
@@ -89,6 +92,10 @@ class AdsLoader {
   /// Implementation of [PlatformAdsLoader] for the current platform.
   final PlatformAdsLoader platform;
 
+  /// Defines general SDK settings.
+  ImaSettings get settings =>
+      ImaSettings.fromPlatform(platform.params.settings);
+
   /// Signals to the SDK that the content has completed.
   Future<void> contentComplete() {
     return platform.contentComplete();

packages/interactive_media_ads/lib/src/android/android_ads_loader.dart

@@ -10,6 +10,7 @@ import '../platform_interface/platform_interface.dart';
 import 'android_ad_display_container.dart';
 import 'android_ads_manager.dart';
 import 'android_content_progress_provider.dart';
+import 'android_ima_settings.dart';
 import 'enum_converter_utils.dart';
 import 'interactive_media_ads.g.dart' as ima;
 import 'interactive_media_ads_proxy.dart';
@@ -19,6 +20,7 @@ final class AndroidAdsLoaderCreationParams
     extends PlatformAdsLoaderCreationParams {
   /// Constructs a [AndroidAdsLoaderCreationParams].
   const AndroidAdsLoaderCreationParams({
+    required super.settings,
     required super.container,
     required super.onAdsLoaded,
     required super.onAdsLoadError,
@@ -33,6 +35,7 @@ final class AndroidAdsLoaderCreationParams
     @visibleForTesting InteractiveMediaAdsProxy? proxy,
   }) {
     return AndroidAdsLoaderCreationParams(
+      settings: params.settings,
       container: params.container,
       onAdsLoaded: params.onAdsLoaded,
       onAdsLoadError: params.onAdsLoadError,
@@ -97,11 +100,13 @@ base class AndroidAdsLoader extends PlatformAdsLoader {
   }
 
   Future<ima.AdsLoader> _createAdsLoader() async {
-    final ima.ImaSdkSettings settings =
-        await _sdkFactory.createImaSdkSettings();
+    final AndroidImaSettings settings = switch (_androidParams.settings) {
+      final AndroidImaSettings androidSettings => androidSettings,
+      _ => AndroidImaSettings(_androidParams.settings.params),
+    };
 
     final ima.AdsLoader adsLoader = await _sdkFactory.createAdsLoader(
-      settings,
+      await settings.nativeSettingsFuture,
       (params.container as AndroidAdDisplayContainer).adDisplayContainer!,
     );
 

packages/interactive_media_ads/lib/src/android/android_ima_settings.dart

@@ -0,0 +1,79 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'dart:async';
+
+import 'package:meta/meta.dart';
+
+import '../platform_interface/platform_ima_settings.dart';
+import 'interactive_media_ads.g.dart';
+
+/// Android implementation of [PlatformImaSettings].
+final class AndroidImaSettings extends PlatformImaSettings {
+  /// Constructs an [AndroidImaSettings].
+  AndroidImaSettings(super.params) : super.implementation();
+
+  /// The native Android ImaSdkSettings.
+  ///
+  /// Defines general SDK settings that are used when creating an `AdsLoader`.
+  @internal
+  late final Future<ImaSdkSettings> nativeSettingsFuture = _createSettings();
+
+  @override
+  Future<void> setAutoPlayAdBreaks(bool autoPlayAdBreaks) async {
+    final ImaSdkSettings settings = await nativeSettingsFuture;
+    await settings.setAutoPlayAdBreaks(autoPlayAdBreaks);
+  }
+
+  @override
+  Future<void> setDebugMode(bool enabled) async {
+    final ImaSdkSettings settings = await nativeSettingsFuture;
+    await settings.setDebugMode(enabled);
+  }
+
+  @override
+  Future<void> setFeatureFlags(Map<String, String> featureFlags) async {
+    final ImaSdkSettings settings = await nativeSettingsFuture;
+    await settings.setFeatureFlags(featureFlags);
+  }
+
+  @override
+  Future<void> setMaxRedirects(int maxRedirects) async {
+    final ImaSdkSettings settings = await nativeSettingsFuture;
+    await settings.setMaxRedirects(maxRedirects);
+  }
+
+  @override
+  Future<void> setPlayerType(String playerType) async {
+    final ImaSdkSettings settings = await nativeSettingsFuture;
+    await settings.setPlayerType(playerType);
+  }
+
+  @override
+  Future<void> setPlayerVersion(String playerVersion) async {
+    final ImaSdkSettings settings = await nativeSettingsFuture;
+    await settings.setPlayerVersion(playerVersion);
+  }
+
+  @override
+  Future<void> setPpid(String ppid) async {
+    final ImaSdkSettings settings = await nativeSettingsFuture;
+    await settings.setPpid(ppid);
+  }
+
+  @override
+  Future<void> setSessionID(String sessionID) async {
+    final ImaSdkSettings settings = await nativeSettingsFuture;
+    await settings.setSessionId(sessionID);
+  }
+
+  Future<ImaSdkSettings> _createSettings() async {
+    final ImaSdkSettings settings =
+        await ImaSdkFactory.instance.createImaSdkSettings();
+    if (params.language case final String language) {
+      await settings.setLanguage(language);
+    }
+    return settings;
+  }
+}

packages/interactive_media_ads/lib/src/android/android_interactive_media_ads.dart

@@ -9,12 +9,14 @@ import '../platform_interface/platform_ads_manager_delegate.dart';
 import '../platform_interface/platform_ads_rendering_settings.dart';
 import '../platform_interface/platform_companion_ad_slot.dart';
 import '../platform_interface/platform_content_progress_provider.dart';
+import '../platform_interface/platform_ima_settings.dart';
 import 'android_ad_display_container.dart';
 import 'android_ads_loader.dart';
 import 'android_ads_manager_delegate.dart';
 import 'android_ads_rendering_settings.dart';
 import 'android_companion_ad_slot.dart';
 import 'android_content_progress_provider.dart';
+import 'android_ima_settings.dart';
 
 /// Android implementation of [InteractiveMediaAdsPlatform].
 final class AndroidInteractiveMediaAds extends InteractiveMediaAdsPlatform {
@@ -24,28 +26,28 @@ final class AndroidInteractiveMediaAds extends InteractiveMediaAdsPlatform {
   }
 
   @override
-  PlatformAdDisplayContainer createPlatformAdDisplayContainer(
+  AndroidAdDisplayContainer createPlatformAdDisplayContainer(
     PlatformAdDisplayContainerCreationParams params,
   ) {
     return AndroidAdDisplayContainer(params);
   }
 
   @override
-  PlatformAdsLoader createPlatformAdsLoader(
+  AndroidAdsLoader createPlatformAdsLoader(
     PlatformAdsLoaderCreationParams params,
   ) {
     return AndroidAdsLoader(params);
   }
 
   @override
-  PlatformAdsManagerDelegate createPlatformAdsManagerDelegate(
+  AndroidAdsManagerDelegate createPlatformAdsManagerDelegate(
     PlatformAdsManagerDelegateCreationParams params,
   ) {
     return AndroidAdsManagerDelegate(params);
   }
 
   @override
-  PlatformContentProgressProvider createPlatformContentProgressProvider(
+  AndroidContentProgressProvider createPlatformContentProgressProvider(
     PlatformContentProgressProviderCreationParams params,
   ) {
     return AndroidContentProgressProvider(params);
@@ -64,4 +66,11 @@ final class AndroidInteractiveMediaAds extends InteractiveMediaAdsPlatform {
   ) {
     return AndroidCompanionAdSlot(params);
   }
+
+  @override
+  AndroidImaSettings createPlatformImaSettings(
+    PlatformImaSettingsCreationParams params,
+  ) {
+    return AndroidImaSettings(params);
+  }
 }