Add unit tests for InterstitialAdPreloader.PeekAdResponseInfo.

PiperOrigin-RevId: 952413031

Author: Mobile Ads Developer Relations

source/plugin/Assets/GoogleMobileAds/Api/InterstitialAdPreloader.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 InterstitialAd DequeueAd(string preloadId)
             return new InterstitialAd(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/IInterstitialAdPreloaderClient.cs

@@ -65,7 +65,7 @@ bool Preload(string preloadId, PreloadConfiguration preloadConfiguration,
         /// 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.
@@ -76,6 +76,18 @@ bool Preload(string preloadId, PreloadConfiguration preloadConfiguration,
         /// </remarks>
         IInterstitialClient 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/InterstitialAdPreloaderClient.cs

@@ -70,6 +70,13 @@ public IInterstitialClient DequeueAd(string preloadId)
             return interstitialClient;
         }
 
+        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 _unityInterstitialPreloader.Call<int>("getNumAdsAvailable", preloadId);

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

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

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

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

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

@@ -414,6 +414,10 @@ internal static extern bool GADUInterstitialAdPreloaderIsAdAvailable(
       internal static extern IntPtr GADUInterstitialAdPreloaderDequeueAd(
           IntPtr interstitialAdPreloader, string preloadId, IntPtr appOpenAdClientPtr);
 
+      [DllImport("__Internal")]
+      internal static extern IntPtr GADUInterstitialAdPreloaderPeekAdResponseInfo(
+          IntPtr interstitialAdPreloader, string preloadId);
+
       [DllImport("__Internal")]
       internal static extern int GADUInterstitialAdPreloaderGetNumAdsAvailable(
           IntPtr interstitialAdPreloader, string preloadId);

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

@@ -124,6 +124,21 @@ public IInterstitialClient DequeueAd(string preloadId)
             return interstitialAdClient;
         }
 
+        public IResponseInfoClient PeekAdResponseInfo(string preloadId)
+        {
+            if (InterstitialAdPreloaderPtr == IntPtr.Zero)
+            {
+                return null;
+            }
+            var responseInfoPtr = Externs.GADUInterstitialAdPreloaderPeekAdResponseInfo(
+                    InterstitialAdPreloaderPtr, preloadId);
+            if (responseInfoPtr == IntPtr.Zero)
+            {
+                return null;
+            }
+            return new ResponseInfoClient(responseInfoPtr);
+        }
+
         public int GetNumAdsAvailable(string preloadId)
         {
             if (InterstitialAdPreloaderPtr == IntPtr.Zero)

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

@@ -1155,6 +1155,23 @@ GADUTypeInterstitialRef GADUInterstitialAdPreloaderDequeueAd(
   return nil;
 }
 
+GADUTypeResponseInfoRef GADUInterstitialAdPreloaderPeekAdResponseInfo(
+    GADUTypeInterstitialAdPreloaderClientRef interstitialAdPreloader, const char *preloadId) {
+  GADUInterstitialAdPreloader *internalInterstitialAdPreloader =
+      (__bridge GADUInterstitialAdPreloader *)interstitialAdPreloader;
+  if (!internalInterstitialAdPreloader) {
+    return nil;
+  }
+  GADResponseInfo *responseInfo = [internalInterstitialAdPreloader
+      adResponseInfoWithPreloadID:GADUStringFromUTF8String(preloadId)];
+  if (responseInfo) {
+    GADUObjectCache *cache = GADUObjectCache.sharedInstance;
+    cache[responseInfo.gadu_referenceKey] = responseInfo;
+    return (__bridge GADUTypeResponseInfoRef)responseInfo;
+  }
+  return nil;
+}
+
 unsigned long GADUInterstitialAdPreloaderGetNumAdsAvailable(
     GADUTypeInterstitialAdPreloaderClientRef interstitialAdPreloader, const char *preloadId) {
   GADUInterstitialAdPreloader *internalInterstitialAdPreloader =

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

@@ -65,6 +65,10 @@
                            interstitialAdClient:(_Nonnull GADUTypeInterstitialClientRef *_Nonnull)
                                                     interstitialAdClient;
 
+/// Returns the response info of a preloaded interstitial ad for the given preload ID without
+/// removing the ad from the queue. Returns nil if an ad is not available.
+- (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/GADUInterstitialAdPreloader.m

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