Add PlacementId to RewardedAd.

PiperOrigin-RevId: 802381820

Author: Mobile Ads Developer Relations

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

@@ -57,6 +57,26 @@ public class RewardedAd
         /// </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;
+                }
+            }
+        }
+
         private IRewardedAdClient _client;
         private bool _canShowAd;
         private Action<Reward> _userRewardEarnedCallback;

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

@@ -22,23 +22,34 @@ public interface IRewardedAdClient
     {
         // Ad event fired when the rewarded ad has been received.
         event EventHandler<EventArgs> OnAdLoaded;
+
         // Ad event fired when the rewarded ad has failed to load.
         event EventHandler<LoadAdErrorClientEventArgs> OnAdFailedToLoad;
+
         // Ad event fired when the rewarded ad is estimated to have earned money.
         event Action<AdValue> OnPaidEvent;
+
         // Ad event fired when the rewarded ad has rewarded the user.
         event EventHandler<Reward> OnUserEarnedReward;
+
         // Ad event fired when the full screen content has failed to be presented.
         event EventHandler<AdErrorClientEventArgs> OnAdFailedToPresentFullScreenContent;
+
         // Ad event fired when the full screen content has been presented.
         event EventHandler<EventArgs> OnAdDidPresentFullScreenContent;
+
         // Ad event fired when the full screen content has been dismissed.
         event EventHandler<EventArgs> OnAdDidDismissFullScreenContent;
+
         // Ad event fired when an ad impression has been recorded.
         event EventHandler<EventArgs> OnAdDidRecordImpression;
+
         // 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 a rewarded ad.
         void CreateRewardedAd();
 

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

@@ -52,6 +52,17 @@ public RewardedAdClient() : base(Utils.UnityRewardedAdCallbackClassName)
 
         public event Action OnAdClicked;
 
+        public long PlacementId {
+            get
+            {
+                return androidRewardedAd.Call<long>("getPlacementId");
+            }
+            set
+            {
+                androidRewardedAd.Call("setPlacementId", value);
+            }
+        }
+
         public void CreateRewardedAd()
         {
             // No op.

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

@@ -45,6 +45,9 @@ public class RewardingAdBaseClient : BaseAdClient
         // Ad event fired when an ad impression has been clicked.
         public event Action OnAdClicked;
 
+        // The placement ID for the ad.
+        public long PlacementId { get; set; }
+
         internal static readonly Dictionary<AdSize, string> prefabAds = new Dictionary<AdSize, string>()
         {
             {new AdSize (768,1024), "PlaceholderAds/Rewarded/768x1024" },

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

@@ -715,6 +715,12 @@ internal static extern IntPtr GADULoadRewardedAd(IntPtr interstitialAd, string a
       [DllImport("__Internal")]
       internal static extern string GADUGetRewardedAdUnitID(IntPtr rewardedAd);
 
+      [DllImport("__Internal")]
+      internal static extern long GADUGetRewardedAdPlacementID(IntPtr rewardedAd);
+
+      [DllImport("__Internal")]
+      internal static extern void GADUSetRewardedAdPlacementID(IntPtr rewardedAd, long placementId);
+
       [DllImport("__Internal")]
       internal static extern void GADUSetRewardedAdCallbacks(
           IntPtr rewardedAd, RewardedAdClient.GADURewardedAdLoadedCallback adLoadedCallback,

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

@@ -74,6 +74,27 @@ internal delegate void GADURewardedAdPaidEventCallback(
 
         public event Action OnAdClicked;
 
+        public long PlacementId {
+            get
+            {
+                if (this.RewardedAdPtr == IntPtr.Zero)
+                {
+                    return 0;
+                }
+                return Externs.GADUGetRewardedAdPlacementID(this.RewardedAdPtr);
+            }
+
+            set
+            {
+                if (this.RewardedAdPtr == IntPtr.Zero)
+                {
+                    Debug.LogError("PlacementId can be set once the Rewarded ad is loaded.");
+                    return;
+                }
+                Externs.GADUSetRewardedAdPlacementID(this.RewardedAdPtr, value);
+            }
+        }
+
         // This property should be used when setting the rewardedAdPtr.
         private IntPtr RewardedAdPtr
         {

source/plugin/Assets/Plugins/Android/GoogleMobileAdsPlugin.androidlib/src/main/java/com/google/unity/ads/UnityRewardedAd.java

@@ -271,6 +271,29 @@ public String getAdUnitId() {
     return rewardedAd.getAdUnitId();
   }
 
+  /** Gets the placement ID for the {@link RewardedAd}. */
+  public long getPlacementId() {
+    if (rewardedAd == null) {
+      return 0;
+    }
+    return rewardedAd.getPlacementId();
+  }
+
+  /**
+   * Sets a placement ID for the {@link RewardedAd}.
+   *
+   * <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 (rewardedAd == null) {
+      return;
+    }
+    rewardedAd.setPlacementId(placementId);
+  }
+
   /** Returns the request response info. */
   @Nullable
   public ResponseInfo getResponseInfo() {

source/plugin/Assets/Plugins/Android/GoogleMobileAdsPlugin.androidlib/src/test/java/com/google/unity/ads/UnityRewardedAdTest.java

@@ -161,6 +161,54 @@ public void showAd_shouldEnableImmersiveMode_whenLoaded() throws Exception {
     verify(mockRewardedAd).setImmersiveMode(eq(true));
   }
 
+  @Test
+  public void getPlacementId_returnsZero_whenAdIsNull() throws Exception {
+    assertThat(unityRewardedAd.getPlacementId()).isEqualTo(0);
+  }
+
+  @Test
+  public void getPlacementId_returnsPlacementIdFromTheAd() throws Exception {
+    loadRewardedAd();
+    long placementId = 12345L;
+    when(mockRewardedAd.getPlacementId()).thenReturn(placementId);
+
+    long result = unityRewardedAd.getPlacementId();
+
+    assertThat(result).isEqualTo(placementId);
+  }
+
+  @Test
+  public void getPlacementId_returnsPreviouslySetPlacementId() throws Exception {
+    loadRewardedAd();
+    long placementId = 23456L;
+    when(mockRewardedAd.getPlacementId()).thenReturn(placementId);
+
+    unityRewardedAd.setPlacementId(placementId);
+    long result = unityRewardedAd.getPlacementId();
+
+    verify(mockRewardedAd).setPlacementId(placementId);
+    assertThat(result).isEqualTo(placementId);
+  }
+
+  @Test
+  public void setPlacementId_doesNothing_whenAdIsNull() throws Exception {
+    long placementId = 54321L;
+
+    unityRewardedAd.setPlacementId(placementId);
+
+    assertThat(unityRewardedAd.getPlacementId()).isEqualTo(0);
+  }
+
+  @Test
+  public void setPlacementId_setsPlacementIdOnTheAd() throws Exception {
+    loadRewardedAd();
+    long placementId = 54321L;
+
+    unityRewardedAd.setPlacementId(placementId);
+
+    verify(mockRewardedAd).setPlacementId(placementId);
+  }
+
   private void loadRewardedAd() throws Exception {
     doAnswer(
             invocation -> {

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

@@ -48,10 +48,10 @@
 /// The ad click callback into Unity.
 @property(nonatomic, assign, nullable) GADUAppOpenAdDidRecordClickCallback adDidRecordClickCallback;
 
-// The app open ad response info.
+/// The app open ad response info.
 @property(nonatomic, readonly, copy, nullable) GADResponseInfo *responseInfo;
 
-// A long integer provided by the AdMob UI for the configured placement.
+/// A long integer provided by the AdMob UI for the configured placement.
 @property(atomic, readwrite) int64_t placementID;
 
 #if GMA_PREVIEW_FEATURES

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

@@ -1303,6 +1303,18 @@ void GADUShowRewardedAd(GADUTypeRewardedAdRef rewardedAd) {
   return cStringCopy(internalRewardedAd.rewardedAd.adUnitID.UTF8String);
 }
 
+/// Get the Rewarded ad placement ID.
+int64_t GADUGetRewardedAdPlacementID(GADUTypeRewardedAdRef rewardedAd) {
+  GADURewardedAd *internalRewardedAd = (__bridge GADURewardedAd *)rewardedAd;
+  return internalRewardedAd.rewardedAd.placementID;
+}
+
+/// Set the Rewarded ad placement ID.
+void GADUSetRewardedAdPlacementID(GADUTypeRewardedAdRef rewardedAd, int64_t placementID) {
+  GADURewardedAd *internalRewardedAd = (__bridge GADURewardedAd *)rewardedAd;
+  [internalRewardedAd setPlacementID:placementID];
+}
+
 /// Returns the type of the reward.
 const char *GADURewardedAdGetRewardType(GADUTypeRewardedAdRef rewardedAd) {
   GADURewardedAd *internalRewardedAd = (__bridge GADURewardedAd *)rewardedAd;