@ququplay/admob 8.1.0 → 8.2.0

package/README.md

@@ -1327,14 +1327,15 @@ https://developers.google.com/android/reference/com/google/android/gms/ads/AdErr
 
 #### NativeAdOptions
 
-| Prop                | Type                                                    | Description                                                                                                                                                                                                                                                                                                          | Default            | Since |
-| ------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
-| **`style`**         | <code><a href="#nativeadstyle">NativeAdStyle</a></code> | Colours of the native ad strip, as `#RRGGBB` (or `#AARRGGBB`).                                                                                                                                                                                                                                                       |                    | 8.1.0 |
-| **`adId`**          | <code>string</code>                                     | The ad unit ID that you want to request                                                                                                                                                                                                                                                                              |                    | 1.1.2 |
-| **`isTesting`**     | <code>boolean</code>                                    | You can use test mode of ad.                                                                                                                                                                                                                                                                                         | <code>false</code> | 1.1.2 |
-| **`margin`**        | <code>number</code>                                     | Margin Banner. Default is 0px; If position is BOTTOM_CENTER, margin is be margin-bottom. If position is TOP_CENTER, margin is be margin-top.                                                                                                                                                                         | <code>0</code>     | 1.1.2 |
-| **`npa`**           | <code>boolean</code>                                    | The default behavior of the Google Mobile Ads SDK is to serve personalized ads. Set this to true to request Non-Personalized Ads                                                                                                                                                                                     | <code>false</code> | 1.2.0 |
-| **`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 |
+| Prop                  | Type                                                    | Description                                                                                                                                                                                                                                                                                                          | Default            | Since |
+| --------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| **`style`**           | <code><a href="#nativeadstyle">NativeAdStyle</a></code> | Colours of the native ad strip, as `#RRGGBB` (or `#AARRGGBB`).                                                                                                                                                                                                                                                       |                    | 8.1.0 |
+| **`refreshInterval`** | <code>number</code>                                     | Seconds the ad stays on screen before a new one replaces it. Only the time it is shown counts: hidden, or with the app in the background, it waits. The old ad stays up until the new one loads. 0, the default, keeps it until it expires after an hour.                                                            |                    | 8.2.0 |
+| **`adId`**            | <code>string</code>                                     | The ad unit ID that you want to request                                                                                                                                                                                                                                                                              |                    | 1.1.2 |
+| **`isTesting`**       | <code>boolean</code>                                    | You can use test mode of ad.                                                                                                                                                                                                                                                                                         | <code>false</code> | 1.1.2 |
+| **`margin`**          | <code>number</code>                                     | Margin Banner. Default is 0px; If position is BOTTOM_CENTER, margin is be margin-bottom. If position is TOP_CENTER, margin is be margin-top.                                                                                                                                                                         | <code>0</code>     | 1.1.2 |
+| **`npa`**             | <code>boolean</code>                                    | The default behavior of the Google Mobile Ads SDK is to serve personalized ads. Set this to true to request Non-Personalized Ads                                                                                                                                                                                     | <code>false</code> | 1.2.0 |
+| **`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 |
 
 
 #### NativeAdStyle

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

@@ -168,6 +168,18 @@ public class AdMob extends Plugin {
         bannerExecutor.removeBanner(call);
     }
 
+    @Override
+    protected void handleOnPause() {
+        super.handleOnPause();
+        nativeAdExecutor.onPause();
+    }
+
+    @Override
+    protected void handleOnResume() {
+        super.handleOnResume();
+        nativeAdExecutor.onResume();
+    }
+
     // Show a native ad across the top of the screen, loading one when there is none or it expired
     @PluginMethod
     public void showNativeAd(final PluginCall call) {

package/android/src/main/java/com/getcapacitor/community/admob/nativead/NativeAdExecutor.java

@@ -39,6 +39,8 @@ import com.google.android.gms.common.util.BiConsumer;
 /**
  * A native ad drawn as a strip across the top of the screen, over the WebView, like a top banner.
  * Hiding keeps the loaded ad, so showing it again brings back the same ad without a new request.
+ * With a refresh interval, a new ad replaces it once it has been on screen that long in all, hidden time and time in
+ * the background not counted; the old one stays up until the new one comes.
  */
 public class NativeAdExecutor extends Executor {
 
@@ -55,6 +57,17 @@ public class NativeAdExecutor extends Executor {
     private long mLoadedAt;
     private boolean mLoading;
     private boolean mWantsVisible;
+    private boolean mPaused;
+    // What the next refresh asks for: the last show's ad unit and request.
+    private String mAdId;
+    private AdRequest mAdRequest;
+    private long mRefreshMs;
+    // How long the current ad has been on screen: the time before it was last hidden, and since when it shows.
+    private long mShownMs;
+    private long mShownSince = -1;
+    private final Runnable mRefresh = () -> {
+        if (mAdId != null) load(mAdId, mAdRequest);
+    };
     // The status bar can change height while the ad is up (rotation, display size), so its margin follows it.
     private final ViewTreeObserver.OnGlobalLayoutListener insetListener = () -> {
         if (mAdView != null) applyTopInset();
@@ -76,6 +89,7 @@ public class NativeAdExecutor extends Executor {
     public void showNativeAd(final PluginCall call) {
         final AdOptions adOptions = AdOptions.getFactory().createGenericOptions(call, NATIVE_TESTER_ID);
         final JSObject style = call.getObject("style", new JSObject());
+        final long refreshMs = Math.max(0, call.getInt("refreshInterval", 0)) * 1000L;
 
         activitySupplier
             .get()
@@ -89,8 +103,13 @@ public class NativeAdExecutor extends Executor {
                     final AdRequest adRequest = RequestHelper.createRequest(adOptions);
                     final String adId = AdViewIdHelper.getFinalAdId(adOptions, adRequest, logTag, contextSupplier.get());
 
+                    mAdId = adId;
+                    mAdRequest = adRequest;
+                    mRefreshMs = refreshMs;
+
                     if (mNativeAd != null && adId.equals(mLoadedAdId) && !isExpired()) {
                         setVisible(true);
+                        startCounting();
                     } else {
                         load(adId, adRequest);
                     }
@@ -107,6 +126,7 @@ public class NativeAdExecutor extends Executor {
             .get()
             .runOnUiThread(() -> {
                 mWantsVisible = false;
+                stopCounting();
                 if (mAdView != null) {
                     setVisible(false);
                 }
@@ -119,6 +139,7 @@ public class NativeAdExecutor extends Executor {
             .get()
             .runOnUiThread(() -> {
                 mWantsVisible = false;
+                stopCounting();
                 destroyNativeAd();
 
                 if (mAdView != null) {
@@ -151,15 +172,18 @@ public class NativeAdExecutor extends Executor {
                     return;
                 }
 
+                stopCounting();
                 destroyNativeAd();
                 mNativeAd = nativeAd;
                 mLoadedAdId = adId;
                 mLoadedAt = SystemClock.elapsedRealtime();
+                mShownMs = 0;
                 populate(nativeAd);
                 notifyListeners(NativeAdPluginEvents.Loaded.getWebEventName(), emptyObject);
 
                 if (mWantsVisible) {
                     setVisible(true);
+                    startCounting();
                 }
             })
             .withAdListener(
@@ -167,14 +191,18 @@ public class NativeAdExecutor extends Executor {
                     @Override
                     public void onAdFailedToLoad(@NonNull LoadAdError adError) {
                         mLoading = false;
+                        stopCounting();
 
-                        // An expired ad may not be shown again; a fresh one keeps showing.
+                        // An expired ad may not be shown again; a fresh one keeps showing, and the next refresh is
+                        // tried after another interval on screen.
                         if (mNativeAd != null && isExpired()) {
                             destroyNativeAd();
                         }
                         if (mNativeAd == null && mAdView != null) {
                             setVisible(false);
                         }
+                        mShownMs = 0;
+                        startCounting();
 
                         notifyListeners(NativeAdPluginEvents.FailedToLoad.getWebEventName(), new AdMobPluginError(adError));
                     }
@@ -195,6 +223,33 @@ public class NativeAdExecutor extends Executor {
         adLoader.loadAd(adRequest);
     }
 
+    // The app went to the background, or came back: the ad is not on screen meanwhile.
+    public void onPause() {
+        mPaused = true;
+        stopCounting();
+    }
+
+    public void onResume() {
+        mPaused = false;
+        startCounting();
+    }
+
+    // Counts the time the ad is on screen and asks for a new one when it has been there for the refresh interval.
+    private void startCounting() {
+        if (mShownSince >= 0 || mRefreshMs <= 0 || mNativeAd == null || mAdView == null || !mWantsVisible || mPaused) return;
+
+        mShownSince = SystemClock.elapsedRealtime();
+        mAdView.postDelayed(mRefresh, Math.max(0, mRefreshMs - mShownMs));
+    }
+
+    private void stopCounting() {
+        if (mAdView != null) mAdView.removeCallbacks(mRefresh);
+        if (mShownSince < 0) return;
+
+        mShownMs += SystemClock.elapsedRealtime() - mShownSince;
+        mShownSince = -1;
+    }
+
     private void ensureAdView() {
         if (mAdView != null) return;
 

package/dist/docs.json

@@ -2053,6 +2053,18 @@
           ],
           "type": "NativeAdStyle"
         },
+        {
+          "name": "refreshInterval",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Seconds the ad stays on screen before a new one replaces it. Only the time it is shown counts: hidden, or with\nthe app in the background, it waits. The old ad stays up until the new one loads. 0, the default, keeps it until\nit expires after an hour.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
         {
           "name": "adId",
           "tags": [

package/dist/esm/native-ad/native-ad-options.interface.d.ts

@@ -6,6 +6,14 @@ export interface NativeAdOptions extends AdOptions {
      * @since 8.1.0
      */
     style?: NativeAdStyle;
+    /**
+     * Seconds the ad stays on screen before a new one replaces it. Only the time it is shown counts: hidden, or with
+     * the app in the background, it waits. The old ad stays up until the new one loads. 0, the default, keeps it until
+     * it expires after an hour.
+     *
+     * @since 8.2.0
+     */
+    refreshInterval?: number;
 }
 export interface NativeAdStyle {
     /**

package/ios/Sources/AdMobPlugin/NativeAd/NativeAdExecutor.swift

@@ -5,6 +5,8 @@ import GoogleMobileAds
 /**
  * A native ad drawn as a strip across the top of the screen, below the status bar, over the WebView like a top banner.
  * Hiding keeps the loaded ad, so showing it again brings back the same ad without a new request.
+ * With a refresh interval, a new ad replaces it once it has been on screen that long in all, hidden time and time in
+ * the background not counted; the old one stays up until the new one comes.
  */
 class NativeAdExecutor: NSObject, NativeAdLoaderDelegate, NativeAdDelegate {
     weak var plugin: AdMobPlugin?
@@ -18,6 +20,16 @@ class NativeAdExecutor: NSObject, NativeAdLoaderDelegate, NativeAdDelegate {
     private var loadedAdUnitID: String?
     private var loadedAt = Date.distantPast
     private var wantsVisible = false
+    private var inBackground = false
+    // What the next refresh asks for: the last show's ad unit and request.
+    private var adUnitID: String?
+    private var request: Request?
+    private var refreshInterval: TimeInterval = 0
+    // How long the current ad has been on screen: the time before it was last hidden, and since when it shows.
+    private var shownTime: TimeInterval = 0
+    private var shownSince: Date?
+    private var refreshTimer: Timer?
+    private var observers: [NSObjectProtocol] = []
 
     private let iconView = UIImageView()
     private let badgeLabel = PaddedLabel()
@@ -35,10 +47,15 @@ class NativeAdExecutor: NSObject, NativeAdLoaderDelegate, NativeAdDelegate {
 
         ensureAdView(in: rootViewController.view)
         applyStyle(call.getObject("style") ?? [:])
+        observeApp()
         wantsVisible = true
+        self.adUnitID = adUnitID
+        self.request = request
+        refreshInterval = TimeInterval(max(0, call.getInt("refreshInterval") ?? 0))
 
         if nativeAd != nil && loadedAdUnitID == adUnitID && !isExpired() {
             setVisible(true)
+            startCounting()
         } else {
             load(adUnitID, request, rootViewController)
         }
@@ -48,6 +65,7 @@ class NativeAdExecutor: NSObject, NativeAdLoaderDelegate, NativeAdDelegate {
 
     func hideNativeAd(_ call: CAPPluginCall) {
         wantsVisible = false
+        stopCounting()
         if adView != nil {
             setVisible(false)
         }
@@ -56,6 +74,7 @@ class NativeAdExecutor: NSObject, NativeAdLoaderDelegate, NativeAdDelegate {
 
     func removeNativeAd(_ call: CAPPluginCall) {
         wantsVisible = false
+        stopCounting()
         nativeAd = nil
         loadedAdUnitID = nil
 
@@ -87,23 +106,28 @@ class NativeAdExecutor: NSObject, NativeAdLoaderDelegate, NativeAdDelegate {
         // Removed while it loaded.
         guard let adView = adView else { return }
 
+        stopCounting()
         nativeAd.delegate = self
         self.nativeAd = nativeAd
         loadedAdUnitID = adLoader.adUnitID
         loadedAt = Date()
+        shownTime = 0
         populate(adView, nativeAd)
         plugin?.notifyListeners(NativeAdPluginEvents.Loaded.rawValue, data: [:])
 
         if wantsVisible {
             setVisible(true)
+            startCounting()
         }
     }
 
     func adLoader(_ adLoader: AdLoader, didFailToReceiveAdWithError error: Error) {
         self.adLoader = nil
         NSLog("AdMob: native ad failed to load: \(error.localizedDescription)")
+        stopCounting()
 
-        // An expired ad may not be shown again; a fresh one keeps showing.
+        // An expired ad may not be shown again; a fresh one keeps showing, and the next refresh is tried after another
+        // interval on screen.
         if nativeAd != nil && isExpired() {
             nativeAd = nil
             loadedAdUnitID = nil
@@ -111,6 +135,8 @@ class NativeAdExecutor: NSObject, NativeAdLoaderDelegate, NativeAdDelegate {
         if nativeAd == nil && adView != nil {
             setVisible(false)
         }
+        shownTime = 0
+        startCounting()
 
         plugin?.notifyListeners(NativeAdPluginEvents.FailedToLoad.rawValue, data: [
             "code": (error as NSError).code,
@@ -126,6 +152,45 @@ class NativeAdExecutor: NSObject, NativeAdLoaderDelegate, NativeAdDelegate {
         plugin?.notifyListeners(NativeAdPluginEvents.AdImpression.rawValue, data: [:])
     }
 
+    // Counts the time the ad is on screen and asks for a new one when it has been there for the refresh interval.
+    private func startCounting() {
+        if shownSince != nil || refreshInterval <= 0 || nativeAd == nil || !wantsVisible || inBackground { return }
+
+        shownSince = Date()
+        refreshTimer = Timer.scheduledTimer(withTimeInterval: max(0, refreshInterval - shownTime), repeats: false) { [weak self] _ in
+            guard let self = self, let adUnitID = self.adUnitID, let request = self.request,
+                  let rootViewController = self.plugin?.getRootVC() else { return }
+
+            self.load(adUnitID, request, rootViewController)
+        }
+    }
+
+    private func stopCounting() {
+        refreshTimer?.invalidate()
+        refreshTimer = nil
+        guard let shownSince = shownSince else { return }
+
+        shownTime += Date().timeIntervalSince(shownSince)
+        self.shownSince = nil
+    }
+
+    // The app went to the background, or came back: the ad is not on screen meanwhile.
+    private func observeApp() {
+        if !observers.isEmpty { return }
+
+        let center = NotificationCenter.default
+        observers = [
+            center.addObserver(forName: UIApplication.didEnterBackgroundNotification, object: nil, queue: .main) { [weak self] _ in
+                self?.inBackground = true
+                self?.stopCounting()
+            },
+            center.addObserver(forName: UIApplication.willEnterForegroundNotification, object: nil, queue: .main) { [weak self] _ in
+                self?.inBackground = false
+                self?.startCounting()
+            }
+        ]
+    }
+
     // Icon, "Ad" badge, headline and body, the call to action and AdChoices in the top right corner; a hairline along
     // the bottom separates it from the screen below. The wider trailing padding keeps the button clear of AdChoices.
     private func ensureAdView(in parent: UIView) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ququplay/admob",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "description": "A native plugin for AdMob",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",