Add PeekAdResponseInfo API to AppOpenAdPreloader.

PiperOrigin-RevId: 957225291

Author: Mobile Ads Developer Relations

source/plugin/Assets/GoogleMobileAds/Api/AppOpenAdPreloader.cs

@@ -127,7 +127,7 @@ public static Dictionary<string, PreloadConfiguration> GetConfigurations()
         /// Returns a preloaded ad and removes it from the cache.
         /// </summary>
         /// <param name="preloadId">
-        /// The ad's preload ID.
+        /// A string identifier used to preload the ads for that configuration.
         /// </param>
         /// <returns>
         /// The preloaded ad for the given preload ID, or null if no ad is available.
@@ -146,6 +146,26 @@ public static AppOpenAd DequeueAd(string preloadId)
             return new AppOpenAd(client);
         }
 
+        /// <summary>
+        /// Returns the ResponseInfo of a preloaded ad for the given preload ID without
+        /// dequeuing it, or null if no ad is available.
+        /// </summary>
+        /// <param name="preloadId">
+        /// A string identifier used to preload the ads for that configuration.
+        /// </param>
+        /// <returns>
+        /// The ResponseInfo of the preloaded ad for the given preload ID, or null if no ad is available.
+        /// </returns>
+        public static ResponseInfo PeekAdResponseInfo(string preloadId)
+        {
+            var responseInfoClient = _client.PeekAdResponseInfo(preloadId);
+            if (responseInfoClient == null)
+            {
+                return null;
+            }
+            return new ResponseInfo(responseInfoClient);
+        }
+
         /// <summary>
         /// Get the number of ads available for the given preload ID.
         /// </summary>

source/plugin/Assets/GoogleMobileAds/Common/IAppOpenAdPreloaderClient.cs

@@ -76,6 +76,18 @@ bool Preload(string preloadId, PreloadConfiguration preloadConfiguration,
         /// </remarks>
         IAppOpenAdClient DequeueAd(string preloadId);
 
+        /// <summary>
+        /// Returns the ResponseInfo of an ad available for the given preload ID without
+        /// dequeuing it, or null if no ad is available.
+        /// </summary>
+        /// <param name="preloadId">
+        /// A string identifier used to preload the ads for that configuration.
+        /// </param>
+        /// <returns>
+        /// The ResponseInfo of the preloaded ad for the given preload ID, or null if no ad is available.
+        /// </returns>
+        IResponseInfoClient PeekAdResponseInfo(string preloadId);
+
         /// <summary>
         /// Get the number of ads available for the given preload ID.
         /// </summary>

source/plugin/Assets/GoogleMobileAds/Platforms/Android/AppOpenAdPreloaderClient.cs

@@ -70,6 +70,13 @@ public IAppOpenAdClient DequeueAd(string preloadId)
             return appOpenAdClient;
         }
 
+        public IResponseInfoClient PeekAdResponseInfo(string preloadId)
+        {
+            UnityEngine.Debug.LogError(
+                "PeekAdResponseInfo API is not available on the Legacy version of Google Mobile Ads Android SDK.");
+            return null;
+        }
+
         public int GetNumAdsAvailable(string preloadId)
         {
             return _unityAppOpenAdPreloader.Call<int>("getNumAdsAvailable", preloadId);

source/plugin/Assets/GoogleMobileAds/Platforms/Android/NextGenAppOpenAdPreloaderClient.cs

@@ -62,6 +62,11 @@ public IAppOpenAdClient DequeueAd(string preloadId) {
       return appOpenAdClient;
     }
 
+    public IResponseInfoClient PeekAdResponseInfo(string preloadId) {
+      // TODO: Implement Android Peek API
+      return null;
+    }
+
     public int GetNumAdsAvailable(string preloadId) {
       return _unityAppOpenAdPreloader.Call<int>("getNumAdsAvailable", preloadId);
     }

source/plugin/Assets/GoogleMobileAds/Platforms/Unity/AppOpenAdPreloaderClient.cs

@@ -126,6 +126,17 @@ public IAppOpenAdClient DequeueAd(string preloadId)
             return null;
         }
 
+        public IResponseInfoClient PeekAdResponseInfo(string preloadId)
+        {
+            Queue<AppOpenAdClient> queue;
+            if (_bufferedAds.TryGetValue(preloadId, out queue) && queue.Count > 0)
+            {
+                AppOpenAdClient adClient = queue.Peek();
+                return adClient.GetResponseInfoClient();
+            }
+            return null;
+        }
+
         public int GetNumAdsAvailable(string preloadId)
         {
             Queue<AppOpenAdClient> queue;

source/plugin/Assets/GoogleMobileAds/Platforms/iOS/AppOpenAdPreloaderClient.cs

@@ -122,6 +122,21 @@ public IAppOpenAdClient DequeueAd(string preloadId)
             return appOpenAdClient;
         }
 
