emi-indo-cordova-plugin-admob 1.6.9 → 1.8.9

package/README.md

@@ -1,28 +1,45 @@
 
 
 ### emi-indo-cordova-plugin-admob
- Cordova Plugin Admob Android and IOS
- ## Support
+ Cordova/Quasar/Capacitor Plugin Admob Android and IOS
+ ## Support Request Ad Builder
  - AdMob
  - AdManager
  - AdSense New [example ](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/www/js/adSense.js)
 
+ ## Support framework
+ - Quasar: https://github.com/quasarframework/quasar/discussions/17706
+ - Capacitor: https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/discussions/29
+
+> [!NOTE]  
+> - To maintain this plugin in the long run, 
+> - for (regular maintenance),
+> - just give me a cup of coffee.
+ 
+ ## 💰Sponsor this project
+  [![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/emiindo)  
+  [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F16NI8H)
+##  [Check all release notes:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/releases/)
+
 
 ### Mobile Ads SDK (Android: 23.6.0) [Release Notes:](https://developers.google.com/admob/android/rel-notes)
 ### User Messaging Platform (UMP Android: 3.1.0) [Release Notes:](https://developers.google.com/admob/android/privacy/release-notes)
 
-### Mobile Ads SDK (IOS: 11.12.0) [Release Notes:](https://developers.google.com/admob/ios/rel-notes)
+### Mobile Ads SDK (IOS: 11.13.0) [Release Notes:](https://developers.google.com/admob/ios/rel-notes)
 
 ### User Messaging Platform (UMP IOS: 2.7.0) [Release Notes:](https://developers.google.com/ad-manager/mobile-ads-sdk/ios/privacy/download)
-### IAB Europe Transparency & Consent Framework (CPM: 2.2.0)
+### IAB Europe Transparency & Consent Framework (CMP: 2.2.0)
 
-## New example 
-- https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/tree/main/example/www
 
 
 ## Documentation Capacitor example
 -  [Documentation Capacitor example: ](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/discussions/29)
 
+### This is not a dependency, it's a separate plugin but highly recommended.
+https://github.com/EMI-INDO/emi-indo-cordova-plugin-fanalytics
+
+## New example 
+- https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/tree/main/example/www
 
 
 ## Minimum Cordova Engines
@@ -31,6 +48,7 @@
 
 
 ## IOS Ad Support IOS 18 *
+- Fix error build IOS: https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/discussions/42
 - Mobile Ads SDK (IOS: 11.12.0)
 - emi-indo-cordova-plugin-admob@1.6.3 or higher requires cocoapods 1.16.2 or higher
 > [!WARNING]
@@ -100,11 +118,6 @@ https://developers.google.com/admob/ios/quick-start
 
 
 
-## 💰Sponsor this project
-  [![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/emiindo)  
-  [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F16NI8H)
-##  [Check all release notes:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/releases/)
-
 
 
 ## Features

package/capacitor-hook-admob-ids.js

@@ -6,14 +6,12 @@ const configPath = path.join(process.cwd(), 'capacitor.config.json');
 const androidPlatformPath = path.join(process.cwd(), 'android');
 const iosPlatformPath = path.join(process.cwd(), 'ios');
 const pluginPath = path.join(process.cwd(), 'node_modules', 'emi-indo-cordova-plugin-admob', 'plugin.xml');
-const infoPlistPath = path.join(process.cwd(), 'ios', 'App', 'App', 'Info.plist'); 
-
+const infoPlistPath = path.join(process.cwd(), 'ios', 'App', 'App', 'Info.plist');
 
 function fileExists(filePath) {
   return fs.existsSync(filePath);
 }
 
-
 function getAdMobConfig() {
   if (!fileExists(configPath)) {
     throw new Error('capacitor.config.json not found. Ensure this is a Capacitor project.');
@@ -29,10 +27,10 @@ function getAdMobConfig() {
   return {
     APP_ID_ANDROID: admobConfig.APP_ID_ANDROID,
     APP_ID_IOS: admobConfig.APP_ID_IOS,
+    USE_LITE_ADS: admobConfig.USE_LITE_ADS === "lite",
   };
 }
 
-
 function updatePluginXml(admobConfig) {
   if (!fileExists(pluginPath)) {
     console.error('plugin.xml not found. Ensure the plugin is installed.');
@@ -45,11 +43,22 @@ function updatePluginXml(admobConfig) {
     .replace(/<preference name="APP_ID_ANDROID" default=".*?" \/>/, `<preference name="APP_ID_ANDROID" default="${admobConfig.APP_ID_ANDROID}" />`)
     .replace(/<preference name="APP_ID_IOS" default=".*?" \/>/, `<preference name="APP_ID_IOS" default="${admobConfig.APP_ID_IOS}" />`);
 
+  if (admobConfig.USE_LITE_ADS) {
+    pluginContent = pluginContent.replace(
+      /<framework src="com.google.android.gms:play-services-ads:.*?" \/>/,
+      `<framework src="com.google.android.gms:play-services-ads-lite:$PLAY_SERVICES_VERSION" />`
+    );
+  } else {
+    pluginContent = pluginContent.replace(
+      /<framework src="com.google.android.gms:play-services-ads-lite:.*?" \/>/,
+      `<framework src="com.google.android.gms:play-services-ads:$PLAY_SERVICES_VERSION" />`
+    );
+  }
+
   fs.writeFileSync(pluginPath, pluginContent, 'utf8');
-  console.log('AdMob IDs successfully updated in plugin.xml');
+  console.log('AdMob IDs and framework dependency successfully updated in plugin.xml');
 }
 
-
 function updateInfoPlist(admobConfig) {
   if (!fileExists(infoPlistPath)) {
     console.error('Info.plist not found. Ensure you have built the iOS project.');
@@ -59,13 +68,8 @@ function updateInfoPlist(admobConfig) {
   const plistContent = fs.readFileSync(infoPlistPath, 'utf8');
   const plistData = plist.parse(plistContent);
 
-
   plistData.GADApplicationIdentifier = admobConfig.APP_ID_IOS;
-
- 
   plistData.NSUserTrackingUsageDescription = 'This identifier will be used to deliver personalized ads to you.';
-
-  
   plistData.GADDelayAppMeasurementInit = true;
 
   // https://developers.google.com/admob/ios/quick-start
@@ -114,15 +118,12 @@ function updateInfoPlist(admobConfig) {
     { SKAdNetworkIdentifier: '3qcr597p9d.skadnetwork' }, // Zucks
 ];
 
-
   const updatedPlistContent = plist.build(plistData);
   fs.writeFileSync(infoPlistPath, updatedPlistContent, 'utf8');
   console.log('AdMob IDs and additional configurations successfully updated in Info.plist');
 }
 
-
 try {
-
   if (!fileExists(configPath)) {
     throw new Error('capacitor.config.json not found. Skipping setup.');
   }
@@ -131,18 +132,19 @@ try {
     throw new Error('Neither Android nor iOS platforms are found. Ensure platforms are added to your Capacitor project.');
   }
 
-  
   const admobConfig = getAdMobConfig();
 
-
   if (fileExists(androidPlatformPath)) {
     updatePluginXml(admobConfig);
   }
 
-
   if (fileExists(iosPlatformPath)) {
     updateInfoPlist(admobConfig);
   }
 } catch (error) {
   console.error(error.message);
 }
+
+
+  
+  

package/example/capacitor.config.json

@@ -6,7 +6,8 @@
   "plugins": {
     "AdMob": {
       "APP_ID_ANDROID": "ca-app-pub-3940256099942544~3347511713", 
-      "APP_ID_IOS": "ca-app-pub-3940256099942544~1458002511"
+      "APP_ID_IOS": "ca-app-pub-3940256099942544~1458002511",
+      "USE_LITE_ADS": "lite"
     }
   }
 }

package/example/package.json

@@ -14,7 +14,7 @@
   "author": "Apache Cordova Team",
   "license": "Apache-2.0",
   "devDependencies": {
-    "emi-indo-cordova-plugin-admob": "^1.6.4"
+    "emi-indo-cordova-plugin-admob": "^1.8.9"
   },
   "cordova": {
     "plugins": {

package/example/www/js/bannerAd.js

@@ -1,4 +1,4 @@
-// ccordova.plugins.emiAdmobPlugin.styleBannerAd({isOverlapping: true, overlappingHeight: 5, padding: 0, margins: 0 });  // ( only android)
+// ccordova.plugins.emiAdmobPlugin.styleBannerAd({isOverlapping: true, overlappingHeight: 0, padding: 0, margins: 0 });  // ( only android)
 //cordova.plugins.emiAdmobPlugin.loadBannerAd({config});
 //cordova.plugins.emiAdmobPlugin.showBannerAd(); // default
 //cordova.plugins.emiAdmobPlugin.hideBannerAd(); // default
@@ -14,9 +14,9 @@ function loadBanner() {
 
         cordova.plugins.emiAdmobPlugin.styleBannerAd({
             isOverlapping: true, 
-            overlappingHeight: 5, 
-            padding: 0, 
-            margins: 0 
+            overlappingHeight: 0, // default 0 (Automatic)
+            padding: 0, // default 0
+            margins: 0 // default 0 (Automatic)
         });
         
     }
@@ -24,7 +24,7 @@ function loadBanner() {
 
         cordova.plugins.emiAdmobPlugin.loadBannerAd({
             adUnitId: Banner_ID, //Banner_ID,
-            position: "bottom-center",
+            position: "bottom-center", // "Recommended: bottom-center"
             size: "banner", // autoResize: true (only responsive_adaptive)
             collapsible: "bottom", // position: top | bottom (disable, empty string)
             autoResize: true, // default false
@@ -114,9 +114,33 @@ on.banner.hide
 
 // EVENT For example
 
+
+// (Optional)
+// This is only triggered when cordova.plugins.emiAdmobPlugin.styleBannerAd
+document.addEventListener('on.style.banner.ad', (data) => {
+    console.log("on.style.banner.ad: " + JSON.stringify(data));
+/*
+    const navBarHeight = data.navBarHeight;
+    const screenHeight = data.screenHeight;
+    const usableHeight = data.usableHeight;
+    const isOverlapping = data.isOverlapping;
+    const overlappingHeight = data.overlappingHeight;
+    const paddingInPx = data.paddingInPx;
+    const marginsInPx = data.marginsInPx;
+*/
+
+   // You can load banner ads here, or manipulate variables, even rearrange cordova.plugins.emiAdmobPlugin.styleBannerAd to your liking.
+
+
+});
+
+
+
+
+
 document.addEventListener('on.banner.load', (arg) => {
     let bannerAdHeight=arg.height;
-    console.log("on banner load");
+    console.log("on banner load", bannerAdHeight);
 });
 
 

package/example/www/js/deviceready.js

@@ -83,7 +83,7 @@ document.addEventListener("deviceready", function () {
     } 
 
 
-   // deactivate Google's consent
+   // (Optional) deactivate Google's consent
     /*
      cordova.plugins.emiAdmobPlugin.metaData({
 

package/example/www/js/optionalFirebaseAnalytics.js

@@ -0,0 +1,174 @@
+
+// NOTE
+// This is not a dependency, it's a separate plugin but highly recommended.
+// https://github.com/EMI-INDO/emi-indo-cordova-plugin-fanalytics
+
+// Just one example, for example Interstitial ads, the others just adjust it
+
+// https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/www/js/interstitialAd.js
+
+let isInterstitialLoadAd = false;
+
+function loadInterstitialAd() {
+
+    if (typeof cordova !== 'undefined') {
+
+        cordova.plugins.emiAdmobPlugin.loadInterstitialAd({ adUnitId: Interstitial_ID, autoShow: false });
+
+    }
+}
+
+
+
+function showInterstitialAd() {
+
+    if (typeof cordova !== 'undefined') {
+        
+        if (isInterstitialLoadAd) {
+            cordova.plugins.emiAdmobPlugin.showInterstitialAd();
+        }
+    }
+
+}
+
+/*
+
+on.interstitial.loaded
+on.interstitial.failed.load
+on.interstitial.click
+on.interstitial.dismissed
+on.interstitial.failed.show
+on.interstitial.impression
+on.interstitial.show
+
+// New event plugin v1.5.5 or higher
+
+on.interstitial.revenue
+on.interstitialAd.responseInfo
+
+*/
+
+
+
+
+let interstitialErrMsg = "";
+
+const adEventData = {
+// NOTE:   no spaces, underline is recommended _ 
+on_interstitial_loaded: "on_interstitial_loaded",
+on_interstitial_failed_load: interstitialErrMsg,
+on_interstitial_click: "on_interstitial_click",
+on_interstitial_dismissed: "on_interstitial_dismissed",
+on_interstitial_failed_show: "on_interstitial_failed_show",
+on_interstitial_impression: "on_interstitial_impression",
+on_interstitial_show: "on_interstitial_show",
+on_interstitial_revenue: "on_interstitial_revenue"
+
+}
+
+
+// EVENT For example
+
+document.addEventListener('on.interstitial.loaded', () => {
+    isInterstitialLoadAd = true;
+    console.log("on interstitial Ad loaded");
+
+    if (typeof cordova !== 'undefined') {
+
+        cordova.plugins.EmiFirebaseAnalyticsPlugin.logEvent({ name: "on_interstitial_loaded", params: adEventData.on_interstitial_loaded });
+
+    }
+  
+});
+
+
+// all events that contain the keyword dismissed there is a block to load the ad after it is closed by the user.
+document.addEventListener('on.interstitial.dismissed', () => {
+    isInterstitialLoadAd = false;
+    console.log("on interstitial Ad dismissed");
+    console.log("you can load ads automatically after the ads are closed by users");
+    
+    loadInterstitialAd();
+    
+    if (typeof cordova !== 'undefined') {
+
+        cordova.plugins.EmiFirebaseAnalyticsPlugin.logEvent({ name: "on_interstitial_dismissed", params: adEventData.on_interstitial_dismissed });
+
+    }
+
+});
+
+
+document.addEventListener('on.interstitial.failed.load', (error) => {
+    isInterstitialLoadAd = false;
+    console.log("on.interstitial.failed.load" + JSON.stringify(error));
+
+    /*
+    error.code
+    error.message
+    error.domain
+    error.responseInfoId
+    error.responseInfoExtras
+    error.responseInfoAdapter
+    error.responseInfoMediationAdapterClassName
+    error.responseInfoAdapterResponses
+    */
+
+    interstitialErrMsg = error.message;
+    
+if (typeof cordova !== 'undefined') {
+
+    cordova.plugins.EmiFirebaseAnalyticsPlugin.logEvent({ name: "on_interstitial_failed_load", params: adEventData.on_interstitial_failed_load });
+
+}
+
+
+});
+
+
+document.addEventListener('on.interstitial.failed.show', (error) => {
+    isInterstitialLoadAd = false;
+    console.log("on.interstitial.failed.show" + JSON.stringify(error));
+    
+   
+    if (typeof cordova !== 'undefined') {
+
+        cordova.plugins.EmiFirebaseAnalyticsPlugin.logEvent({ name: "on_interstitial_failed_show", params: adEventData.on_interstitial_failed_show });
+    
+    }
+
+
+});
+
+
+
+
+
+/*
+https://support.google.com/admob/answer/11322405
+
+Turn on the setting for impression-level ad revenue in your AdMob account:
+Sign in to your AdMob account at https://apps.admob.com.
+Click Settings in the sidebar.
+Click the Account tab.
+In the Account controls section, click the Impression-level ad revenue toggle to turn on this setting.
+*/
+
+document.addEventListener('on.interstitial.revenue', (data) => {
+
+    let adRevenuePaid = { 
+        value: data.value,
+        currencyCode: data.currencyCode,
+        precision: data.precision,
+        adUnitId: data.adUnitId
+    }
+
+    if (typeof cordova !== 'undefined') {
+  
+        cordova.plugins.EmiFirebaseAnalyticsPlugin.setAdMobRevenuePaid({ data: adRevenuePaid });
+
+        cordova.plugins.EmiFirebaseAnalyticsPlugin.logEvent({ name: "on_interstitial_revenue", params: adEventData.on_interstitial_revenue });
+  
+    }
+
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "emi-indo-cordova-plugin-admob",
-  "version": "1.6.9",
-  "description": "Cordova Plugin Admob Android IOS Support Capacitor",
+  "version": "1.8.9",
+  "description": "Cordova/Quasar/Capacitor Plugin Admob Android IOS",
   "cordova": {
     "id": "emi-indo-cordova-plugin-admob",
     "platforms": [
@@ -27,7 +27,9 @@
     "capacitor-ios",
     "adsense",
     "webview",
-    "admanager"
+    "admanager",
+    "quasar-framework",
+    "quasar"
   ],
   "author": "EMI INDO",
   "email": "cordova.c3addon@gmail.com",

package/plugin.xml

@@ -1,9 +1,9 @@
 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
   xmlns:android="http://schemas.android.com/apk/res/android"
-  id="emi-indo-cordova-plugin-admob" version="1.6.9">
+  id="emi-indo-cordova-plugin-admob" version="1.8.9">
 
   <name>emiAdmobPlugin</name>
-  <description>Cordova Plugin Admob Android IOS</description>
+  <description>Cordova/Quasar/Capacitor Plugin Admob Android IOS</description>
   <author>EMI INDO</author>
   <license>ISC</license>
 
@@ -93,7 +93,7 @@
 
     <config-file parent="/*" target="config.xml">
     <!--minimum deployment-target: 12.2  -->
-		<preference name="deployment-target" value="12.2" />
+		<preference name="deployment-target" value="12.3" />
 		<preference name="SwiftVersion" value="5.10" />
 	</config-file>
 
@@ -300,7 +300,7 @@
       <pods use-frameworks="true">
 		<!--minimum macOS 14.4 > Xcode 15.3 -->
 		 <pod name="GoogleUserMessagingPlatform" spec="~> 2.7.0" />
-     <pod name="Google-Mobile-Ads-SDK" spec="~> 11.12.0" />
+     <pod name="Google-Mobile-Ads-SDK" spec="~> 11.13.0" />
 		
       </pods>
     </podspec>

package/src/android/emiAdmobPlugin.kt

@@ -5,6 +5,7 @@ import android.content.Context
 import android.content.Intent
 import android.content.SharedPreferences
 import android.content.res.Configuration
+import android.graphics.Point
 import android.os.Build
 import android.os.Bundle
 import android.provider.Settings
@@ -1197,18 +1198,59 @@ class emiAdmobPlugin : CordovaPlugin() {
             val options = args.getJSONObject(0)
             if (mActivity != null) {
                 mActivity!!.runOnUiThread {
-                    val isOverlapping = options.optBoolean("isOverlapping")
-                    val overlappingHeight = options.optInt("overlappingHeight")
-                    val paddingPx = options.optInt("padding")
-                    val marginsPx = options.optInt("margins")
+                    val screenHeight: Int
+                    val usableHeight: Int
+
+                    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
+                        val windowMetrics = cordova.activity.windowManager.currentWindowMetrics
+                        val insets = windowMetrics.windowInsets.getInsetsIgnoringVisibility(WindowInsets.Type.navigationBars())
+                        screenHeight = windowMetrics.bounds.height()
+                        usableHeight = screenHeight - insets.bottom
+                    } else {
+                        val display = cordova.activity.windowManager.defaultDisplay
+                        val size = Point()
+                        val realSize = Point()
+                        display.getSize(size)
+                        display.getRealSize(realSize)
+
+                        usableHeight = size.y
+                        screenHeight = realSize.y
+                    }
+
+                    val navBarHeight = maxOf(0, screenHeight - usableHeight)
+
+                    val isOverlapping = options.optBoolean("isOverlapping", false)
+                    val overlappingHeight = options.optInt("overlappingHeight", navBarHeight)
+                    val paddingPx = options.optInt("padding", 0)
+                    val marginsPx = options.optInt("margins", navBarHeight)
+
+                    val result = JSONObject()
                     try {
+                        // Make sure to only set variables if they have the correct values
                         this.isOverlapping = isOverlapping
-                        this.overlappingHeight = overlappingHeight
+                        this.overlappingHeight = if (overlappingHeight > 0) overlappingHeight else navBarHeight
                         this.paddingInPx = paddingPx
-                        this.marginsInPx = marginsPx
+                        this.marginsInPx = if (marginsPx > 0) marginsPx else navBarHeight
+
+                        // Add more useful data to the result
+                        result.put("navBarHeight", navBarHeight)
+                        result.put("screenHeight", screenHeight)
+                        result.put("usableHeight", usableHeight)
+                        result.put("isOverlapping", isOverlapping)
+                        result.put("overlappingHeight", this.overlappingHeight)
+                        result.put("paddingInPx", paddingPx)
+                        result.put("marginsInPx", this.marginsInPx)
+
+                        cWebView?.let {
+                            it.loadUrl("javascript:cordova.fireDocumentEvent('on.style.banner.ad', ${result});")
+                        } ?: run {
+                            callbackContext.error("Error: cWebView is null.")
+                        }
+
                     } catch (e: Exception) {
-                        callbackContext.error(e.toString())
+                        callbackContext.error("Error in styleBannerAd: ${e.message}")
                     }
+
                 }
             }
             return true
@@ -1609,7 +1651,7 @@ class emiAdmobPlugin : CordovaPlugin() {
         if (bannerView != null && mActivity != null && cWebView != null) {
             mActivity!!.runOnUiThread {
                 try {
-                   // val bannerHeightInPx = bannerView!!.height
+                    // val bannerHeightInPx = bannerView!!.height
                     val displayMetrics = DisplayMetrics()
                     mActivity!!.windowManager.defaultDisplay.getMetrics(displayMetrics)
                     val screenHeightInPx = displayMetrics.heightPixels
@@ -2006,7 +2048,7 @@ class emiAdmobPlugin : CordovaPlugin() {
                     }
                     return sb.toString().uppercase(Locale.getDefault())
                 } catch (ex: NoSuchAlgorithmException) {
-                     ex.printStackTrace();
+                    ex.printStackTrace();
                     return null
                 }
             }