[interactive_media_ads] Adds support for companion ads

packages/interactive_media_ads/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.4
+
+* Adds support for companion ads. See `CompanionAdSlot` and `AdDisplayContainer(companionAds)`.
+
 ## 0.2.3+12
 
 * Fixes appending request agent to ad tags that contain a query.

packages/interactive_media_ads/README.md

@@ -55,7 +55,7 @@ If building on Android, add the user permissions required by the IMA SDK for req
 Add the import statements for the `interactive_media_ads` and [video_player][7]. Both plugins should
 already be added to your `pubspec.yaml`.
 
-<?code-excerpt "example/lib/main.dart (imports)"?>
+<?code-excerpt "example/lib/readme_example.dart (imports)"?>
 ```dart
 import 'package:interactive_media_ads/interactive_media_ads.dart';
 import 'package:video_player/video_player.dart';
@@ -66,7 +66,7 @@ import 'package:video_player/video_player.dart';
 Create a new [StatefulWidget](https://api.flutter.dev/flutter/widgets/StatefulWidget-class.html)
 that handles displaying Ads and playing content.
 
-<?code-excerpt "example/lib/main.dart (example_widget)"?>
+<?code-excerpt "example/lib/readme_example.dart (example_widget)"?>
 ```dart
 /// Example widget displaying an Ad before a video.
 class AdExampleWidget extends StatefulWidget {
@@ -120,7 +120,7 @@ Instantiate the [AdDisplayContainer][3] for playing Ads and the
 [VideoPlayerController](https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerController-class.html)
 for playing content.
 
-<?code-excerpt "example/lib/main.dart (ad_and_content_players)"?>
+<?code-excerpt "example/lib/readme_example.dart (ad_and_content_players)"?>
 ```dart
 late final AdDisplayContainer _adDisplayContainer = AdDisplayContainer(
   onContainerAdded: (AdDisplayContainer container) {
@@ -194,7 +194,7 @@ void initState() {
 
 Return a `Widget` that contains the ad player and the content player.
 
-<?code-excerpt "example/lib/main.dart (widget_build)"?>
+<?code-excerpt "example/lib/readme_example.dart (widget_build)"?>
 ```dart
 @override
 Widget build(BuildContext context) {
@@ -244,7 +244,7 @@ Widget build(BuildContext context) {
 
 Handle requesting ads and add event listeners to handle when content should be displayed or hidden.
 
-<?code-excerpt "example/lib/main.dart (request_ads)"?>
+<?code-excerpt "example/lib/readme_example.dart (request_ads)"?>
 ```dart
 Future<void> _requestAds(AdDisplayContainer container) {
   return _adsLoader.requestAds(AdsRequest(
@@ -292,7 +292,7 @@ Future<void> _pauseContent() {
 
 Dispose the content player and destroy the [AdsManager][6].
 
-<?code-excerpt "example/lib/main.dart (dispose)"?>
+<?code-excerpt "example/lib/readme_example.dart (dispose)"?>
 ```dart
 @override
 void dispose() {

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

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

@@ -4,11 +4,21 @@
 
 package dev.flutter.packages.interactive_media_ads
 
+import com.google.ads.interactivemedia.v3.api.BaseDisplayContainer
+import com.google.ads.interactivemedia.v3.api.CompanionAdSlot
+
 /**
  * ProxyApi implementation for [com.google.ads.interactivemedia.v3.api.BaseDisplayContainer].
  *
  * <p>This class may handle instantiating native object instances that are attached to a Dart
  * instance or handle method calls on the associated native class or an instance of that class.
  */
 class BaseDisplayContainerProxyApi(override val pigeonRegistrar: ProxyApiRegistrar) :
-    PigeonApiBaseDisplayContainer(pigeonRegistrar)
+    PigeonApiBaseDisplayContainer(pigeonRegistrar) {
+  override fun setCompanionSlots(
+      pigeon_instance: BaseDisplayContainer,
+      companionSlots: List<CompanionAdSlot>?
+  ) {
+    return pigeon_instance.setCompanionSlots(companionSlots)
+  }
+}

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

@@ -47,4 +47,8 @@ class CompanionAdSlotProxyApi(override val pigeonRegistrar: ProxyApiRegistrar) :
   override fun setSize(pigeon_instance: CompanionAdSlot, width: Long, height: Long) {
     pigeon_instance.setSize(width.toInt(), height.toInt())
   }
+
+  override fun setFluidSize(pigeon_instance: CompanionAdSlot) {
+    pigeon_instance.setSize(CompanionAdSlot.FLUID_SIZE, CompanionAdSlot.FLUID_SIZE)
+  }
 }

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

@@ -9,6 +9,7 @@ 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.CompanionAdSlot
 import com.google.ads.interactivemedia.v3.api.ImaSdkFactory
 import com.google.ads.interactivemedia.v3.api.ImaSdkSettings
 import com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer
@@ -32,6 +33,10 @@ class ImaSdkFactoryProxyApi(override val pigeonRegistrar: ProxyApiRegistrar) :
     return ImaSdkFactory.createAdDisplayContainer(container, player)
   }
 
+  override fun createCompanionAdSlot(pigeon_instance: ImaSdkFactory): CompanionAdSlot {
+    return pigeon_instance.createCompanionAdSlot()
+  }
+
   override fun createImaSdkSettings(pigeon_instance: ImaSdkFactory): ImaSdkSettings {
     return pigeon_instance.createImaSdkSettings()
   }

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.3.1), do not edit directly.
+// Autogenerated from Pigeon (v25.3.2), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 @file:Suppress("UNCHECKED_CAST", "ArrayInDataClass")
 
@@ -387,9 +387,7 @@ abstract class InteractiveMediaAdsLibraryPigeonProxyApiRegistrar(
    * An implementation of [PigeonApiBaseDisplayContainer] used to add a new Dart instance of
    * `BaseDisplayContainer` to the Dart `InstanceManager`.
    */
-  open fun getPigeonApiBaseDisplayContainer(): PigeonApiBaseDisplayContainer {
-    return PigeonApiBaseDisplayContainer(this)
-  }
+  abstract fun getPigeonApiBaseDisplayContainer(): PigeonApiBaseDisplayContainer
 
   /**
    * An implementation of [PigeonApiAdDisplayContainer] used to add a new Dart instance of
@@ -592,6 +590,8 @@ abstract class InteractiveMediaAdsLibraryPigeonProxyApiRegistrar(
   fun setUp() {
     InteractiveMediaAdsLibraryPigeonInstanceManagerApi.setUpMessageHandlers(
         binaryMessenger, instanceManager)
+    PigeonApiBaseDisplayContainer.setUpMessageHandlers(
+        binaryMessenger, getPigeonApiBaseDisplayContainer())
     PigeonApiAdsLoader.setUpMessageHandlers(binaryMessenger, getPigeonApiAdsLoader())
     PigeonApiAdsRequest.setUpMessageHandlers(binaryMessenger, getPigeonApiAdsRequest())
     PigeonApiContentProgressProvider.setUpMessageHandlers(
@@ -621,6 +621,7 @@ abstract class InteractiveMediaAdsLibraryPigeonProxyApiRegistrar(
 
   fun tearDown() {
     InteractiveMediaAdsLibraryPigeonInstanceManagerApi.setUpMessageHandlers(binaryMessenger, null)
+    PigeonApiBaseDisplayContainer.setUpMessageHandlers(binaryMessenger, null)
     PigeonApiAdsLoader.setUpMessageHandlers(binaryMessenger, null)
     PigeonApiAdsRequest.setUpMessageHandlers(binaryMessenger, null)
     PigeonApiContentProgressProvider.setUpMessageHandlers(binaryMessenger, null)
@@ -1004,9 +1005,55 @@ private open class InteractiveMediaAdsLibraryPigeonCodec : StandardMessageCodec(
  * https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/api/reference/com/google/ads/interactivemedia/v3/api/BaseDisplayContainer.html.
  */
 @Suppress("UNCHECKED_CAST")
-open class PigeonApiBaseDisplayContainer(
+abstract class PigeonApiBaseDisplayContainer(
     open val pigeonRegistrar: InteractiveMediaAdsLibraryPigeonProxyApiRegistrar
 ) {
+  /**
+   * Sets slots for displaying companions.
+   *
+   * Passing null will reset the container to having no companion slots.
+   */
+  abstract fun setCompanionSlots(
+      pigeon_instance: com.google.ads.interactivemedia.v3.api.BaseDisplayContainer,
+      companionSlots: List<com.google.ads.interactivemedia.v3.api.CompanionAdSlot>?
+  )
+
+  companion object {
+    @Suppress("LocalVariableName")
+    fun setUpMessageHandlers(
+        binaryMessenger: BinaryMessenger,
+        api: PigeonApiBaseDisplayContainer?
+    ) {
+      val codec = api?.pigeonRegistrar?.codec ?: InteractiveMediaAdsLibraryPigeonCodec()
+      run {
+        val channel =
+            BasicMessageChannel<Any?>(
+                binaryMessenger,
+                "dev.flutter.pigeon.interactive_media_ads.BaseDisplayContainer.setCompanionSlots",
+                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.BaseDisplayContainer
+            val companionSlotsArg =
+                args[1] as List<com.google.ads.interactivemedia.v3.api.CompanionAdSlot>?
+            val wrapped: List<Any?> =
+                try {
+                  api.setCompanionSlots(pigeon_instanceArg, companionSlotsArg)
+                  listOf(null)
+                } catch (exception: Throwable) {
+                  InteractiveMediaAdsLibraryPigeonUtils.wrapError(exception)
+                }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
+    }
+  }
+
   @Suppress("LocalVariableName", "FunctionName")
   /** Creates a Dart instance of BaseDisplayContainer and attaches it to [pigeon_instanceArg]. */
   fun pigeon_newInstance(
@@ -2267,6 +2314,11 @@ abstract class PigeonApiImaSdkFactory(
       player: com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer
   ): com.google.ads.interactivemedia.v3.api.AdDisplayContainer
 
+  /** Creates a CompanionAdSlot for the SDK to fill with companion ads. */
+  abstract fun createCompanionAdSlot(
+      pigeon_instance: com.google.ads.interactivemedia.v3.api.ImaSdkFactory
+  ): com.google.ads.interactivemedia.v3.api.CompanionAdSlot
+
   /** Creates an `ImaSdkSettings` object for configuring the IMA SDK. */
   abstract fun createImaSdkSettings(
       pigeon_instance: com.google.ads.interactivemedia.v3.api.ImaSdkFactory
@@ -2343,6 +2395,28 @@ abstract class PigeonApiImaSdkFactory(
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel =
+            BasicMessageChannel<Any?>(
+                binaryMessenger,
+                "dev.flutter.pigeon.interactive_media_ads.ImaSdkFactory.createCompanionAdSlot",
+                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.createCompanionAdSlot(pigeon_instanceArg))
+                } catch (exception: Throwable) {
+                  InteractiveMediaAdsLibraryPigeonUtils.wrapError(exception)
+                }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
       run {
         val channel =
             BasicMessageChannel<Any?>(
@@ -5561,6 +5635,14 @@ abstract class PigeonApiCompanionAdSlot(
       height: Long
   )
 
+  /**
+   * Sets the size of the slot as fluid.
+   *
+   * This is a convenience method that sets both parameters of [setSize] to
+   * [CompanionAdSlot.FLUID_SIZE](https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/api/reference/com/google/ads/interactivemedia/v3/api/CompanionAdSlot#FLUID_SIZE()).
+   */
+  abstract fun setFluidSize(pigeon_instance: com.google.ads.interactivemedia.v3.api.CompanionAdSlot)
+
   companion object {
     @Suppress("LocalVariableName")
     fun setUpMessageHandlers(binaryMessenger: BinaryMessenger, api: PigeonApiCompanionAdSlot?) {
@@ -5760,6 +5842,30 @@ abstract class PigeonApiCompanionAdSlot(
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel =
+            BasicMessageChannel<Any?>(
+                binaryMessenger,
+                "dev.flutter.pigeon.interactive_media_ads.CompanionAdSlot.setFluidSize",
+                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.CompanionAdSlot
+            val wrapped: List<Any?> =
+                try {
+                  api.setFluidSize(pigeon_instanceArg)
+                  listOf(null)
+                } catch (exception: Throwable) {
+                  InteractiveMediaAdsLibraryPigeonUtils.wrapError(exception)
+                }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
     }
   }
 

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

@@ -0,0 +1,24 @@
+// 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.
+
+package dev.flutter.packages.interactive_media_ads
+
+import com.google.ads.interactivemedia.v3.api.BaseDisplayContainer
+import com.google.ads.interactivemedia.v3.api.CompanionAdSlot
+import kotlin.test.Test
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.verify
+
+class BaseDisplayContainerProxyApiTest {
+  @Test
+  fun setCompanionSlots() {
+    val api = TestProxyApiRegistrar().getPigeonApiBaseDisplayContainer()
+
+    val instance = mock<BaseDisplayContainer>()
+    val companionSlots = listOf(mock<CompanionAdSlot>())
+    api.setCompanionSlots(instance, companionSlots)
+
+    verify(instance).setCompanionSlots(companionSlots)
+  }
+}

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

@@ -101,4 +101,14 @@ class CompanionAdSlotProxyApiTest {
 
     verify(instance).setSize(width.toInt(), height.toInt())
   }
+
+  @Test
+  fun setFluidSize() {
+    val api = TestProxyApiRegistrar().getPigeonApiCompanionAdSlot()
+
+    val instance = mock<CompanionAdSlot>()
+    api.setFluidSize(instance)
+
+    verify(instance).setSize(CompanionAdSlot.FLUID_SIZE, CompanionAdSlot.FLUID_SIZE)
+  }
 }

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

@@ -8,6 +8,7 @@ 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.CompanionAdSlot
 import com.google.ads.interactivemedia.v3.api.ImaSdkFactory
 import com.google.ads.interactivemedia.v3.api.ImaSdkSettings
 import kotlin.test.Test
@@ -42,6 +43,17 @@ class ImaSdkFactoryProxyApiTest {
     assertEquals(mockAdsLoader, api.createAdsLoader(instance, mockSettings, mockContainer))
   }
 
+  @Test
+  fun createCompanionAdSlot() {
+    val api = TestProxyApiRegistrar().getPigeonApiImaSdkFactory()
+
+    val instance = mock<ImaSdkFactory>()
+    val mockAdSlot = mock<CompanionAdSlot>()
+    whenever(instance.createCompanionAdSlot()).thenReturn(mockAdSlot)
+
+    assertEquals(mockAdSlot, api.createCompanionAdSlot(instance))
+  }
+
   @Test
   fun createAdsRequest() {
     val api = TestProxyApiRegistrar().getPigeonApiImaSdkFactory()

packages/interactive_media_ads/example/ios/RunnerTests/ViewTests.swift

@@ -0,0 +1,20 @@
+// 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 Flutter
+import XCTest
+
+@testable import interactive_media_ads
+
+final class ViewTests: XCTestCase {
+  func testPigeonDefaultConstructor() {
+    let registrar = TestProxyApiRegistrar()
+    let api = registrar.apiDelegate.pigeonApiUIView(registrar)
+
+    let instance = try? api.pigeonDelegate.pigeonDefaultConstructor(
+      pigeonApi: api)
+
+    XCTAssertNotNil(instance)
+  }
+}