Add PlacementId to InterstitialAd.

Mobile Ads Developer Relations · copybara-github · commit 2f48f363744d · 2025-09-02T20:06:05.000-07:00
PiperOrigin-RevId: 802374779
diff --git a/source/plugin/Assets/GoogleMobileAds/Api/InterstitialAd.cs b/source/plugin/Assets/GoogleMobileAds/Api/InterstitialAd.cs
@@ -58,6 +58,26 @@ public class InterstitialAd
         /// </summary>
         public event Action<AdError> OnAdFullScreenContentFailed;
 
+        /// <summary>
+        /// A long integer provided by the AdMob UI for the configured placement.
+        /// To ensure this placement ID is included in reporting, set a value before showing the ad.
+        /// </summary>
+        public long PlacementId
+        {
+            get
+            {
+                return _client != null ? _client.PlacementId : 0;
+            }
+
+            set
+            {
+                if (_client != null)
+                {
+                    _client.PlacementId = value;
+                }
+            }
+        }
+
         protected internal IInterstitialClient _client;
         protected internal bool _canShowAd;
 
diff --git a/source/plugin/Assets/GoogleMobileAds/Common/IInterstitialClient.cs b/source/plugin/Assets/GoogleMobileAds/Common/IInterstitialClient.cs
@@ -38,6 +38,9 @@ public interface IInterstitialClient
         // Ad event fired when an ad has been clicked.
         event Action OnAdClicked;
 
+        // A long integer provided by the AdMob UI for the configured placement.
+        long PlacementId { get; set; }
+
         // Creates an interstitial ad.
         void CreateInterstitialAd();
 
diff --git a/source/plugin/Assets/GoogleMobileAds/Platforms/Android/AdManagerInterstitialClient.cs b/source/plugin/Assets/GoogleMobileAds/Platforms/Android/AdManagerInterstitialClient.cs
@@ -41,6 +41,9 @@ public class AdManagerInterstitialClient : AndroidJavaProxy, IAdManagerInterstit
 
         public event Action OnAdClicked;
 
+        // Placement ID is not supported for AdManagerInterstitialAd.
+        public long PlacementId { get; set; }
+
         private AndroidJavaObject _androidAdmanagerInterstitialAd;
 
         public AdManagerInterstitialClient() :
diff --git a/source/plugin/Assets/GoogleMobileAds/Platforms/Android/InterstitialClient.cs b/source/plugin/Assets/GoogleMobileAds/Platforms/Android/InterstitialClient.cs
@@ -49,6 +49,19 @@ public InterstitialClient() : base(Utils.UnityInterstitialAdCallbackClassName)
 
         public event Action OnAdClicked;
 
+        // A long integer provided by the AdMob UI for the configured placement.
+        public long PlacementId
+        {
+            get
+            {
+                return this.androidInterstitialAd.Call<long>("getPlacementId");
+            }
+            set
+            {
+                this.androidInterstitialAd.Call("setPlacementId", value);
+            }
+        }
+
         #region IGoogleMobileAdsInterstitialClient implementation
 
         // Creates an interstitial ad.
diff --git a/source/plugin/Assets/GoogleMobileAds/Platforms/Unity/AdManagerInterstitialClient.cs b/source/plugin/Assets/GoogleMobileAds/Platforms/Unity/AdManagerInterstitialClient.cs
@@ -26,6 +26,9 @@ public class AdManagerInterstitialClient : InterstitialClient, IAdManagerInterst
 
 #if GMA_PREVIEW_FEATURES
 
