react-native-google-mobile-ads 6.2.4 → 7.0.0

package/android/src/main/java/io/invertase/googlemobileads/ReactNativeGoogleMobileAdsRewardedModule.kt

@@ -0,0 +1,74 @@
+package io.invertase.googlemobileads
+
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import android.app.Activity
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.ReadableMap
+import com.google.android.gms.ads.AdLoadCallback
+import com.google.android.gms.ads.LoadAdError
+import com.google.android.gms.ads.admanager.AdManagerAdRequest
+import com.google.android.gms.ads.rewarded.RewardedAd
+import com.google.android.gms.ads.rewarded.RewardedAdLoadCallback
+
+class ReactNativeGoogleMobileAdsRewardedModule(reactContext: ReactApplicationContext?) :
+  ReactNativeGoogleMobileAdsFullScreenAdModule<RewardedAd>(reactContext, NAME) {
+
+  override fun getAdEventName(): String {
+    return ReactNativeGoogleMobileAdsEvent.GOOGLE_MOBILE_ADS_EVENT_REWARDED
+  }
+
+  @ReactMethod
+  fun rewardedLoad(requestId: Int, adUnitId: String, adRequestOptions: ReadableMap) {
+    load(requestId, adUnitId, adRequestOptions)
+  }
+
+  @ReactMethod
+  fun rewardedShow(
+    requestId: Int, adUnitId: String, showOptions: ReadableMap, promise: Promise
+  ) {
+    show(requestId, adUnitId, showOptions, promise)
+  }
+
+  override fun loadAd(
+    activity: Activity,
+    adUnitId: String,
+    adRequest: AdManagerAdRequest,
+    adLoadCallback: AdLoadCallback<RewardedAd>
+  ) {
+    RewardedAd.load(
+      activity,
+      adUnitId,
+      adRequest,
+      object :
+        RewardedAdLoadCallback() {
+        override fun onAdLoaded(ad: RewardedAd) {
+          adLoadCallback.onAdLoaded(ad)
+        }
+        override fun onAdFailedToLoad(error: LoadAdError) {
+          adLoadCallback.onAdFailedToLoad(error)
+        }
+      })
+  }
+
+  companion object {
+    const val NAME = "RNGoogleMobileAdsRewardedModule"
+  }
+}

package/docs/displaying-ads.mdx