+        public IResponseInfoClient PeekAdResponseInfo(string preloadId)
+        {
+            if (AppOpenAdPreloaderPtr == IntPtr.Zero)
+            {
+                return null;
+            }
+            var responseInfoPtr = Externs.GADUAppOpenAdPreloaderPeekAdResponseInfo(
+                    AppOpenAdPreloaderPtr, preloadId);
+            if (responseInfoPtr == IntPtr.Zero)
+            {
+                return null;
+            }
+            return new ResponseInfoClient(responseInfoPtr);
+        }
+
         public int GetNumAdsAvailable(string preloadId)
         {
             if (AppOpenAdPreloaderPtr == IntPtr.Zero)

source/plugin/Assets/GoogleMobileAds/Platforms/iOS/Externs.cs

@@ -325,6 +325,10 @@ internal static extern IntPtr GADUAppOpenAdPreloaderDequeueAd(IntPtr appOpenAdPr
                                                                     string preloadId,
                                                                     IntPtr appOpenAdClientPtr);
 
+      [DllImport("__Internal")]
+      internal static extern IntPtr GADUAppOpenAdPreloaderPeekAdResponseInfo(
+          IntPtr appOpenAdPreloader, string preloadId);
+
       [DllImport("__Internal")]
       internal static extern int GADUAppOpenAdPreloaderGetNumAdsAvailable(IntPtr appOpenAdPreloader,
                                                                           string preloadId);

source/plugin/Assets/Plugins/iOS/GADUAppOpenAdPreloader.h

@@ -78,6 +78,9 @@
                            appOpenAdClient:
                                (_Nonnull GADUTypeAppOpenAdClientRef *_Nonnull)appOpenAdClient;
 
+/// Returns the responseInfo of a preloaded app open ad for the given preload ID.
+- (nullable GADResponseInfo *)adResponseInfoWithPreloadID:(nonnull NSString *)preloadID;
+
 /// Returns the corresponding configuration for the given preload ID.
 - (nullable GADUPreloadConfigurationV2 *)configurationWithPreloadID:(nonnull NSString *)preloadID;
 

source/plugin/Assets/Plugins/iOS/GADUAppOpenAdPreloader.m

@@ -72,6 +72,10 @@ - (nullable GADUAppOpenAd *)adWithPreloadID:(nonnull NSString *)preloadID
   return nil;
 }
 
+- (nullable GADResponseInfo *)adResponseInfoWithPreloadID:(nonnull NSString *)preloadID {
+  return [GADAppOpenAdPreloader.sharedInstance adResponseInfoWithPreloadID:preloadID];
+}
+
 - (nullable GADUPreloadConfigurationV2 *)configurationWithPreloadID:(nonnull NSString *)preloadID {
   GADPreloadConfigurationV2 *config =
       [GADAppOpenAdPreloader.sharedInstance configurationWithPreloadID:preloadID];

source/plugin/Assets/Plugins/iOS/GADUInterface.m

@@ -959,6 +959,23 @@ GADUTypeAppOpenAdRef GADUAppOpenAdPreloaderDequeueAd(
   return nil;
 }
 
+GADUTypeResponseInfoRef GADUAppOpenAdPreloaderPeekAdResponseInfo(
+    GADUTypeAppOpenAdPreloaderRef appOpenAdPreloader, const char *preloadId) {
+  GADUAppOpenAdPreloader *internalAppOpenAdPreloader =
+      (__bridge GADUAppOpenAdPreloader *)appOpenAdPreloader;
+  if (!internalAppOpenAdPreloader) {
+    return nil;
+  }
+  GADResponseInfo *responseInfo = [internalAppOpenAdPreloader
+      adResponseInfoWithPreloadID:GADUStringFromUTF8String(preloadId)];
+  if (responseInfo) {
+    GADUObjectCache *cache = GADUObjectCache.sharedInstance;
+    cache[responseInfo.gadu_referenceKey] = responseInfo;
+    return (__bridge GADUTypeResponseInfoRef)responseInfo;
+  }
+  return nil;
+}
+
 unsigned long GADUAppOpenAdPreloaderGetNumAdsAvailable(
     GADUTypeAppOpenAdPreloaderRef appOpenAdPreloader, const char *preloadId) {
   GADUAppOpenAdPreloader *internalAppOpenAdPreloader =