+        // Placement ID is not supported for AdManagerInterstitialAd.
+        public new long PlacementId { get; set; }
+
         public IAdManagerInterstitialClient PollAdManagerAd(string adUnitId)
         {
             Debug.Log("Preloaded ads are not supported on the Unity editor platform.");
diff --git a/source/plugin/Assets/GoogleMobileAds/Platforms/Unity/InterstitialClient.cs b/source/plugin/Assets/GoogleMobileAds/Platforms/Unity/InterstitialClient.cs
@@ -41,6 +41,9 @@ public class InterstitialClient : BaseAdClient, IInterstitialClient
 
         public event Action OnAdClicked;
 
+        // A long integer provided by the AdMob UI for the configured placement.
+        public long PlacementId { get; set; }
+
         private Dictionary<AdSize, string> prefabAds = new Dictionary<AdSize, string>() {
             {new AdSize (768,1024), "PlaceholderAds/Interstitials/768x1024" },
             {new AdSize (1024,768), "PlaceholderAds/Interstitials/1024x768"}
diff --git a/source/plugin/Assets/GoogleMobileAds/Platforms/iOS/AdManagerInterstitialClient.cs b/source/plugin/Assets/GoogleMobileAds/Platforms/iOS/AdManagerInterstitialClient.cs
@@ -81,6 +81,9 @@ internal delegate void GADUInterstitialAdDidRecordImpressionCallback(
 
         public event Action OnAdClicked;
 
+        // Placement ID is not supported for AdManagerInterstitialAd.
+        public long PlacementId { get; set; }
+
         private IntPtr _interstitialClientPtr;
 
         private IntPtr _interstitialPtr;
diff --git a/source/plugin/Assets/GoogleMobileAds/Platforms/iOS/Externs.cs b/source/plugin/Assets/GoogleMobileAds/Platforms/iOS/Externs.cs
@@ -621,8 +621,14 @@ internal static extern void GADUInterstitialPreloadedAdWithAdUnitID(IntPtr inter
       internal static extern IntPtr GADULoadInterstitialAd(IntPtr interstitialAd, string adUnitID,
                                                            IntPtr request);
 
-      [DllImport("__Internal")]
-      internal static extern string GADUGetInterstitialAdUnitID(IntPtr interstitialAd);
+        [DllImport("__Internal")]
+        internal static extern string GADUGetInterstitialAdUnitID(IntPtr interstitialAd);
+
+        [DllImport("__Internal")]
+        internal static extern long GADUGetInterstitialAdPlacementID(IntPtr interstitialAd);
+
+        [DllImport("__Internal")]
+        internal static extern void GADUSetInterstitialAdPlacementID(IntPtr interstitialAd, long placementId);
 
       [DllImport("__Internal")]
       internal static extern void GADUSetInterstitialCallbacks(
diff --git a/source/plugin/Assets/GoogleMobileAds/Platforms/iOS/InterstitialClient.cs b/source/plugin/Assets/GoogleMobileAds/Platforms/iOS/InterstitialClient.cs
@@ -69,6 +69,19 @@ internal delegate void GADUInterstitialPaidEventCallback(
 
         public event Action OnAdClicked;
 
+        // A long integer provided by the AdMob UI for the configured placement.
+        public long PlacementId
+        {
+            get
+            {
+                return Externs.GADUGetInterstitialAdPlacementID(InterstitialPtr);
+            }
+            set
+            {
+                Externs.GADUSetInterstitialAdPlacementID(InterstitialPtr, value);
+            }
+        }
+
         // This property should be used when setting the interstitialPtr.
         private IntPtr InterstitialPtr
         {
diff --git a/source/plugin/Assets/PlayServicesResolver.meta b/source/plugin/Assets/PlayServicesResolver.meta
diff --git a/source/plugin/Assets/Plugins/Android/GoogleMobileAdsPlugin.androidlib/src/main/java/com/google/unity/ads/Interstitial.java b/source/plugin/Assets/Plugins/Android/GoogleMobileAdsPlugin.androidlib/src/main/java/com/google/unity/ads/Interstitial.java
@@ -214,6 +214,29 @@ public void pollAd(@NonNull String adUnitId) {
     }
   }
 
+  /** Gets the placement ID for the {@link InterstitialAd}. */
+  public long getPlacementId() {
+    if (interstitialAd == null) {
+      return 0;
+    }
+    return interstitialAd.getPlacementId();
+  }
+
+  /**
+   * Sets a placement ID for the {@link InterstitialAd}.
+   *
+   * <p>To ensure this placement ID is included in reporting, call this method before showing the
+   * ad.
+   *
+   * @param placementId A long integer provided by the AdMob UI for the configured placement.
+   */
+  public void setPlacementId(long placementId) {
+    if (interstitialAd == null) {
+      return;
+    }
+    interstitialAd.setPlacementId(placementId);
+  }
+
   /** Returns the {@link InterstitialAd} ad unit ID. */
   @Nullable
   public String getAdUnitId() {
diff --git a/source/plugin/Assets/Plugins/Android/GoogleMobileAdsPlugin.androidlib/src/test/java/com/google/unity/ads/InterstitialTest.java b/source/plugin/Assets/Plugins/Android/GoogleMobileAdsPlugin.androidlib/src/test/java/com/google/unity/ads/InterstitialTest.java
@@ -155,6 +155,39 @@ public void showAd_shouldEnableImmersiveMode_whenLoaded() throws Exception {
     verify(mockAdManager).setImmersiveMode(eq(true));
   }
 
+  @Test
+  public void getPlacementId_returnsPlacementIdFromTheAd() throws Exception {
+    loadInterstitialAd();
+    long placementId = 12345L;
+    when(mockAdManager.getPlacementId()).thenReturn(placementId);
+
+    long result = interstitial.getPlacementId();
+
+    assertThat(result).isEqualTo(placementId);
+  }
+
+  @Test
+  public void setPlacementId_setsPlacementIdOnTheAd() throws Exception {
+    loadInterstitialAd();
+    long placementId = 54321L;
+
+    interstitial.setPlacementId(placementId);
+
+    verify(mockAdManager).setPlacementId(placementId);
+  }
+
+  @Test
+  public void getPlacementId_returnsPreviouslySetPlacementId() throws Exception {
+    loadInterstitialAd();
+    long placementId = 23456L;
+
+    interstitial.setPlacementId(placementId);
+    long result = interstitial.getPlacementId();
+
+    verify(mockAdManager).setPlacementId(placementId);
+    assertThat(result).isEqualTo(placementId);
+  }
+
   private void loadInterstitialAd() throws Exception {
     doAnswer(
             invocation -> {
diff --git a/source/plugin/Assets/Plugins/iOS/GADUInterface.m b/source/plugin/Assets/Plugins/iOS/GADUInterface.m
@@ -1267,6 +1267,18 @@ void GADUShowInterstitial(GADUTypeInterstitialRef interstitial) {
   return cStringCopy(internalInterstitial.interstitialAd.adUnitID.UTF8String);
 }
 
+// Get the Interstitial ad placement ID.
+int64_t GADUGetInterstitialAdPlacementID(GADUTypeInterstitialRef interstitial) {
+  GADUInterstitial *internalInterstitial = (__bridge GADUInterstitial *)interstitial;
+  return internalInterstitial.interstitialAd.placementID;
+}
+
+// Set the Interstitial ad placement ID.
+void GADUSetInterstitialAdPlacementID(GADUTypeInterstitialRef interstitial, int64_t placementID) {
+  GADUInterstitial *internalInterstitial = (__bridge GADUInterstitial *)interstitial;
+  [internalInterstitial setPlacementID:placementID];
+}
+
 /// Shows the GAMInterstitial.
 void GAMUShowInterstitial(GAMUTypeInterstitialRef interstitial) {
   GAMUInterstitial *internalInterstitial = (__bridge GAMUInterstitial *)interstitial;
diff --git a/source/plugin/Assets/Plugins/iOS/GADUInterstitial.h b/source/plugin/Assets/Plugins/iOS/GADUInterstitial.h
@@ -53,6 +53,9 @@
 // Returns the interstitial ad response info.
 @property(nonatomic, readonly, copy) GADResponseInfo *responseInfo;
 
+// A long integer provided by the AdMob UI for the configured placement.
+@property(atomic, readwrite) int64_t placementID;
+
 #if GMA_PREVIEW_FEATURES
 
 /// Returns whether an interstitial ad is preloaded for the given ad unit ID.
diff --git a/source/plugin/Assets/Plugins/iOS/GADUInterstitial.m b/source/plugin/Assets/Plugins/iOS/GADUInterstitial.m
@@ -83,6 +83,14 @@ - (GADResponseInfo *)responseInfo {
   return self.interstitialAd.responseInfo;
 }
 
+- (int64_t)placementID {
+  return _interstitialAd.placementID;
+}
+
+- (void)setPlacementID:(int64_t)placementID {
+  _interstitialAd.placementID = placementID;
+}
+
 #pragma mark GADFullScreenContentDelegate implementation
 
 - (void)ad:(nonnull id<GADFullScreenPresentingAd>)ad

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@ public class AdManagerInterstitialClient : InterstitialClient, IAdManagerInterst`
`26`	`26`
`27`	`27`	`#if GMA_PREVIEW_FEATURES`
`28`	`28`
	`29`	`+ // Placement ID is not supported for AdManagerInterstitialAd.`
	`30`	`+ public new long PlacementId { get; set; }`
	`31`	`+`
`29`	`32`	`public IAdManagerInterstitialClient PollAdManagerAd(string adUnitId)`
`30`	`33`	`{`
`31`	`34`	`Debug.Log("Preloaded ads are not supported on the Unity editor platform.");`