[interactive_media_ads] Adds support to define parameters that control the rendering of ads (#8057)

Changes `PlatformAdsManager.init(AdsManagerInitParams)` to the correct shared `PlatformAdsManager.init(PlatformAdsRenderingSettings?)` feature.

**Android:** https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/api/reference/com/google/ads/interactivemedia/v3/api/BaseManager.html#init(com.google.ads.interactivemedia.v3.api.AdsRenderingSettings)
**iOS:** https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/reference/Classes/IMAAdsManager#/c:objc(cs)IMAAdsManager(im)initializeWithAdsRenderingSettings:

The platform interface and implementation aren't exposed yet, so this change should not be breaking.

Fixes flutter/flutter#152253

Author: bparrishMines

packages/interactive_media_ads/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.3
+
+* Adds parameters to control the rendering of ads. See `AdsManager.init`.
+
 ## 0.2.2+15
 
 * Adds remaining methods for internal wrapper of the Android native `BaseManager`.

packages/interactive_media_ads/README.md

@@ -154,7 +154,7 @@ late final AdDisplayContainer _adDisplayContainer = AdDisplayContainer(
           },
         ));
 
-        manager.init();
+        manager.init(settings: AdsRenderingSettings(enablePreloading: true));
       },
       onAdsLoadError: (AdsLoadErrorData data) {
         debugPrint('OnAdsLoadError: ${data.error.message}');

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.2+15"
+    const val pluginVersion = "0.2.3"
   }
 
   override fun setAdTagUrl(pigeon_instance: AdsRequest, adTagUrl: String) {

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

@@ -7,6 +7,7 @@ package dev.flutter.packages.interactive_media_ads
 import android.view.ViewGroup
 import com.google.ads.interactivemedia.v3.api.AdDisplayContainer
 import com.google.ads.interactivemedia.v3.api.AdsLoader
+import com.google.ads.interactivemedia.v3.api.AdsRenderingSettings
 import com.google.ads.interactivemedia.v3.api.AdsRequest
 import com.google.ads.interactivemedia.v3.api.ImaSdkFactory
 import com.google.ads.interactivemedia.v3.api.ImaSdkSettings
@@ -46,4 +47,8 @@ class ImaSdkFactoryProxyApi(override val pigeonRegistrar: ProxyApiRegistrar) :
   override fun createAdsRequest(pigeon_instance: ImaSdkFactory): AdsRequest {
     return pigeon_instance.createAdsRequest()
   }
+
+  override fun createAdsRenderingSettings(pigeon_instance: ImaSdkFactory): AdsRenderingSettings {
+    return pigeon_instance.createAdsRenderingSettings()
+  }
 }

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 (v22.5.0), do not edit directly.
+// Autogenerated from Pigeon (v22.6.0), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 @file:Suppress("UNCHECKED_CAST", "ArrayInDataClass", "SyntheticAccessor")
 
@@ -2236,6 +2236,14 @@ abstract class PigeonApiImaSdkFactory(
       pigeon_instance: com.google.ads.interactivemedia.v3.api.ImaSdkFactory
   ): com.google.ads.interactivemedia.v3.api.AdsRequest
 