@@ -107,7 +107,7 @@ function App() {
   const [loaded, setLoaded] = useState(false);
 
   useEffect(() => {
-    const unsubscribe = interstitial.addAdEventListener(AdEventType.LOADED => {
+    const unsubscribe = interstitial.addAdEventListener(AdEventType.LOADED, () => {
       setLoaded(true);
     });
 
@@ -396,7 +396,7 @@ If you request an Advert as in the example above, AdMob will call your server wi
 
 You still need to verify these incoming requests yourself to ensure they are genuine. To learn more about callback parameters and verifying, see the [AdMob SDK Server Side Verification(SSV) documentation](https://developers.google.com/admob/android/rewarded-video-ssv).
 
-## Banner Ads
+## Banner Ads (component)
 
 Banner ads are partial adverts which can be integrated within your existing application. Unlike Interstitial and Rewarded Ads,
 a Banner only takes up a limited area of the application and displays an advert within the area. This allows you to integrate

package/docs/european-user-consent.mdx

@@ -93,7 +93,7 @@ The method returns an `AdsConsentInfo` interface, which provides information abo
   - `OBTAINED`: User consent already obtained.
 - **isConsentFormAvailable**: A boolean value. If `true` a consent form is available.
 
-**Note:** The return status of this call is the status of *form presentation and response collection*, **not
+**Note:** The return status of this call is the status of _form presentation and response collection_, **not
 the the actual user consent**. It simply indicates if you now have a consent response to decode.
 (_i.e._ if user consent is **required**, the form has been presented, and user has
 **denied** the consent, the status returned by this method will be `OBTAINED`,
@@ -197,4 +197,5 @@ UMP SDK for [Android](https://developers.google.com/admob/ump/android/quick-star
 [iOS](https://developers.google.com/admob/ump/ios/quick-start).
 
 <!-- links -->
-[Inspecting consent choices]: #inspecting-consent-choices
+
+[inspecting consent choices]: #inspecting-consent-choices

package/docs/index.mdx

@@ -7,6 +7,10 @@ yarn add react-native-google-mobile-ads
 
 > On Android, before releasing your app, you must select _Yes, my app contains ads_ in the Google Play Store, Policy, App content, Manage under Ads.
 
+## Optionally configure iOS static frameworks
+
+On iOS if you need to use static frameworks (that is, `use_frameworks!` in your `Podfile`) you must add the variable `$RNGoogleMobileAdsAsStaticFramework = true` to the targets in your `Podfile`. You may need this if you use this module in combination with react-native-firebase v15 and higher since it requires `use_frameworks!`.
+
 ## What does it do
 
 The AdMob module allows you to display adverts to your users. All adverts are served over the Google AdMob network, meaning
@@ -39,7 +43,7 @@ Before you are able to display ads to your users, you must have a [Google AdMob
 "Apps" menu item, create or choose an existing Android/iOS app. Each app platform exposes a unique account ID which needs to
 be added to the project.
 
-> Attempting to build your app without a valid App ID may cause a crash during build.
+> Attempting to build your app without a valid App ID in `app.json` will cause the app to crash on start or fail to build.
 
 Under the "App settings" menu item, you can find the "App ID":
 

package/docs/migrating-to-v6.mdx

@@ -32,7 +32,7 @@ With each call to `addAdEventListener`, you add a listener for one specific even
 -    console.log('Ad failed to load with error: ', error);
 -  }
 -}
-+rewardedAd.addAdEventListener(RewardedAdEventType.Loaded, () => {
++rewardedAd.addAdEventListener(RewardedAdEventType.LOADED, () => {
 +  console.log('Ad has loaded');
 +});
 +rewardedAd.addAdEventListener(RewardedAdEventType.EARNED_REWARD, (reward) => {
@@ -46,7 +46,7 @@ With each call to `addAdEventListener`, you add a listener for one specific even
 To unsubscribe from an event, call the function returned from `addAdEventListener`.
 
 ```js
-const unsubscribe = interstitialAd.addAdEventListener(AdEventType.Loaded, () => {
+const unsubscribe = interstitialAd.addAdEventListener(AdEventType.LOADED, () => {
   console.log('Ad has loaded');
 });
 

package/ios/RNGoogleMobileAds/RNGoogleMobileAds-Bridging-Header.h

@@ -0,0 +1,5 @@
+#import <React/RCTBridgeModule.h>
+#import <React/RCTEventEmitter.h>
+
+#import "RNGoogleMobileAdsCommon.h"
+#import "RNSharedUtils.h"

package/ios/RNGoogleMobileAds/RNGoogleMobileAdsAppOpenModule.m

@@ -15,17 +15,9 @@
  *
  */
 
-#import <React/RCTUtils.h>
+#import <React/RCTBridgeModule.h>
 
-#import "RNGoogleMobileAdsAppOpenModule.h"
-#import "RNGoogleMobileAdsCommon.h"
-#import "common/RNSharedUtils.h"
-
-@implementation RNGoogleMobileAdsAppOpenModule
-#pragma mark -
-#pragma mark Module Setup
-
-RCT_EXPORT_MODULE();
+@interface RCT_EXTERN_MODULE (RNGoogleMobileAdsAppOpenModule, NSObject)
 
 - (dispatch_queue_t)methodQueue {
   return dispatch_get_main_queue();
@@ -35,63 +27,16 @@ RCT_EXPORT_MODULE();
   return YES;
 }
 
-// #pragma mark -
-// #pragma mark Google Mobile Ads Methods
-
-RCT_EXPORT_METHOD(appOpenLoad
-                  : (nonnull NSNumber *)requestId
-                  : (NSString *)adUnitId
-                  : (NSDictionary *)adRequestOptions) {
-  self.appOpenAd = nil;
-  [GADAppOpenAd loadWithAdUnitID:adUnitId
-                         request:[RNGoogleMobileAdsCommon buildAdRequest:adRequestOptions]
-                     orientation:UIInterfaceOrientationPortrait
-               completionHandler:^(GADAppOpenAd *_Nullable appOpenAd, NSError *_Nullable error) {
-                 if (error) {
-                   NSDictionary *codeAndMessage =
-                       [RNGoogleMobileAdsCommon getCodeAndMessageFromAdError:error];
-                   [RNGoogleMobileAdsCommon sendAdEvent:GOOGLE_MOBILE_ADS_EVENT_APP_OPEN
-                                              requestId:requestId
-                                                   type:GOOGLE_MOBILE_ADS_EVENT_ERROR
-                                               adUnitId:adUnitId
-                                                  error:codeAndMessage
-                                                   data:nil];
-                   return;
-                 }
-                 self.appOpenAd = appOpenAd;
-                 RNGoogleMobileAdsFullScreenContentDelegate *fullScreenContentDelegate =
-                     [[RNGoogleMobileAdsFullScreenContentDelegate alloc] init];
-                 fullScreenContentDelegate.sendAdEvent = GOOGLE_MOBILE_ADS_EVENT_APP_OPEN;
-                 fullScreenContentDelegate.requestId = requestId;
-                 fullScreenContentDelegate.adUnitId = adUnitId;
-                 self.appOpenAd.fullScreenContentDelegate = fullScreenContentDelegate;
-                 self.appOpenDelegate = fullScreenContentDelegate;
-                 [RNGoogleMobileAdsCommon sendAdEvent:GOOGLE_MOBILE_ADS_EVENT_APP_OPEN
-                                            requestId:requestId
-                                                 type:GOOGLE_MOBILE_ADS_EVENT_LOADED
-                                             adUnitId:adUnitId
-                                                error:nil
-                                                 data:nil];
-               }];
-}
-
-RCT_EXPORT_METHOD(appOpenShow
-                  : (nonnull NSNumber *)requestId
-                  : (NSString *)adUnitId
-                  : (NSDictionary *)showOptions
-                  : (RCTPromiseResolveBlock)resolve
-                  : (RCTPromiseRejectBlock)reject) {
-  if (self.appOpenAd) {
-    [self.appOpenAd presentFromRootViewController:RNGoogleMobileAdsCommon.currentViewController];
-    resolve([NSNull null]);
-  } else {
-    [RNSharedUtils
-        rejectPromiseWithUserInfo:reject
-                         userInfo:[@{
-                           @"code" : @"not-ready",
-                           @"message" : @"App Open ad attempted to show but was not ready.",
-                         } mutableCopy]];
-  }
-}
+RCT_EXTERN_METHOD(appOpenLoad
+                  : (nonnull NSNumber *)requestId forAdUnitId
+                  : (nonnull NSString *)adUnitId withAdRequestOptions
+                  : (nonnull NSDictionary *)adRequestOptions)
+
+RCT_EXTERN_METHOD(appOpenShow
+                  : (nonnull NSNumber *)requestId forAdUnitId
+                  : (nonnull NSString *)adUnitId withShowOptions
+                  : (NSDictionary *)showOptions withResolve
+                  : (RCTPromiseResolveBlock)resolve withReject
+                  : (RCTPromiseRejectBlock)reject)
 
 @end

package/ios/RNGoogleMobileAds/RNGoogleMobileAdsAppOpenModule.swift

@@ -0,0 +1,82 @@
+/**
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import Foundation
+import GoogleMobileAds
+
+@objc(RNGoogleMobileAdsAppOpenModule)
+class RNGoogleMobileAdsAppOpenModule: NSObject {
+  let ad = RNGoogleMobileAdsAppOpenAd()
+  
+  deinit {
+    invalidate()
+  }
+  
+  @objc
+  func invalidate() {
+    ad.invalidate()
+  }
+  
+  @objc(appOpenLoad:forAdUnitId:withAdRequestOptions:)
+  func appOpenLoad(
+    requestId: NSNumber,
+    adUnitId: String,
+    adRequestOptions: Dictionary<String, Any>
+  ) {
+    ad.load(
+      requestId: requestId.intValue,
+      adUnitId: adUnitId,
+      adRequestOptions: adRequestOptions
+    )
+  }
+  
+  @objc(appOpenShow:forAdUnitId:withShowOptions:withResolve:withReject:)
+  func appOpenShow(
+    requestId: NSNumber,
+    adUnitId: String,
+    showOptions: Dictionary<String, Any>,
+    resolve: RCTPromiseResolveBlock?,
+    reject: RCTPromiseRejectBlock?
+  ) {
+    ad.show(
+      requestId: requestId.intValue,
+      adUnitId: adUnitId,
+      showOptions: showOptions,
+      resolve: resolve,
+      reject: reject
+    )
+  }
+  
+  class RNGoogleMobileAdsAppOpenAd: RNGoogleMobileAdsFullScreenAd<GADAppOpenAd> {
+    override func getAdEventName() -> String {
+      return GOOGLE_MOBILE_ADS_EVENT_APP_OPEN
+    }
+    
+    override func loadAd(
+      adUnitId: String,
+      adRequest: GAMRequest,
+      completionHandler: @escaping (GADAppOpenAd?, Error?) -> ()
+    ) {
+      GADAppOpenAd.load(
+        withAdUnitID: adUnitId,
+        request: adRequest,
+        orientation: UIInterfaceOrientation.portrait,
+        completionHandler: completionHandler
+      )
+    }
+  }
+}

package/ios/RNGoogleMobileAds/RNGoogleMobileAdsCommon.m

@@ -83,6 +83,10 @@ NSString *const GOOGLE_MOBILE_ADS_EVENT_REWARDED_EARNED_REWARD = @"rewarded_earn
     request.customTargeting = adRequestOptions[@"customTargeting"];
   }
 
+  if (adRequestOptions[@"publisherProvidedId"]) {
+    request.publisherProvidedID = adRequestOptions[@"publisherProvidedId"];
+  }
+
   return request;
 }
 

package/ios/RNGoogleMobileAds/RNGoogleMobileAdsFullScreenAd.swift

@@ -0,0 +1,208 @@
+/**
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import Foundation
+import GoogleMobileAds
+
+class RNGoogleMobileAdsFullScreenAd<T>: NSObject where T : GADFullScreenPresentingAd {  
+  var adMap = Dictionary<Int, T>()
+  var delegateMap = Dictionary<Int, RNGoogleMobileAdsFullScreenContentDelegate>()
+  
+  deinit {
+    invalidate()
+  }
+  
+  func invalidate() {
+    adMap.removeAll()
+    delegateMap.removeAll()
+  }
+  
+  func getAdEventName() -> String {
+    fatalError("Method `getAdEventName` must be overriden")
+  }
+  
+  func loadAd(
+    adUnitId: String,
+    adRequest: GAMRequest,
+    completionHandler: @escaping (_ ad: T?, _ error: Error?) -> ()
+  ) {
+    fatalError("Method `loadAd` must be overriden")
+  }
+  
+  func sendAdEvent(
+    _ type: String,
+    requestId: Int,
+    adUnitId: String,
+    error: Dictionary<String, Any>?,
+    data: Dictionary<String, Any>?
+  ) {
+    RNGoogleMobileAdsCommon.sendAdEvent(
+      getAdEventName(),
+      requestId: requestId as NSNumber,
+      type: type,
+      adUnitId: adUnitId,
+      error: error,
+      data: data
+    )
+  }
+  
+  //MARK: - Load function
+  
+  func load(
+    requestId: Int,
+    adUnitId: String,
+    adRequestOptions: Dictionary<String, Any>
+  ) {
+    let adRequest = RNGoogleMobileAdsCommon.buildAdRequest(adRequestOptions)!
+    
+    let delegate = RNGoogleMobileAdsFullScreenContentDelegate(
+      adEventName: getAdEventName(),
+      requestId: requestId,
+      adUnitId: adUnitId
+    )
+    
+    let completionHandler = { (ad: T?, error: Error?) -> () in
+      var eventType = GOOGLE_MOBILE_ADS_EVENT_LOADED
+      var data: Dictionary<String, Any>? = nil
+      if let error = error {
+        let codeAndMessage = RNGoogleMobileAdsCommon.getCodeAndMessage(fromAdError: error)
+        self.sendAdEvent(
+          GOOGLE_MOBILE_ADS_EVENT_ERROR,
+          requestId: requestId,
+          adUnitId: adUnitId,
+          error: codeAndMessage as? Dictionary<String, Any>,
+          data: nil
+        )
+        return
+      }
+      
+      if (ad is GADRewardedAd || ad is GADRewardedInterstitialAd) {
+        if let serverSideVerificationOptions =
+            adRequestOptions["serverSideVerificationOptions"] as? Dictionary<String, Any> {
+          let options = GADServerSideVerificationOptions()
+          
+          if let userId = serverSideVerificationOptions["userId"] as? String {
+            options.userIdentifier = userId
+          }
+          if let customData = serverSideVerificationOptions["customData"] as? String {
+            options.customRewardString = customData
+          }
+          
+          if let ad = ad as? GADRewardedAd {
+            ad.serverSideVerificationOptions = options
+          }
+          else if let ad = ad as? GADRewardedInterstitialAd {
+            ad.serverSideVerificationOptions = options
+          }
+        }
+        
+        eventType = GOOGLE_MOBILE_ADS_EVENT_REWARDED_LOADED
+        
+        let adReward = (ad as? GADRewardedAd)?.adReward ?? (ad as? GADRewardedInterstitialAd)?.adReward
+        data = [
+          "type": adReward!.type,
+          "amount": adReward!.amount
+        ]
+      }
+      
+      if let ad = ad as? GAMInterstitialAd {
+        ad.appEventDelegate = delegate
+      }
+      
+      ad!.fullScreenContentDelegate = delegate
+      
+      self.adMap.updateValue(ad!, forKey: requestId)
+      self.delegateMap.updateValue(delegate, forKey: requestId)
+      self.sendAdEvent(
+        eventType,
+        requestId: requestId,
+        adUnitId: adUnitId,
+        error: nil,
+        data: data
+      )
+    }
+    
+    loadAd(adUnitId: adUnitId, adRequest: adRequest, completionHandler: completionHandler)
+  }
+  
+  //MARK: - Show function
+  
+  func show(
+    requestId: Int,
+    adUnitId: String,
+    showOptions: Dictionary<String, Any>,
+    resolve: RCTPromiseResolveBlock?,
+    reject: RCTPromiseRejectBlock?
+  ) {
+    guard let viewController = RNGoogleMobileAdsCommon.currentViewController() else {
+      RNSharedUtils.rejectPromise(userInfo: reject, userInfo: [
+        "code" : "nil-vc",
+        "message" : "Ad attempted to show but the current View Controller was nil.",
+      ])
+      return
+    }
+    
+    guard let ad = adMap[requestId] else {
+      RNSharedUtils.rejectPromise(userInfo: reject, userInfo: [
+        "code" : "not-ready",
+        "message" : "Ad attempted to show but was not ready.",
+      ])
+      return
+    }
+    
+    var rewardData: Dictionary<String, Any>? = nil
+    if let adReward =
+        (ad as? GADRewardedAd)?.adReward ??
+        (ad as? GADRewardedInterstitialAd)?.adReward {
+      rewardData = [
+        "type": adReward.type,
+        "amount": adReward.amount
+      ]
+    }
+    let userDidEarnRewardHandler = { () -> Void in
+      self.sendAdEvent(
+        GOOGLE_MOBILE_ADS_EVENT_REWARDED_EARNED_REWARD,
+        requestId: requestId,
+        adUnitId: adUnitId,
+        error: nil,
+        data: rewardData
+      )
+    }
+    
+    // TODO: Find way to compact this area
+    if let ad = ad as? GADAppOpenAd {
+      ad.present(fromRootViewController: viewController)
+    }
+    else if let ad = ad as? GADInterstitialAd {
+      ad.present(fromRootViewController: viewController)
+    }
+    else if let ad = ad as? GADRewardedAd {
+      ad.present(
+        fromRootViewController: viewController,
+        userDidEarnRewardHandler: userDidEarnRewardHandler
+      )
+    }
+    else if let ad = ad as? GADRewardedInterstitialAd {
+      ad.present(
+        fromRootViewController: viewController,
+        userDidEarnRewardHandler: userDidEarnRewardHandler
+      )
+    }
+    
+    resolve!(nil)
+  }
+}

package/ios/RNGoogleMobileAds/RNGoogleMobileAdsFullScreenContentDelegate.swift

@@ -0,0 +1,72 @@
+import Foundation
+import GoogleMobileAds
+
+class RNGoogleMobileAdsFullScreenContentDelegate: NSObject, GADFullScreenContentDelegate, GADAppEventDelegate {
+  let adEventName: String
+  let requestId: Int
+  let adUnitId: String
+  
+  init(adEventName: String, requestId: Int, adUnitId: String) {
+    self.adEventName = adEventName
+    self.requestId = requestId
+    self.adUnitId = adUnitId
+  }
+  
+  func adWillPresentFullScreenContent(_ ad: GADFullScreenPresentingAd) {
+    sendAdEvent(
+      type: GOOGLE_MOBILE_ADS_EVENT_OPENED,
+      error: nil,
+      data: nil
+    )
+  }
+  
+  func ad(_ ad: GADFullScreenPresentingAd, didFailToPresentFullScreenContentWithError error: Error) {
+    sendAdEvent(
+      type: GOOGLE_MOBILE_ADS_EVENT_ERROR,
+      error: RNGoogleMobileAdsCommon.getCodeAndMessage(fromAdError: error) as? Dictionary<String, Any>,
+      data: nil
+    )
+  }
+  
+  func adDidDismissFullScreenContent(_ ad: GADFullScreenPresentingAd) {
+    sendAdEvent(
+      type: GOOGLE_MOBILE_ADS_EVENT_CLOSED,
+      error: nil,
+      data: nil
+    )
+  }
+  
+  func adDidRecordClick(_ ad: GADFullScreenPresentingAd) {
+    sendAdEvent(
+      type: GOOGLE_MOBILE_ADS_EVENT_CLICKED,
+      error: nil,
+      data: nil
+    )
+  }
+  
+  func adDidRecordImpression(_ ad: GADFullScreenPresentingAd) {
+    // Not implemented yet
+  }
+  
+  func interstitialAd(_ interstitialAd: GADInterstitialAd, didReceiveAppEvent name: String, withInfo info: String?) {
+    sendAdEvent(
+      type: GOOGLE_MOBILE_ADS_EVENT_APP_EVENT,
+      error: nil,
+      data: [
+        "name": name,
+        "data": info ?? ""
+      ]
+    )
+  }
+  
+  private func sendAdEvent(type: String, error: Dictionary<String, Any>?, data: Dictionary<String, Any>?) {
+    RNGoogleMobileAdsCommon.sendAdEvent(
+      adEventName,
+      requestId: requestId as NSNumber,
+      type: type,
+      adUnitId: adUnitId,
+      error: error,
+      data: data
+    )
+  }
+}