@capacitor-community/admob 8.0.0-0 → 8.0.1

package/CapacitorCommunityAdmob.podspec

@@ -15,6 +15,6 @@ Pod::Spec.new do |s|
   s.swift_version = '5.1'
   s.static_framework = true
   s.dependency 'Capacitor'
-  s.dependency 'Google-Mobile-Ads-SDK', '12.12.0'
-  s.dependency 'GoogleUserMessagingPlatform', '3.0.0'
+  s.dependency 'Google-Mobile-Ads-SDK', '~> 12.14'
+  s.dependency 'GoogleUserMessagingPlatform', '~> 3.1'
 end

package/Package.swift

@@ -11,8 +11,8 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0"),
-        .package(url: "https://github.com/googleads/swift-package-manager-google-mobile-ads.git", from: "12.12.0"),
-        .package(url: "https://github.com/googleads/swift-package-manager-google-user-messaging-platform.git", from: "3.0.0")
+        .package(url: "https://github.com/googleads/swift-package-manager-google-mobile-ads.git", .upToNextMinor(from: "12.14.0")),
+        .package(url: "https://github.com/googleads/swift-package-manager-google-user-messaging-platform.git", .upToNextMinor(from: "3.1.0"))
     ],
     targets: [
         .target(

package/README.md

@@ -36,10 +36,10 @@ Made with [contributors-img](https://contrib.rocks).
 
 ### Screenshots
 
-|             |                Banner                |                Interstitial                |                Reward                |
-| :---------- | :----------------------------------: | :----------------------------------------: | :----------------------------------: |
-| **iOS**     | ![](demo/screenshots/ios_banner.png) | ![](demo/screenshots/ios_interstitial.png) | ![](demo/screenshots/ios_reward.png) |
-| **Android** | ![](demo/screenshots/md_banner.png)  | ![](demo/screenshots/md_interstitial.png)  | ![](demo/screenshots/md_reward.png)  |
+|             |                Banner                |                Interstitial                |                Reward                |              App Open               |
+| :---------- | :----------------------------------: | :----------------------------------------: | :----------------------------------: | :---------------------------------: |
+| **iOS**     | ![](demo/screenshots/ios_banner.png) | ![](demo/screenshots/ios_interstitial.png) | ![](demo/screenshots/ios_reward.png) | ![](demo/screenshots/ios_open.png)  |
+| **Android** | ![](demo/screenshots/md_banner.png)  | ![](demo/screenshots/md_interstitial.png)  | ![](demo/screenshots/md_reward.png)  | ![](demo/screenshots/md_open.png)   |
 
 ## Installation
 
@@ -188,7 +188,44 @@ const consentInfo = await AdMob.requestConsentInfo({
 2. AdMob.requestConsentInfo
 3. AdMob.showConsentForm (If consent form required )
    3/ AdMob.showBanner
+   
+### Show App Open Ad
 
+```ts
+import {
+  AdMob,
+  AppOpenAdPluginEvents,
+  AppOpenAdOptions,
+} from '@capacitor-community/admob';
+
+export async function showAppOpenAd(): Promise<void> {
+  // listen to events
+  AdMob.addListener(AppOpenAdPluginEvents.Loaded, () => {
+    console.log('App Open Ad loaded');
+  });
+  AdMob.addListener(AppOpenAdPluginEvents.FailedToLoad, (error) => {
+    console.log('Failed to load App Open Ad', error);
+  });
+  AdMob.addListener(AppOpenAdPluginEvents.Opened, () => {
+    console.log('App Open Ad open');
+  });
+  AdMob.addListener(AppOpenAdPluginEvents.Closed, () => {
+    console.log('App Open Ad close');
+  });
+  AdMob.addListener(AppOpenAdPluginEvents.FailedToShow, (error) => {
+    console.log('Failed to show App Open Ad', error);
+  });
+
+  const options: AppOpenAdOptions = {
+    adId: 'YOUR_AD_UNIT_ID',
+  };
+  await AdMob.loadAppOpen(options);
+  const { value } = await AdMob.isAppOpenLoaded();
+  if (value) {
+    await AdMob.showAppOpen();
+  }
+}
+```
 ### Show Banner
 
 ```ts
@@ -334,6 +371,14 @@ AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {
 * [`requestTrackingAuthorization()`](#requesttrackingauthorization)
 * [`setApplicationMuted(...)`](#setapplicationmuted)
 * [`setApplicationVolume(...)`](#setapplicationvolume)
+* [`loadAppOpen(...)`](#loadappopen)
+* [`showAppOpen()`](#showappopen)
+* [`isAppOpenLoaded()`](#isappopenloaded)
+* [`addListener(AppOpenAdPluginEvents.Loaded, ...)`](#addlistenerappopenadplugineventsloaded-)
+* [`addListener(AppOpenAdPluginEvents.FailedToLoad, ...)`](#addlistenerappopenadplugineventsfailedtoload-)
+* [`addListener(AppOpenAdPluginEvents.Opened, ...)`](#addlistenerappopenadplugineventsopened-)
+* [`addListener(AppOpenAdPluginEvents.Closed, ...)`](#addlistenerappopenadplugineventsclosed-)
+* [`addListener(AppOpenAdPluginEvents.FailedToShow, ...)`](#addlistenerappopenadplugineventsfailedtoshow-)
 * [`showBanner(...)`](#showbanner)
 * [`hideBanner()`](#hidebanner)
 * [`resumeBanner()`](#resumebanner)
@@ -461,6 +506,125 @@ Report application volume to AdMob SDK
 --------------------
 
 
+### loadAppOpen(...)
+
+```typescript
+loadAppOpen(options: AppOpenAdOptions) => Promise<void>
+```
+
+Load an App Open ad
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#appopenadoptions">AppOpenAdOptions</a></code> |
+
+--------------------
+
+
+### showAppOpen()
+
+```typescript
+showAppOpen() => Promise<void>
+```
+
+Shows the App Open ad if loaded
+
+--------------------
+
+
+### isAppOpenLoaded()
+
+```typescript
+isAppOpenLoaded() => Promise<{ value: boolean; }>
+```
+
+Check if the App Open ad is loaded
+
+**Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>
+
+--------------------
+
+
+### addListener(AppOpenAdPluginEvents.Loaded, ...)
+
+```typescript
+addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                           |
+| ------------------ | ------------------------------------------------------------------------------ |
+| **`eventName`**    | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Loaded</a></code> |
+| **`listenerFunc`** | <code>() =&gt; void</code>                                                     |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(AppOpenAdPluginEvents.FailedToLoad, ...)
+
+```typescript
+addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                 |
+| ------------------ | ------------------------------------------------------------------------------------ |
+| **`eventName`**    | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.FailedToLoad</a></code> |
+| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) =&gt; void</code>                |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(AppOpenAdPluginEvents.Opened, ...)
+
+```typescript
+addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                           |
+| ------------------ | ------------------------------------------------------------------------------ |
+| **`eventName`**    | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Opened</a></code> |
+| **`listenerFunc`** | <code>() =&gt; void</code>                                                     |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(AppOpenAdPluginEvents.Closed, ...)
+
+```typescript
+addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                           |
+| ------------------ | ------------------------------------------------------------------------------ |
+| **`eventName`**    | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.Closed</a></code> |
+| **`listenerFunc`** | <code>() =&gt; void</code>                                                     |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener(AppOpenAdPluginEvents.FailedToShow, ...)
+
+```typescript
+addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                 |
+| ------------------ | ------------------------------------------------------------------------------------ |
+| **`eventName`**    | <code><a href="#appopenadpluginevents">AppOpenAdPluginEvents.FailedToShow</a></code> |
+| **`listenerFunc`** | <code>(error: <a href="#admoberror">AdMobError</a>) =&gt; void</code>                |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
 ### showBanner(...)
 
 ```typescript
@@ -1102,6 +1266,31 @@ addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: ()
 | **`volume`** | <code>0 \| 1 \| 0.1 \| 0.2 \| 0.3 \| 0.4 \| 0.5 \| 0.6 \| 0.7 \| 0.8 \| 0.9</code> | If your app has its own volume controls (such as custom music or sound effect volumes), disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings. enable set 0.0 - 1.0, any float allowed. | 4.1.1 |
 
 
+#### AppOpenAdOptions
+
+| Prop       | Type                |
+| ---------- | ------------------- |
+| **`adId`** | <code>string</code> |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### AdMobError
+
+For more information
+https://developers.google.com/android/reference/com/google/android/gms/ads/AdError
+
+| Prop          | Type                | Description                            |
+| ------------- | ------------------- | -------------------------------------- |
+| **`code`**    | <code>number</code> | Gets the error's code.                 |
+| **`message`** | <code>string</code> | Gets the message describing the error. |
+
+
 #### BannerAdOptions
 
 This interface extends <a href="#adoptions">AdOptions</a>
@@ -1117,13 +1306,6 @@ This interface extends <a href="#adoptions">AdOptions</a>
 | **`immersiveMode`** | <code>boolean</code>                                          | Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode. Call this method before show. During show, if this flag is on and immersive mode is supported, SYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad. |                              | 7.0.3 |
 
 
-#### PluginListenerHandle
-
-| Prop         | Type                                      |
-| ------------ | ----------------------------------------- |
-| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
-
-
 #### AdMobBannerSize
 
 When notice listener of OnAdLoaded, you can get banner size.
@@ -1134,17 +1316,6 @@ When notice listener of OnAdLoaded, you can get banner size.
 | **`height`** | <code>number</code> |
 
 
-#### AdMobError
-
-For more information
-https://developers.google.com/android/reference/com/google/android/gms/ads/AdError
-
-| Prop          | Type                | Description                            |
-| ------------- | ------------------- | -------------------------------------- |
-| **`code`**    | <code>number</code> | Gets the error's code.                 |
-| **`message`** | <code>string</code> | Gets the message describing the error. |
-
-
 #### AdmobConsentInfo
 
 | Prop                                  | Type                                                                                        | Description                                           | Since |
@@ -1256,6 +1427,17 @@ From T, pick a set of properties whose keys are in the union K
 | **`MatureAudience`**   | <code>'MatureAudience'</code>   | Content suitable only for mature audiences.                 |
 
 
+#### AppOpenAdPluginEvents
+
+| Members            | Value                                |
+| ------------------ | ------------------------------------ |
+| **`Loaded`**       | <code>'appOpenAdLoaded'</code>       |
+| **`FailedToLoad`** | <code>'appOpenAdFailedToLoad'</code> |
+| **`Opened`**       | <code>'appOpenAdOpened'</code>       |
+| **`Closed`**       | <code>'appOpenAdClosed'</code>       |
+| **`FailedToShow`** | <code>'appOpenAdFailedToShow'</code> |
+
+
 #### BannerAdSize
 
 | Members                | Value                           | Description                                                                                         |

package/android/build.gradle

@@ -4,8 +4,8 @@ ext {
     androidxCoordinatorLayoutVersion = project.hasProperty('androidxCoordinatorLayoutVersion') ? rootProject.ext.androidxCoordinatorLayoutVersion : '1.3.0'
     androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
     androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
-    playServicesAdsVersion = project.hasProperty('playServicesAdsVersion') ? rootProject.ext.playServicesAdsVersion : '24.7.+'
-    userMessagingPlatformVersion = project.hasProperty('userMessagingPlatformVersion') ? rootProject.ext.userMessagingPlatformVersion : '3.1.0'
+    playServicesAdsVersion = project.hasProperty('playServicesAdsVersion') ? rootProject.ext.playServicesAdsVersion : '24.9.+'
+    userMessagingPlatformVersion = project.hasProperty('userMessagingPlatformVersion') ? rootProject.ext.userMessagingPlatformVersion : '4.0.0'
     androidxCoreKTXVersion = project.hasProperty('androidxCoreKTXVersion') ? rootProject.ext.androidxCoreKTXVersion : '1.15.0'
 }
 

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

@@ -1,6 +1,9 @@
 package com.getcapacitor.community.admob;
 
 import android.Manifest;
+import android.app.Activity;
+import android.os.Handler;
+import android.os.Looper;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
 import com.getcapacitor.Plugin;
@@ -8,6 +11,7 @@ import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
 import com.getcapacitor.annotation.Permission;
+import com.getcapacitor.community.admob.appopen.AppOpenAdPlugin;
 import com.getcapacitor.community.admob.banner.BannerExecutor;
 import com.getcapacitor.community.admob.consent.AdConsentExecutor;
 import com.getcapacitor.community.admob.helpers.AuthorizationStatusEnum;
@@ -34,18 +38,21 @@ public class AdMob extends Plugin {
         this::notifyListeners,
         getLogTag()
     );
+
     private final AdRewardExecutor adRewardExecutor = new AdRewardExecutor(
         this::getContext,
         this::getActivity,
         this::notifyListeners,
         getLogTag()
     );
+
     private final AdRewardInterstitialExecutor adRewardInterstitialExecutor = new AdRewardInterstitialExecutor(
         this::getContext,
         this::getActivity,
         this::notifyListeners,
         getLogTag()
     );
+
     private final AdInterstitialExecutor adInterstitialExecutor = new AdInterstitialExecutor(
         this::getContext,
         this::getActivity,
@@ -61,23 +68,52 @@ public class AdMob extends Plugin {
         getLogTag()
     );
 
-    // Initialize AdMob with appId
+    private final AppOpenAdPlugin appOpenAdPlugin = new AppOpenAdPlugin();
+
+    @PluginMethod
+    public void loadAppOpen(final PluginCall call) {
+        appOpenAdPlugin.loadAppOpen(getContext(), getActivity(), call, this::notifyListeners);
+    }
+
+    @PluginMethod
+    public void showAppOpen(final PluginCall call) {
+        appOpenAdPlugin.showAppOpen(getActivity(), call, this::notifyListeners);
+    }
+
+    @PluginMethod
+    public void isAppOpenLoaded(final PluginCall call) {
+        appOpenAdPlugin.isAppOpenLoaded(getActivity(), call);
+    }
+
+    // ---------------------------------------------------------
+    // MAIN METHODS
+    // ---------------------------------------------------------
+
     @PluginMethod
     public void initialize(final PluginCall call) {
         this.setRequestConfiguration(call);
 
-        try {
-            MobileAds.initialize(
-                getContext(),
-                new OnInitializationCompleteListener() {
-                    @Override
-                    public void onInitializationComplete(InitializationStatus initializationStatus) {}
-                }
-            );
-            bannerExecutor.initialize();
-            call.resolve();
-        } catch (Exception ex) {
-            call.reject(ex.getLocalizedMessage(), ex);
+        // Same as banner/interstitial: bridge thread is not the UI thread — MobileAds + view setup must run on main.
+        Runnable initOnMain = () -> {
+            try {
+                MobileAds.initialize(
+                    getContext(),
+                    new OnInitializationCompleteListener() {
+                        @Override
+                        public void onInitializationComplete(InitializationStatus initializationStatus) {}
+                    }
+                );
+                bannerExecutor.initialize();
+                call.resolve();
+            } catch (Exception ex) {
+                call.reject(ex.getLocalizedMessage(), ex);
+            }
+        };
+        Activity activity = getActivity();
+        if (activity != null) {
+            activity.runOnUiThread(initOnMain);
+        } else {
+            new Handler(Looper.getMainLooper()).post(initOnMain);
         }
     }
 
@@ -93,7 +129,10 @@ public class AdMob extends Plugin {
         call.resolve(response);
     }
 
-    // User Consent
+    // ---------------------------------------------------------
+    // USER CONSENT
+    // ---------------------------------------------------------
+
     @PluginMethod
     public void requestConsentInfo(final PluginCall call) {
         adConsentExecutor.requestConsentInfo(call, this::notifyListeners);
@@ -114,6 +153,10 @@ public class AdMob extends Plugin {
         adConsentExecutor.resetConsentInfo(call, this::notifyListeners);
     }
 
+    // ---------------------------------------------------------
+    // APP SETTINGS
+    // ---------------------------------------------------------
+
     @PluginMethod
     public void setApplicationMuted(final PluginCall call) {
         Boolean muted = call.getBoolean("muted");
@@ -136,41 +179,48 @@ public class AdMob extends Plugin {
         call.resolve();
     }
 
-    // Show a banner Ad
+    // ---------------------------------------------------------
+    // BANNER ADS
+    // ---------------------------------------------------------
+
     @PluginMethod
     public void showBanner(final PluginCall call) {
         bannerExecutor.showBanner(call);
     }
 
-    // Hide the banner, remove it from screen, but can show it later
     @PluginMethod
     public void hideBanner(final PluginCall call) {
         bannerExecutor.hideBanner(call);
     }
 
-    // Resume the banner, show it after hide
     @PluginMethod
     public void resumeBanner(final PluginCall call) {
         bannerExecutor.resumeBanner(call);
     }
 
-    // Destroy the banner, remove it from screen.
     @PluginMethod
     public void removeBanner(final PluginCall call) {
         bannerExecutor.removeBanner(call);
     }
 
+    // ---------------------------------------------------------
+    // INTERSTITIAL ADS
+    // ---------------------------------------------------------
+
     @PluginMethod
     public void prepareInterstitial(final PluginCall call) {
         adInterstitialExecutor.prepareInterstitial(call, this::notifyListeners);
     }
 
-    // Show interstitial Ad
     @PluginMethod
     public void showInterstitial(final PluginCall call) {
         adInterstitialExecutor.showInterstitial(call, this::notifyListeners);
     }
 
+    // ---------------------------------------------------------
+    // REWARDED ADS
+    // ---------------------------------------------------------
+
     @PluginMethod
     public void prepareRewardVideoAd(final PluginCall call) {
         adRewardExecutor.prepareRewardVideoAd(call, this::notifyListeners);
@@ -191,10 +241,10 @@ public class AdMob extends Plugin {
         adRewardInterstitialExecutor.showRewardInterstitialAd(call, this::notifyListeners);
     }
 
-    /**
-     * @see <a href="https://developers.google.com/admob/android/test-ads#enable_test_devices">Test Devices</a>
-     * @see <a href="https://developers.google.com/admob/android/targeting">Target Settings</a>
-     */
+    // ---------------------------------------------------------
+    // REQUEST CONFIGURATION
+    // ---------------------------------------------------------
+
     private void setRequestConfiguration(final PluginCall call) {
         // Testing Devices
         final boolean initializeForTesting = call.getBoolean("initializeForTesting", false);

package/android/src/main/java/com/getcapacitor/community/admob/appopen/AppOpenAdManager.kt

@@ -0,0 +1,86 @@
+package com.getcapacitor.community.admob.appopen
+
+import android.app.Activity
+import android.content.Context
+import com.google.android.gms.ads.AdError
+import com.google.android.gms.ads.AdRequest
+import com.google.android.gms.ads.FullScreenContentCallback
+import com.google.android.gms.ads.LoadAdError
+import com.google.android.gms.ads.appopen.AppOpenAd
+
+class AppOpenAdManager(val adUnitId: String) {
+
+    private var appOpenAd: AppOpenAd? = null
+    private var isLoadingAd = false
+    private var isShowingAd = false
+
+    val isAdLoaded: Boolean
+        get() = appOpenAd != null
+
+    fun loadAd(context: Context, onLoaded: () -> Unit, onFailed: (LoadAdError?) -> Unit) {
+        if (appOpenAd != null) {
+            onLoaded()
+            return
+        }
+
+        if (isLoadingAd) {
+            onFailed(null)
+            return
+        }
+
+        isLoadingAd = true
+        val request = AdRequest.Builder().build()
+
+        // play-services-ads 24.x: orientation overload removed; SDK picks orientation from the activity.
+        AppOpenAd.load(
+            context,
+            adUnitId,
+            request,
+            object : AppOpenAd.AppOpenAdLoadCallback() {
+                override fun onAdLoaded(ad: AppOpenAd) {
+                    appOpenAd = ad
+                    isLoadingAd = false
+                    onLoaded()
+                }
+
+                override fun onAdFailedToLoad(loadAdError: LoadAdError) {
+                    isLoadingAd = false
+                    onFailed(loadAdError)
+                }
+            }
+        )
+    }
+
+    fun showAdIfAvailable(
+        activity: Activity,
+        onOpened: () -> Unit,
+        onClosed: () -> Unit,
+        onFailedToShow: (AdError?) -> Unit
+    ) {
+        if (appOpenAd == null || isShowingAd) {
+            onFailedToShow(null)
+            return
+        }
+
+        isShowingAd = true
+        appOpenAd?.fullScreenContentCallback = object : FullScreenContentCallback() {
+            override fun onAdShowedFullScreenContent() {
+                onOpened()
+            }
+
+            override fun onAdDismissedFullScreenContent() {
+                appOpenAd = null
+                isShowingAd = false
+                onClosed()
+            }
+
+            override fun onAdFailedToShowFullScreenContent(adError: AdError) {
+                appOpenAd = null
+                isShowingAd = false
+                onFailedToShow(adError)
+            }
+        }
+
+        appOpenAd?.show(activity)
+    }
+}