@capacitor-community/admob 4.2.0 → 5.1.0

package/README.md

@@ -42,11 +42,17 @@ Made with [contributors-img](https://contrib.rocks).
 | **Android** | ![](demo/screenshots/md_banner.png)  | ![](demo/screenshots/md_interstitial.png)  | ![](demo/screenshots/md_reward.png)  |
 
 ## Installation
+If you use capacitor 5:
+
+```
+% npm install --save @capacitor-community/admob@5.0.0
+% npx cap update
+```
 
 If you use capacitor 4:
 
 ```
-% npm install --save @capacitor-community/admob@latest
+% npm install --save @capacitor-community/admob@4.0.0
 % npx cap update
 ```
 
@@ -79,7 +85,8 @@ Don't forget to replace `[APP_ID]` by your AdMob application Id.
 
 This plugin will use the following project variables (defined in your app's `variables.gradle` file):
 
-- `$playServicesAdsVersion` version of `com.google.android.gms:play-services-ads` (default: `21.1.0`)
+- `playServicesAdsVersion` version of `com.google.android.gms:play-services-ads` (default: `22.0.0`)
+- `androidxCoreKTXVersion`: version of `androidx.core:core-ktx` (default: `1.10.0`)
 
 ### iOS configuration
 
@@ -127,20 +134,48 @@ export async function initialize(): Promise<void> {
   }
  
   AdMob.initialize({
-    requestTrackingAuthorization: true,
     testingDevices: ['2077ef9a63d2b398840261c8221a0c9b'],
     initializeForTesting: true,
   });
 }
 ```
 
-You can use option `requestTrackingAuthorization`. This change permission to require `AppTrackingTransparency` in iOS >= 14:
-https://developers.google.com/admob/ios/ios14
+Send and array of device Ids in `testingDevices? to use production like ads on your specified devices -> https://developers.google.com/admob/android/test-ads#enable_test_devices
 
-Default value is `true`. If you don't want to track, set requestTrackingAuthorization `false`.
+### User Message Platform (UMP)
 
-Send and array of device Ids in `testingDevices? to use production like ads on your specified devices -> https://developers.google.com/admob/android/test-ads#enable_test_devices
+Later this year, Google will require all publishers serving ads to EEA and UK users to use a Google-certified Consent Management Platform (CMP)
+
+Currently we just support Google's consent management solution.
+
+To use UMP, you must [create your GDPR messages](https://support.google.com/admob/answer/10113207?hl=en&ref_topic=10105230&sjid=6731900490614517032-AP)
 
+You may need to [setup IDFA messages](https://support.google.com/admob/answer/10115027?hl=en), it will work along with GDPR messages and will show when users are not in EEA and UK.
+
+Example of how to use UMP
+
+```ts
+import { AdMob, AdmobConsentStatus, AdmobConsentDebugGeography } from '@capacitor-community/admob';
+
+async showConsent() {
+  const consentInfo = await AdMob.requestConsentInfo();
+
+  if (consentInfo.isConsentFormAvailable && consentInfo.status === AdmobConsentStatus.REQUIRED) {
+    const {status} = await AdMob.showConsentForm();
+  }
+}
+```
+
+If you testing on real device, you have to set `debugGeography` and add your device ID to `testDeviceIdentifiers`. You can find your device ID with logcat (Android) or XCode (iOS).
+
+```ts
+  const consentInfo = await AdMob.requestConsentInfo({
+    debugGeography: AdmobConsentDebugGeography.EEA,
+    testDeviceIdentifiers: ['YOUR_DEVICE_ID']
+  });
+```
+
+**Note**: When testing, if you choose not consent (Manage -> Confirm Choices). The ads may not load/show. Even on testing enviroment. This is normal. It will work on Production so don't worry.
 
 ### Show Banner
 
@@ -266,6 +301,9 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
 * [`addListener(BannerAdPluginEvents.Opened, ...)`](#addlistenerbanneradplugineventsopened-)
 * [`addListener(BannerAdPluginEvents.Closed, ...)`](#addlistenerbanneradplugineventsclosed-)
 * [`addListener(BannerAdPluginEvents.AdImpression, ...)`](#addlistenerbanneradplugineventsadimpression-)
+* [`requestConsentInfo(...)`](#requestconsentinfo)
+* [`showConsentForm()`](#showconsentform)
+* [`resetConsentInfo()`](#resetconsentinfo)
 * [`prepareInterstitial(...)`](#prepareinterstitial)
 * [`showInterstitial()`](#showinterstitial)
 * [`addListener(InterstitialAdPluginEvents.FailedToLoad, ...)`](#addlistenerinterstitialadplugineventsfailedtoload-)
@@ -503,6 +541,47 @@ Unimplemented
 --------------------
 
 
+### requestConsentInfo(...)
+
+```typescript
+requestConsentInfo(options?: AdmobConsentRequestOptions) => Promise<AdmobConsentInfo>
+```
+
+Request user consent information
+
+| Param         | Type                                                                              | Description           |
+| ------------- | --------------------------------------------------------------------------------- | --------------------- |
+| **`options`** | <code><a href="#admobconsentrequestoptions">AdmobConsentRequestOptions</a></code> | ConsentRequestOptions |
+
+**Returns:** <code>Promise&lt;<a href="#admobconsentinfo">AdmobConsentInfo</a>&gt;</code>
+
+--------------------
+
+
+### showConsentForm()
+
+```typescript
+showConsentForm() => Promise<AdmobConsentInfo>
+```
+
+Shows a google user consent form (rendered from your GDPR message config).
+
+**Returns:** <code>Promise&lt;<a href="#admobconsentinfo">AdmobConsentInfo</a>&gt;</code>
+
+--------------------
+
+
+### resetConsentInfo()
+
+```typescript
+resetConsentInfo() => Promise<void>
+```
+
+Resets the UMP SDK state. Call requestConsentInfo function again to allow user modify their consent
+
+--------------------
+
+
 ### prepareInterstitial(...)
 
 ```typescript
@@ -811,6 +890,23 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
 | **`message`** | <code>string</code> | Gets the message describing the error. |
 
 
+#### AdmobConsentInfo
+
+| Prop                         | Type                                                              | Description                                           |
+| ---------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------- |
+| **`status`**                 | <code><a href="#admobconsentstatus">AdmobConsentStatus</a></code> | The consent status of the user.                       |
+| **`isConsentFormAvailable`** | <code>boolean</code>                                              | If `true` a consent form is available and vice versa. |
+
+
+#### AdmobConsentRequestOptions
+
+| Prop                          | Type                                                                              | Description                                                                                                  |
+| ----------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| **`debugGeography`**          | <code><a href="#admobconsentdebuggeography">AdmobConsentDebugGeography</a></code> | Sets the debug geography to test the consent locally.                                                        |
+| **`testDeviceIdentifiers`**   | <code>string[]</code>                                                             | An array of test device IDs to allow. Note: On iOS, the ID may renew if you uninstall and reinstall the app. |
+| **`tagForUnderAgeOfConsent`** | <code>boolean</code>                                                              | Set to `true` to provide the option for the user to accept being shown personalized ads.                     |
+
+
 #### AdLoadInfo
 
 | Prop           | Type                |
@@ -908,6 +1004,25 @@ From T, pick a set of properties whose keys are in the union K
 | **`AdImpression`** | <code>"bannerAdImpression"</code>   | Similarly, this method should be called when an impression is recorded for the ad by the mediated SDK. |
 
 
+#### AdmobConsentStatus
+
+| Members            | Value                       | Description                                                                           |
+| ------------------ | --------------------------- | ------------------------------------------------------------------------------------- |
+| **`NOT_REQUIRED`** | <code>'NOT_REQUIRED'</code> | User consent not required.                                                            |
+| **`OBTAINED`**     | <code>'OBTAINED'</code>     | User consent already obtained.                                                        |
+| **`REQUIRED`**     | <code>'REQUIRED'</code>     | User consent required but not yet obtained.                                           |
+| **`UNKNOWN`**      | <code>'UNKNOWN'</code>      | Unknown consent status, AdsConsent.requestInfoUpdate needs to be called to update it. |
+
+
+#### AdmobConsentDebugGeography
+
+| Members        | Value          | Description                                        |
+| -------------- | -------------- | -------------------------------------------------- |
+| **`DISABLED`** | <code>0</code> | Debug geography disabled.                          |
+| **`EEA`**      | <code>1</code> | Geography appears as in EEA for debug devices.     |
+| **`NOT_EEA`**  | <code>2</code> | Geography appears as not in EEA for debug devices. |
+
+
 #### InterstitialAdPluginEvents
 
 | Members            | Value                                     | Description                                                                            |

package/android/build.gradle

@@ -1,21 +1,21 @@
 ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.4.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
     androidxCoordinatorLayoutVersion = project.hasProperty('androidxCoordinatorLayoutVersion') ? rootProject.ext.androidxCoordinatorLayoutVersion : '1.2.0'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.3'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.4.0'
-    playServicesAdsVersion = project.hasProperty('playServicesAdsVersion') ? rootProject.ext.playServicesAdsVersion : '21.5.0'
-
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+    playServicesAdsVersion = project.hasProperty('playServicesAdsVersion') ? rootProject.ext.playServicesAdsVersion : '22.0.0'
+    androidxCoreKTXVersion = project.hasProperty('androidxCoreKTXVersion') ? rootProject.ext.androidxCoreKTXVersion : '1.10.0'
 }
 
 buildscript {
-    ext.kotlin_version = '1.5.21'
+    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.8.20'
     repositories {
         google()
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.2.1'
+        classpath 'com.android.tools.build:gradle:8.0.0'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
@@ -24,10 +24,11 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
 android {
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
+    namespace "com.getcapacitor.community.admob.admob"
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -42,8 +43,11 @@ android {
         abortOnError false
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_11
-        targetCompatibility JavaVersion.VERSION_11
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_17
     }
 }
 
@@ -78,8 +82,8 @@ dependencies {
     implementation "com.google.android.gms:play-services-ads:$playServicesAdsVersion"
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
     implementation "androidx.coordinatorlayout:coordinatorlayout:$androidxCoordinatorLayoutVersion"
-    implementation "androidx.core:core-ktx:1.6.0"
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+    implementation "androidx.core:core-ktx:$androidxCoreKTXVersion"
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 }
 
 // Allow to run unit test with  ./gradlew test

package/android/src/main/AndroidManifest.xml

@@ -1,6 +1,5 @@
 
-  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-      package="com.getcapacitor.community.admob.admob">
+  <manifest xmlns:android="http://schemas.android.com/apk/res/android">
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
     <uses-permission android:name="android.permission.INTERNET"/>
   </manifest>

package/android/src/main/java/com/getcapacitor/community/admob/AdMob.java

@@ -9,6 +9,7 @@ import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
 import com.getcapacitor.annotation.Permission;
 import com.getcapacitor.community.admob.banner.BannerExecutor;
+import com.getcapacitor.community.admob.consent.AdConsentExecutor;
 import com.getcapacitor.community.admob.helpers.AuthorizationStatusEnum;
 import com.getcapacitor.community.admob.interstitial.AdInterstitialExecutor;
 import com.getcapacitor.community.admob.interstitial.InterstitialAdCallbackAndListeners;
@@ -46,6 +47,13 @@ public class AdMob extends Plugin {
         InterstitialAdCallbackAndListeners.INSTANCE
     );
 
+    private final AdConsentExecutor adConsentExecutor = new AdConsentExecutor(
+        this::getContext,
+        this::getActivity,
+        this::notifyListeners,
+        getLogTag()
+    );
+
     // Initialize AdMob with appId
     @PluginMethod
     public void initialize(final PluginCall call) {
@@ -73,6 +81,22 @@ public class AdMob extends Plugin {
         call.resolve(response);
     }
 
+    // User Consent
+    @PluginMethod
+    public void requestConsentInfo(final PluginCall call) {
+        adConsentExecutor.requestConsentInfo(call, this::notifyListeners);
+    }
+
+    @PluginMethod
+    public void showConsentForm(final PluginCall call) {
+        adConsentExecutor.showConsentForm(call, this::notifyListeners);
+    }
+
+    @PluginMethod
+    public void resetConsentInfo(final PluginCall call) {
+        adConsentExecutor.resetConsentInfo(call, this::notifyListeners);
+    }
+
     @PluginMethod
     public void setApplicationMuted(final PluginCall call) {
         Boolean muted = call.getBoolean("muted");

package/android/src/main/java/com/getcapacitor/community/admob/banner/BannerExecutor.java

@@ -2,10 +2,12 @@ package com.getcapacitor.community.admob.banner;
 
 import android.app.Activity;
 import android.content.Context;
+import android.util.DisplayMetrics;
 import android.util.Log;
 import android.view.Gravity;
 import android.view.View;
 import android.view.ViewGroup;
+import android.view.WindowManager;
 import android.widget.RelativeLayout;
 import androidx.annotation.NonNull;
 import androidx.coordinatorlayout.widget.CoordinatorLayout;
@@ -46,9 +48,19 @@ public class BannerExecutor extends Executor {
 
     public void showBanner(final PluginCall call) {
         final AdOptions adOptions = AdOptions.getFactory().createBannerOptions(call);
-        float widthPixels = (int) contextSupplier.get().getResources().getDisplayMetrics().widthPixels;
         float density = contextSupplier.get().getResources().getDisplayMetrics().density;
 
+        int defaultWidthPixels = contextSupplier.get().getResources().getDisplayMetrics().widthPixels;
+
+        DisplayMetrics metrics = new DisplayMetrics();
+        activitySupplier.get().getWindowManager().getDefaultDisplay().getRealMetrics(metrics);
+        int realWidthPixels = metrics.widthPixels;
+
+        boolean fullscreen = false;
+        if ((activitySupplier.get().getWindow().getAttributes().flags & WindowManager.LayoutParams.FLAG_FULLSCREEN) != 0) {
+            fullscreen = true;
+        }
+
         if (mAdView != null) {
             updateExistingAdView(adOptions);
             return;
@@ -63,7 +75,7 @@ public class BannerExecutor extends Executor {
             } else {
                 // ADAPTIVE BANNER
                 mAdView.setAdSize(
-                    AdSize.getCurrentOrientationAnchoredAdaptiveBannerAdSize(contextSupplier.get(), (int) (widthPixels / density))
+                    AdSize.getCurrentOrientationAnchoredAdaptiveBannerAdSize(contextSupplier.get(), (int) (defaultWidthPixels / density))
                 );
             }
 
@@ -96,11 +108,18 @@ public class BannerExecutor extends Executor {
 
             // Center Banner Ads
             int adWidth = (int) (adOptions.adSize.getSize().getWidth() * density);
-            int sideMargin = ((int) widthPixels - adWidth) / 2;
 
             if (adWidth <= 0 || adOptions.adSize.toString().equals("ADAPTIVE_BANNER")) {
-                mAdViewLayoutParams.setMargins(0, densityMargin, 0, densityMargin);
+                int margin = 0;
+                if (fullscreen) {
+                    margin = (realWidthPixels - defaultWidthPixels) / 2;
+                }
+                mAdViewLayoutParams.setMargins(margin, densityMargin, margin, densityMargin);
             } else {
+                int sideMargin = ((int) defaultWidthPixels - adWidth) / 2;
+                if (fullscreen) {
+                    sideMargin = (realWidthPixels - adWidth) / 2;
+                }
                 mAdViewLayoutParams.setMargins(sideMargin, densityMargin, sideMargin, densityMargin);
             }
 

package/android/src/main/java/com/getcapacitor/community/admob/consent/AdConsentExecutor.java

@@ -0,0 +1,145 @@
+package com.getcapacitor.community.admob.consent;
+
+import android.app.Activity;
+import android.content.Context;
+import android.content.SharedPreferences;
+import android.preference.PreferenceManager;
+import androidx.core.util.Supplier;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.community.admob.models.Executor;
+import com.google.android.gms.common.util.BiConsumer;
+import com.google.android.ump.ConsentDebugSettings;
+import com.google.android.ump.ConsentForm;
+import com.google.android.ump.ConsentInformation;
+import com.google.android.ump.ConsentRequestParameters;
+import com.google.android.ump.FormError;
+import com.google.android.ump.UserMessagingPlatform;
+
+public class AdConsentExecutor extends Executor {
+
+    private ConsentInformation consentInformation;
+
+    public AdConsentExecutor(
+        Supplier<Context> contextSupplier,
+        Supplier<Activity> activitySupplier,
+        BiConsumer<String, JSObject> notifyListenersFunction,
+        String pluginLogTag
+    ) {
+        super(contextSupplier, activitySupplier, notifyListenersFunction, pluginLogTag, "AdConsentExecutor");
+    }
+
+    @PluginMethod
+    public void requestConsentInfo(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        try {
+            ensureConsentInfo();
+
+            ConsentRequestParameters.Builder paramsBuilder = new ConsentRequestParameters.Builder();
+            ConsentDebugSettings.Builder debugSettingsBuilder = new ConsentDebugSettings.Builder(contextSupplier.get());
+
+            if (call.getData().has("testDeviceIdentifiers")) {
+                JSArray devices = call.getArray("testDeviceIdentifiers");
+
+                for (int i = 0; i < devices.length(); i++) {
+                    debugSettingsBuilder.addTestDeviceHashedId(devices.getString(i));
+                }
+            }
+
+            if (call.getData().has("debugGeography")) {
+                debugSettingsBuilder.setDebugGeography(call.getInt("debugGeography"));
+            }
+
+            paramsBuilder.setConsentDebugSettings(debugSettingsBuilder.build());
+
+            if (call.getData().has("tagForUnderAgeOfConsent")) {
+                paramsBuilder.setTagForUnderAgeOfConsent(call.getBoolean("tagForUnderAgeOfConsent"));
+            }
+
+            ConsentRequestParameters consentRequestParameters = paramsBuilder.build();
+
+            if (activitySupplier.get() == null) {
+                call.reject("Trying to request consent info but the Activity is null");
+                return;
+            }
+
+            consentInformation.requestConsentInfoUpdate(
+                activitySupplier.get(),
+                consentRequestParameters,
+                () -> {
+                    JSObject consentInfo = new JSObject();
+                    consentInfo.put("status", getConsentStatusString(consentInformation.getConsentStatus()));
+                    consentInfo.put("isConsentFormAvailable", consentInformation.isConsentFormAvailable());
+                    call.resolve(consentInfo);
+                },
+                formError -> call.reject(formError.getMessage())
+            );
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage(), ex);
+        }
+    }
+
+    @PluginMethod
+    public void showConsentForm(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        try {
+            if (activitySupplier.get() == null) {
+                call.reject("Trying to show the consent form but the Activity is null");
+                return;
+            }
+            ensureConsentInfo();
+            activitySupplier
+                .get()
+                .runOnUiThread(
+                    () ->
+                        UserMessagingPlatform.loadConsentForm(
+                            contextSupplier.get(),
+                            consentForm ->
+                                consentForm.show(
+                                    activitySupplier.get(),
+                                    formError -> {
+                                        if (formError != null) {
+                                            call.reject("Error when show consent form", formError.getMessage());
+                                        } else {
+                                            JSObject consentFormInfo = new JSObject();
+                                            consentFormInfo.put("status", getConsentStatusString(consentInformation.getConsentStatus()));
+
+                                            call.resolve(consentFormInfo);
+                                        }
+                                    }
+                                ),
+                            formError -> call.reject("Error when show consent form", formError.getMessage())
+                        )
+                );
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage(), ex);
+        }
+    }
+
+    @PluginMethod
+    public void resetConsentInfo(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        ensureConsentInfo();
+        consentInformation.reset();
+        call.resolve();
+    }
+
+    private String getConsentStatusString(int consentConstant) {
+        switch (consentConstant) {
+            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 "UNKNOWN";
+        }
+    }
+
+    private void ensureConsentInfo() {
+        if (consentInformation == null) {
+            consentInformation = UserMessagingPlatform.getConsentInformation(contextSupplier.get());
+        }
+    }
+}

package/android/src/main/java/com/getcapacitor/community/admob/rewarded/AdRewardExecutor.java

@@ -71,7 +71,6 @@ public class AdRewardExecutor extends Executor {
                             activitySupplier.get(),
                             RewardedAdCallbackAndListeners.INSTANCE.getOnUserEarnedRewardListener(call, notifyListenersFunction)
                         );
-                        call.resolve();
                     }
                 );
         } catch (Exception ex) {