react-native-google-mobile-ads 4.1.3 → 5.0.1

package/RNGoogleMobileAds.podspec

@@ -1,7 +1,8 @@
 require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
-google_ads_sdk_version = package['sdkVersions']['ios']['googleAds']
+google_mobile_ads_sdk_version = package['sdkVersions']['ios']['googleMobileAds']
+google_ump_sdk_version = package['sdkVersions']['ios']['googleUmp']
 
 Pod::Spec.new do |s|
   s.name                = "RNGoogleMobileAds"
@@ -18,24 +19,30 @@ Pod::Spec.new do |s|
   s.social_media_url    = 'http://twitter.com/invertaseio'
   s.ios.deployment_target = "10.0"
   s.source_files        = 'ios/**/*.{h,m}'
+  s.frameworks          = "AppTrackingTransparency"
 
   # React Native dependencies
   s.dependency          'React-Core'
 
   # Other dependencies
-  s.dependency          'PersonalizedAdConsent', '~> 1.0.5'
+  if defined?($RNGoogleUmpSDKVersion)
+    Pod::UI.puts "#{s.name}: Using user specified Google UMP SDK version '#{$RNGoogleUmpSDKVersion}'"
+    google_ump_sdk_version = $RNGoogleUmpSDKVersion
+  end
+
+  s.dependency          'GoogleUserMessagingPlatform', google_ump_sdk_version
 
-  if defined?($RNGoogleAdsSDKVersion)
-    Pod::UI.puts "#{s.name}: Using user specified Google Mobile-Ads SDK version '#{$RNGoogleAdsSDKVersion}'"
-    google_ads_sdk_version = $RNGoogleAdsSDKVersion
+  if defined?($RNGoogleMobileAdsSDKVersion)
+    Pod::UI.puts "#{s.name}: Using user specified Google Mobile-Ads SDK version '#{$RNGoogleMobileAdsSDKVersion}'"
+    google_mobile_ads_sdk_version = $RNGoogleMobileAdsSDKVersion
   end
 
   # AdMob dependencies
-  s.dependency          'Google-Mobile-Ads-SDK', google_ads_sdk_version
+  s.dependency          'Google-Mobile-Ads-SDK', google_mobile_ads_sdk_version
 
-  if defined?($RNGoogleAdsAsStaticFramework)
-    Pod::UI.puts "#{s.name}: Using overridden static_framework value of '#{$RNGoogleAdsAsStaticFramework}'"
-    s.static_framework = $RNGoogleAdsAsStaticFramework
+  if defined?($RNGoogleMobileAdsAsStaticFramework)
+    Pod::UI.puts "#{s.name}: Using overridden static_framework value of '#{$RNGoogleMobileAdsAsStaticFramework}'"
+    s.static_framework = $RNGoogleMobileAdsAsStaticFramework
   else
     s.static_framework = false
   end

package/__tests__/consent.test.ts