+  /**
+   * Creates an `AdsRenderingSettings` object to give the AdsManager parameters that control the
+   * rendering of ads.
+   */
+  abstract fun createAdsRenderingSettings(
+      pigeon_instance: com.google.ads.interactivemedia.v3.api.ImaSdkFactory
+  ): com.google.ads.interactivemedia.v3.api.AdsRenderingSettings
+
   companion object {
     @Suppress("LocalVariableName")
     fun setUpMessageHandlers(binaryMessenger: BinaryMessenger, api: PigeonApiImaSdkFactory?) {
@@ -2355,6 +2363,28 @@ abstract class PigeonApiImaSdkFactory(
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel =
+            BasicMessageChannel<Any?>(
+                binaryMessenger,
+                "dev.flutter.pigeon.interactive_media_ads.ImaSdkFactory.createAdsRenderingSettings",
+                codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val pigeon_instanceArg = args[0] as com.google.ads.interactivemedia.v3.api.ImaSdkFactory
+            val wrapped: List<Any?> =
+                try {
+                  listOf(api.createAdsRenderingSettings(pigeon_instanceArg))
+                } catch (exception: Throwable) {
+                  wrapError(exception)
+                }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
     }
   }
 

packages/interactive_media_ads/android/src/test/kotlin/dev/flutter/packages/interactive_media_ads/ImaSdkFactoryProxyApiTest.kt

@@ -6,6 +6,7 @@ package dev.flutter.packages.interactive_media_ads
 
 import com.google.ads.interactivemedia.v3.api.AdDisplayContainer
 import com.google.ads.interactivemedia.v3.api.AdsLoader
+import com.google.ads.interactivemedia.v3.api.AdsRenderingSettings
 import com.google.ads.interactivemedia.v3.api.AdsRequest
 import com.google.ads.interactivemedia.v3.api.ImaSdkFactory
 import com.google.ads.interactivemedia.v3.api.ImaSdkSettings
@@ -51,4 +52,15 @@ class ImaSdkFactoryProxyApiTest {
 
     assertEquals(mockRequest, api.createAdsRequest(instance))
   }
+
+  @Test
+  fun createAdsRenderingSettings() {
+    val api = TestProxyApiRegistrar().getPigeonApiImaSdkFactory()
+
+    val instance = mock<ImaSdkFactory>()
+    val mockSettings = mock<AdsRenderingSettings>()
+    whenever(instance.createAdsRenderingSettings()).thenReturn(mockSettings)
+
+    assertEquals(mockSettings, api.createAdsRenderingSettings(instance))
+  }
 }

packages/interactive_media_ads/example/lib/main.dart

@@ -100,7 +100,7 @@ class _AdExampleWidgetState extends State<AdExampleWidget>
             },
           ));
 
-          manager.init();
+          manager.init(settings: AdsRenderingSettings(enablePreloading: true));
         },
         onAdsLoadError: (AdsLoadErrorData data) {
           debugPrint('OnAdsLoadError: ${data.error.message}');

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.2+15"
+  static let pluginVersion = "0.2.3"
 
   func pigeonDefaultConstructor(
     pigeonApi: PigeonApiIMAAdsRequest, adTagUrl: String, adDisplayContainer: IMAAdDisplayContainer,

packages/interactive_media_ads/lib/interactive_media_ads.dart

@@ -5,6 +5,7 @@
 export 'src/ad_display_container.dart';
 export 'src/ads_loader.dart';
 export 'src/ads_manager_delegate.dart';
+export 'src/ads_rendering_settings.dart';
 export 'src/ads_request.dart';
 export 'src/android/android_interactive_media_ads.dart'
     show AndroidInteractiveMediaAds;
@@ -18,4 +19,5 @@ export 'src/platform_interface/platform_interface.dart'
         AdErrorType,
         AdEvent,
         AdEventType,
+        AdUIElement,
         AdsLoadErrorData;

packages/interactive_media_ads/lib/src/ads_loader.dart

@@ -6,6 +6,7 @@ import 'package:flutter/foundation.dart';
 
 import 'ad_display_container.dart';
 import 'ads_manager_delegate.dart';
+import 'ads_rendering_settings.dart';
 import 'ads_request.dart';
 import 'platform_interface/platform_interface.dart';
 
@@ -145,8 +146,8 @@ class AdsManager {
   final PlatformAdsManager platform;
 
   /// Initializes the ad experience using default rendering settings.
-  Future<void> init() {
-    return platform.init(AdsManagerInitParams());
+  Future<void> init({AdsRenderingSettings? settings}) {
+    return platform.init(settings: settings?.platform);
   }
 
   /// Starts playing the ads.