@@ -2,23 +2,31 @@ import { AdsConsent } from '../src';
 
 describe('Google Mobile Ads AdsConsent', function () {
   describe('requestInfoUpdate', function () {
-    it('throws if publisherIds is not an array', function () {
+    it('throws if options are not an object', function () {
       // @ts-ignore
-      expect(() => AdsConsent.requestInfoUpdate('pub-123')).toThrowError(
-        "AdsConsent.requestInfoUpdate(*) 'publisherIds' expected an array of string values.",
+      expect(() => AdsConsent.requestInfoUpdate('123')).toThrowError(
+        "AdsConsent.requestInfoUpdate(*) 'options' expected an object value.",
       );
     });
 
-    it('throws if publisherIds is empty array', function () {
-      expect(() => AdsConsent.requestInfoUpdate([])).toThrowError(
-        "AdsConsent.requestInfoUpdate(*) 'publisherIds' list of publisher IDs cannot be empty.",
+    it('throws if options.debugGeography is not a valid value.', function () {
+      // @ts-ignore
+      expect(() => AdsConsent.requestInfoUpdate({ debugGeography: -1 })).toThrowError(
+        "AdsConsent.requestInfoUpdate(*) 'options.debugGeography' expected one of AdsConsentDebugGeography.DISABLED, AdsConsentDebugGeography.EEA or AdsConsentDebugGeography.NOT_EEA.",
+      );
+    });
+
+    it('throws if options.tagForUnderAgeOfConsent is not a boolean.', function () {
+      // @ts-ignore
+      expect(() => AdsConsent.requestInfoUpdate({ tagForUnderAgeOfConsent: '123' })).toThrowError(
+        "AdsConsent.requestInfoUpdate(*) 'options.tagForUnderAgeOfConsent' expected a boolean value.",
       );
     });
 
-    it('throws if publisherIds contains non-string values', function () {
+    it('throws if options.testDeviceIdentifiers is not an array', function () {
       // @ts-ignore
-      expect(() => AdsConsent.requestInfoUpdate(['foo', 123])).toThrowError(
-        "AdsConsent.requestInfoUpdate(*) 'publisherIds[1]' expected a string value.",
+      expect(() => AdsConsent.requestInfoUpdate({ testDeviceIdentifiers: '123' })).toThrowError(
+        "AdsConsent.requestInfoUpdate(*) 'options.testDeviceIdentifiers' expected an array of string values.",
       );
     });
   });

package/android/build.gradle

@@ -22,6 +22,7 @@ plugins {
 
 def packageJson = PackageJson.getForProject(project)
 def googleMobileAdsVersion = packageJson['sdkVersions']['android']['googleMobileAds']
+def googleUmpVersion = packageJson['sdkVersions']['android']['googleUmp']
 def jsonMinSdk = packageJson['sdkVersions']['android']['minSdk']
 def jsonTargetSdk = packageJson['sdkVersions']['android']['targetSdk']
 def jsonCompileSdk = packageJson['sdkVersions']['android']['compileSdk']
@@ -44,7 +45,7 @@ project.ext {
       ],
 
       ads     : [
-        consent: "1.0.6"
+        consent: googleUmpVersion,
       ],
     ],
   ])
@@ -88,8 +89,8 @@ repositories {
 }
 
 dependencies {
-  implementation("com.google.android.gms:play-services-ads:20.5.0") { force = true; }
-  implementation "com.google.android.ads.consent:consent-library:${ReactNative.ext.getVersion("ads", "consent")}"
+  implementation("com.google.android.gms:play-services-ads:${googleMobileAdsVersion}") { force = true; }
+  api "com.google.android.ump:user-messaging-platform:${googleUmpVersion}"
 }
 
 ReactNative.shared.applyPackageVersion()

package/android/src/main/java/io/invertase/googlemobileads/ReactNativeGoogleMobileAdsCommon.java

@@ -31,6 +31,7 @@ import com.google.ads.mediation.admob.AdMobAdapter;
 import com.google.android.gms.ads.AdError;
 import com.google.android.gms.ads.AdRequest;
 import com.google.android.gms.ads.AdSize;
+import com.google.android.gms.ads.admanager.AdManagerAdRequest;
 import io.invertase.googlemobileads.common.ReactNativeEventEmitter;
 import java.util.ArrayList;
 import java.util.Map;
@@ -130,8 +131,8 @@ public class ReactNativeGoogleMobileAdsCommon {
     return map;
   }
 
-  public static AdRequest buildAdRequest(ReadableMap adRequestOptions) {
-    AdRequest.Builder builder = new AdRequest.Builder();
+  public static AdManagerAdRequest buildAdRequest(ReadableMap adRequestOptions) {
+    AdManagerAdRequest.Builder builder = new AdManagerAdRequest.Builder();
     Bundle extras = new Bundle();
 
     if (adRequestOptions.hasKey("requestNonPersonalizedAdsOnly")
@@ -177,6 +178,16 @@ public class ReactNativeGoogleMobileAdsCommon {
       builder.setRequestAgent(Objects.requireNonNull(adRequestOptions.getString("requestAgent")));
     }
 
+    if (adRequestOptions.hasKey("customTargeting")) {
+      Map<String, Object> customTargeting = adRequestOptions.getMap("customTargeting").toHashMap();
+
+      for (Map.Entry<String, Object> entry : customTargeting.entrySet()) {
+        String key = entry.getKey();
+        String value = (String) entry.getValue();
+        builder.addCustomTargeting(key, value);
+      }
+    }
+
     return builder.build();
   }
 

package/android/src/main/java/io/invertase/googlemobileads/ReactNativeGoogleMobileAdsConsentModule.java

@@ -21,206 +21,135 @@ import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactMethod;
-import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
-import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
-import com.google.ads.consent.AdProvider;
-import com.google.ads.consent.ConsentForm;
-import com.google.ads.consent.ConsentFormListener;
-import com.google.ads.consent.ConsentInfoUpdateListener;
-import com.google.ads.consent.ConsentInformation;
-import com.google.ads.consent.ConsentStatus;
-import com.google.ads.consent.DebugGeography;
+import com.google.android.ump.ConsentDebugSettings;
+import com.google.android.ump.ConsentInformation;
+import com.google.android.ump.ConsentRequestParameters;
+import com.google.android.ump.UserMessagingPlatform;
 import io.invertase.googlemobileads.common.ReactNativeModule;
-import java.net.MalformedURLException;
-import java.net.URL;
 import java.util.List;
+import javax.annotation.Nonnull;
 
 public class ReactNativeGoogleMobileAdsConsentModule extends ReactNativeModule {
+
   private static final String TAG = "RNGoogleMobileAdsConsentModule";
   private ConsentInformation consentInformation;
-  private ConsentForm consentForm;
 
   public ReactNativeGoogleMobileAdsConsentModule(ReactApplicationContext reactContext) {
     super(reactContext, TAG);
-    consentInformation = ConsentInformation.getInstance(reactContext);
+    consentInformation = UserMessagingPlatform.getConsentInformation(reactContext);
   }
 
-  private int getConsentStatusInt(ConsentStatus consentStatus) {
+  private String getConsentStatusString(int consentStatus) {
     switch (consentStatus) {
-      case NON_PERSONALIZED:
-        return 1;
-      case PERSONALIZED:
-        return 2;
-      case UNKNOWN:
+      case ConsentInformation.ConsentStatus.REQUIRED:
+        return "REQUIRED";
+      case ConsentInformation.ConsentStatus.NOT_REQUIRED:
+        return "NOT_REQUIRED";
+      case ConsentInformation.ConsentStatus.OBTAINED:
+        return "OBTAINED";
+      case ConsentInformation.ConsentStatus.UNKNOWN:
       default:
-        return 0;
+        return "UNKNOWN";
     }
   }
 
   @ReactMethod
-  public void requestInfoUpdate(ReadableArray publisherIds, Promise promise) {
-    @SuppressWarnings("SuspiciousToArrayCall")
-    String[] publisherIdsArray = publisherIds.toArrayList().toArray(new String[0]);
-
-    consentInformation.requestConsentInfoUpdate(
-        publisherIdsArray,
-        new ConsentInfoUpdateListener() {
-          @Override
-          public void onConsentInfoUpdated(ConsentStatus consentStatus) {
+  public void requestInfoUpdate(@Nonnull final ReadableMap options, final Promise promise) {
+    try {
+      ConsentRequestParameters.Builder paramsBuilder = new ConsentRequestParameters.Builder();
+      ConsentDebugSettings.Builder debugSettingsBuilder =
+          new ConsentDebugSettings.Builder(getApplicationContext());
+
+      if (options.hasKey("testDeviceIdentifiers")) {
+        List<Object> devices = options.getArray("testDeviceIdentifiers").toArrayList();
+
+        for (Object device : devices) {
+          debugSettingsBuilder.addTestDeviceHashedId((String) device);
+        }
+      }
+
+      if (options.hasKey("debugGeography")) {
+        debugSettingsBuilder.setDebugGeography(options.getInt("debugGeography"));
+      }
+
+      paramsBuilder.setConsentDebugSettings(debugSettingsBuilder.build());
+
+      if (options.hasKey("tagForUnderAgeOfConsent")) {
+        paramsBuilder.setTagForUnderAgeOfConsent(options.getBoolean("tagForUnderAgeOfConsent"));
+      }
+
+      ConsentRequestParameters consentRequestParameters = paramsBuilder.build();
+
+      if (getCurrentActivity() == null) {
+        rejectPromiseWithCodeAndMessage(
+            promise,
+            "null-activity",
+            "Attempted to request a consent info update but the current Activity was null.");
+        return;
+      }
+
+      consentInformation.requestConsentInfoUpdate(
+          getCurrentActivity(),
+          consentRequestParameters,
+          () -> {
             WritableMap requestInfoMap = Arguments.createMap();
-            requestInfoMap.putInt("status", getConsentStatusInt(consentStatus));
+            requestInfoMap.putString(
+                "status", getConsentStatusString(consentInformation.getConsentStatus()));
             requestInfoMap.putBoolean(
-                "isRequestLocationInEeaOrUnknown",
-                consentInformation.isRequestLocationInEeaOrUnknown());
+                "isConsentFormAvailable", consentInformation.isConsentFormAvailable());
             promise.resolve(requestInfoMap);
-          }
-
-          @Override
-          public void onFailedToUpdateConsentInfo(String reason) {
-            rejectPromiseWithCodeAndMessage(promise, "consent-update-failed", reason);
-          }
-        });
-  }
-
-  @ReactMethod
-  public void showForm(ReadableMap options, Promise promise) {
-    if (getCurrentActivity() == null) {
-      rejectPromiseWithCodeAndMessage(
-          promise,
-          "null-activity",
-          "Consent form attempted to show but the current Activity was null.");
-      return;
+          },
+          formError ->
+              rejectPromiseWithCodeAndMessage(
+                  promise, "consent-update-failed", formError.getMessage()));
+    } catch (Exception e) {
+      rejectPromiseWithCodeAndMessage(promise, "consent-update-failed", e.toString());
     }
-    getCurrentActivity()
-        .runOnUiThread(
-            () -> {
-              URL privacyUrl = null;
-
-              try {
-                privacyUrl = new URL(options.getString("privacyPolicy"));
-              } catch (MalformedURLException e) {
-                // Validated in JS land
-              }
-
-              ConsentFormListener listener =
-                  new ConsentFormListener() {
-                    @Override
-                    public void onConsentFormLoaded() {
-                      try {
-                        consentForm.show();
-                      } catch (Exception e) {
-                        rejectPromiseWithCodeAndMessage(
-                            promise, "consent-form-error", e.toString());
-                      }
-                    }
-
-                    @Override
-                    public void onConsentFormClosed(
-                        ConsentStatus consentStatus, Boolean userPrefersAdFree) {
-                      WritableMap consentFormMap = Arguments.createMap();
-                      consentFormMap.putInt("status", getConsentStatusInt(consentStatus));
-                      consentFormMap.putBoolean("userPrefersAdFree", userPrefersAdFree);
-                      promise.resolve(consentFormMap);
-                    }
-
-                    @Override
-                    public void onConsentFormError(String reason) {
-                      rejectPromiseWithCodeAndMessage(promise, "consent-form-error", reason);
-                    }
-                  };
-
-              ConsentForm.Builder builder =
-                  new ConsentForm.Builder(getCurrentActivity(), privacyUrl).withListener(listener);
-
-              if (options.hasKey("withPersonalizedAds")
-                  && options.getBoolean("withPersonalizedAds")) {
-                builder = builder.withPersonalizedAdsOption();
-              }
-
-              if (options.hasKey("withNonPersonalizedAds")
-                  && options.getBoolean("withNonPersonalizedAds")) {
-                builder = builder.withNonPersonalizedAdsOption();
-              }
-
-              if (options.hasKey("withAdFree") && options.getBoolean("withAdFree")) {
-                builder = builder.withAdFreeOption();
-              }
-
-              consentForm = builder.build();
-              consentForm.load();
-            });
   }
 
   @ReactMethod
-  public void getStatus(Promise promise) {
-    ConsentStatus status = consentInformation.getConsentStatus();
-    promise.resolve(getConsentStatusInt(status));
-  }
-
-  @ReactMethod
-  public void setStatus(int status, Promise promise) {
-    ConsentStatus consentStatus = ConsentStatus.UNKNOWN;
-
-    switch (status) {
-      case 0:
-        consentStatus = ConsentStatus.UNKNOWN;
-        break;
-      case 1:
-        consentStatus = ConsentStatus.NON_PERSONALIZED;
-        break;
-      case 2:
-        consentStatus = ConsentStatus.PERSONALIZED;
-        break;
+  public void showForm(final Promise promise) {
+    try {
+      if (getCurrentActivity() == null) {
+        rejectPromiseWithCodeAndMessage(
+            promise,
+            "null-activity",
+            "Consent form attempted to show but the current Activity was null.");
+        return;
+      }
+      getCurrentActivity()
+          .runOnUiThread(
+              () ->
+                  UserMessagingPlatform.loadConsentForm(
+                      getReactApplicationContext(),
+                      consentForm ->
+                          consentForm.show(
+                              getCurrentActivity(),
+                              formError -> {
+                                if (formError != null) {
+                                  rejectPromiseWithCodeAndMessage(
+                                      promise, "consent-form-error", formError.getMessage());
+                                } else {
+                                  WritableMap consentFormMap = Arguments.createMap();
+                                  consentFormMap.putString(
+                                      "status",
+                                      getConsentStatusString(
+                                          consentInformation.getConsentStatus()));
+                                  promise.resolve(consentFormMap);
+                                }
+                              }),
+                      formError ->
+                          rejectPromiseWithCodeAndMessage(
+                              promise, "consent-form-error", formError.getMessage())));
+    } catch (Exception e) {
+      rejectPromiseWithCodeAndMessage(promise, "consent-form-error", e.toString());
     }
-
-    consentInformation.setConsentStatus(consentStatus);
-    promise.resolve(null);
   }
 
   @ReactMethod
-  public void getAdProviders(Promise promise) {
-    List<AdProvider> providers = consentInformation.getAdProviders();
-
-    WritableArray formattedAdProviders = Arguments.createArray();
-
-    for (AdProvider provider : providers) {
-      WritableMap formattedProvider = Arguments.createMap();
-      formattedProvider.putString("companyName", provider.getName());
-      formattedProvider.putString("companyId", provider.getId());
-      formattedProvider.putString("privacyPolicyUrl", provider.getPrivacyPolicyUrlString());
-      formattedAdProviders.pushMap(formattedProvider);
-    }
-
-    promise.resolve(formattedAdProviders);
-  }
-
-  @ReactMethod
-  public void setTagForUnderAgeOfConsent(boolean tag, Promise promise) {
-    consentInformation.setTagForUnderAgeOfConsent(tag);
-    promise.resolve(null);
-  }
-
-  @ReactMethod
-  public void setDebugGeography(int geography, Promise promise) {
-    if (geography == 0) {
-      consentInformation.setDebugGeography(DebugGeography.DEBUG_GEOGRAPHY_DISABLED);
-    } else if (geography == 1) {
-      consentInformation.setDebugGeography(DebugGeography.DEBUG_GEOGRAPHY_EEA);
-    } else if (geography == 2) {
-      consentInformation.setDebugGeography(DebugGeography.DEBUG_GEOGRAPHY_NOT_EEA);
-    }
-
-    promise.resolve(null);
-  }
-
-  @ReactMethod
-  public void addTestDevices(ReadableArray deviceIds, Promise promise) {
-    List<Object> devices = deviceIds.toArrayList();
-    for (Object device : devices) {
-      consentInformation.addTestDevice((String) device);
-    }
-    promise.resolve(null);
+  public void reset() {
+    consentInformation.reset();
   }
 }

package/android/src/main/java/io/invertase/googlemobileads/ReactNativeGoogleMobileAdsModule.java

@@ -117,7 +117,7 @@ public class ReactNativeGoogleMobileAdsModule extends ReactNativeModule {
   @ReactMethod
   public void initialize(Promise promise) {
     MobileAds.initialize(
-        getContext(),
+        getApplicationContext(),
         new OnInitializationCompleteListener() {
           @Override
           public void onInitializationComplete(InitializationStatus initializationStatus) {