emi-indo-cordova-plugin-admob 1.5.4 → 1.5.5

package/.vscode/settings.json

@@ -1,7 +1,3 @@
 {
-    "xml.downloadExternalResources.enabled": true,
-    "C_Cpp.clang_format_style": "file",
-    "C_Cpp.formatting": "ClangFormat",
-    "editor.formatOnSave": true
-
+    "xml.downloadExternalResources.enabled": true
 }

package/README.md

@@ -3,8 +3,8 @@
 # emi-indo-cordova-plugin-admob
  Cordova Plugin Admob Android and IOS
 
-### Mobile Ads SDK (Android: 23.4.0) [Release Notes:](https://developers.google.com/admob/android/rel-notes)
-### User Messaging Platform (UMP Android: 3.0.0) [Release Notes:](https://developers.google.com/admob/android/privacy/release-notes)
+### Mobile Ads SDK (Android: 23.5.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.10.0) [Release Notes:](https://developers.google.com/admob/ios/rel-notes)
 
@@ -12,6 +12,7 @@
 ### IAB Europe Transparency & Consent Framework (CPM: 2.2.0)
 
 
+## New example https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/tree/main/example/www
 
 
 ## Minimum Cordova Engines
@@ -21,7 +22,7 @@
 
 ## IOS Ad Support IOS 18 *
 > [!WARNING]
-> - emi-indo-cordova-plugin-admob@1.5.2 
+> - emi-indo-cordova-plugin-admob@1.5.2 or higher
 > - Minimum supported Xcode version up to 15.3 or higher
 > - minimum deployment-target: 12.2
 ## Minimum macOS | Xcode, and others
@@ -91,17 +92,7 @@ https://developers.google.com/admob/ios/quick-start
   
 ##  [Check all release notes:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/releases/)
 
-> [!WARNING]  
-> WARNING options configuration was previously an array [], now v.1.4.9 or later must be an object{}
-> example
-```
-previous example 
-[ adUnitId = App_Open_ID, autoShow = true ] // Deprecated
-now
-{ adUnitId: App_Open_ID, autoShow: true }
 
- cordova.plugins.emiAdmobPlugin.loadAppOpenAd({ adUnitId: App_Open_ID, autoShow: true }); 
- ```
 
 ## Features
 <details>
@@ -124,8 +115,19 @@ now
 
 ## Installation
 
+- Only platform Android
+```sh
+cordova plugin add emi-indo-cordova-plugin-admob --save --variable APP_ID_ANDROID=ca-app-pub-xxx~xxx
+```
+
+- Only platform IOS
 ```sh
-cordova plugin add emi-indo-cordova-plugin-admob  --save --variable APP_ID_ANDROID=ca-app-pub-xxx~xxx --variable APP_ID_IOS=ca-app-pub-xxx~xxx
+cordova plugin add emi-indo-cordova-plugin-admob --save --variable APP_ID_IOS=ca-app-pub-xxx~xxx
+```
+
+- Platform Both
+```sh
+cordova plugin add emi-indo-cordova-plugin-admob --save --variable APP_ID_ANDROID=ca-app-pub-xxx~xxx --variable APP_ID_IOS=ca-app-pub-xxx~xxx
 ```
 
 ## Remove
@@ -177,7 +179,7 @@ console.log("On Sdk Initialization version: " + sdkVersion);
  // Support Platform: Android | IOS
 cordova.plugins.emiAdmobPlugin.globalSettings({config_globalSettings}); // Optional
 cordova.plugins.emiAdmobPlugin.targeting({config_Targeting}); // Optional
-// UMP SDK 2.1.0
+// UMP SDK 3.1.0
 cordova.plugins.emiAdmobPlugin.getConsentRequest(); // (Platform: Both)  // Deprecated
 cordova.plugins.emiAdmobPlugin.consentReset(); // (Platform: Both) // Optional
 cordova.plugins.emiAdmobPlugin.showPrivacyOptionsForm(); // (Platform: Both) // Optional
@@ -207,13 +209,14 @@ document.addEventListener('on.sdkInitialization', (data) => {
 // JSON.stringify(data)
    const sdkVersion = data.version;
 // const adAdapter = data.adapters;
-// const conStatus = data.consentStatus;
+   const conStatus = data.consentStatus;
 // const gdprApplie = data.gdprApplies;
 // const purposeConsent = data.purposeConsents;
 // const vendorConsents = data.vendorConsents;
 // const conTCString = data.consentTCString;
 // const additionalConsent = data.additionalConsent;
 console.log("On Sdk Initialization version: " + data.consentStatus);
+console.log("On Consent Status: " + conStatus);
 
 });
 
@@ -295,6 +298,14 @@ var Interstitial_ID;
 var Rewarded_ID;
 var Rewarded_Interstitial_ID;
 
+/* https://support.google.com/admob/answer/9493252?hl=en
+Best practice when using ad original ID unit, 
+the app must be uploaded to the play store or app store, 
+and you must upload it from there, 
+otherwise you may be subject to ad serving restrictions, 
+if it happens often, it is possible that your admob account will be permanently disabled.
+*/
+
 if (window.cordova.platformId === 'ios') {
    
     App_Open_ID = 'ca-app-pub-3940256099942544/5575463023';
@@ -380,22 +391,6 @@ autoShow: false
  cordova.plugins.emiAdmobPlugin.loadAppOpenAd({config});
  cordova.plugins.emiAdmobPlugin.showAppOpenAd(); // default
 
-//  Advanced load (Optional)
-    cordova.plugins.emiAdmobPlugin.loadAppOpenAd(config,
-
-    (data) => {
-
-    console.log("Micros: " + data.micros);
-    console.log("Currency: " + data.currency);
-    console.log("Precision: " + data.precision);
-    console.log("AdUnitId: " + data.adUnitId};
-
-     },
-    (error) => {
-
-     console.error("Error: " + error);
-
-    });
 
  
  <br> 
@@ -403,14 +398,6 @@ autoShow: false
  <li>example:</li></ul>
 <pre> 
  
-WARNING options configuration was previously an array [], now v.1.4.9 or later must be an object{}
-example
-```
-previous example 
-[ adUnitId = App_Open_ID, autoShow = true ] // Deprecated
-now
-{ adUnitId: App_Open_ID, autoShow: true }
-
  cordova.plugins.emiAdmobPlugin.loadAppOpenAd({ adUnitId: App_Open_ID, autoShow: true }); 
  ```
 </pre>
@@ -425,6 +412,9 @@ now
  on.appOpenAd.failed.show
  on.appOpenAd.show
  on.appOpenAd.revenue
+
+ (DEBUG)
+ on.appOpenAd.responseInfo
  <br>
 </pre>
  <li>example:</li></ul>
@@ -438,7 +428,7 @@ document.addEventListener('on.appOpenAd.loaded', () => {
 </pre>
 </details>
 
-- [FULL AppOpenAd basic: Not yet updated](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/app_open_ads.html) -index.html
+- [FULL AppOpenAd basic:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/Example/www/js/appOpenAd.js) 
 
 
 
@@ -448,7 +438,7 @@ document.addEventListener('on.appOpenAd.loaded', () => {
 <details>
 <summary>Methods:</summary>
 <pre> 
-cordova.plugins.emiAdmobPlugin.styleBannerAd({ padding: 50, margins: 50 });  // (Optional)
+cordova.plugins.emiAdmobPlugin.styleBannerAd({ padding: 50, margins: 50 });  // (Optional only android)
 cordova.plugins.emiAdmobPlugin.loadBannerAd({config});
 cordova.plugins.emiAdmobPlugin.showBannerAd(); // default
 cordova.plugins.emiAdmobPlugin.hideBannerAd(); // default
@@ -456,22 +446,7 @@ cordova.plugins.emiAdmobPlugin.removeBannerAd(); // default
 </pre>
   <li>example:</li></ul>
 <pre> 
- WARNING options configuration was previously an array [], now v.1.4.9 or later must be an object{}
-
-// Deprecated
-/*
-const bannerConfig = [
-
-   adUnitId = Banner_ID,
-   position = "bottom-center",
-   size = "BANNER",
-   collapsible = "bottom", // (BETA) enable in globalSettings
-   adaptive_Width = 320, // Ignored
-   autoShow = true // boolean
-]
-*/
-
-// NEW
+ 
 ```
 const bannerConfig = {
 
@@ -484,23 +459,7 @@ const bannerConfig = {
 
 }
 
-cordova.plugins.emiAdmobPlugin.loadBannerAd(bannerConfig,
-//  Advanced load (Optional)
-(data) => {
-    // this data will be displayed after showBannerAd() applies to all ad types
-    console.log("Micros: " + data.micros);
-    console.log("Currency: " + data.currency);
-    console.log("Precision: " + data.precision);
-    console.log("AdUnitId: " + data.adUnitId};
-
-     },
-    (error) => {
-
-     console.error("Error: " + error);
-
-    }
-
-);
+cordova.plugins.emiAdmobPlugin.loadBannerAd(bannerConfig);
 ```
 
 
@@ -535,16 +494,7 @@ full_banner
 leaderboard
 fluid
  
-ANCHORED // Deprecated
-IN_LINE // Deprecated
-FULL_WIDTH // Deprecated
-BANNER // Deprecated
-FLUID // Deprecated
-LARGE_BANNER // Deprecated
-MEDIUM_RECTANGLE // Deprecated
-FULL_BANNER // Deprecated
-LEADERBOARD // Deprecated
-adaptive_Width = number // Deprecated
+
 </pre>
 </details>
 
@@ -563,6 +513,7 @@ on.banner.remove
 on.banner.hide
  // new
  on.is.collapsible
+ on.bannerAd.responseInfo
 </pre>
  <li>example:</li></ul>
 <pre> 
@@ -580,7 +531,7 @@ console.log("Collapsible Status: " + event.collapsible);
 </pre>
 </details>
 
- [FULL Banner basic: Not yet updated](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/banner_ads.html) index.html
+ [FULL Banner basic:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/Example/www/js/bannerAd.js) 
 
 
 ## Interstitial ADS
@@ -593,36 +544,12 @@ console.log("Collapsible Status: " + event.collapsible);
 cordova.plugins.emiAdmobPlugin.loadInterstitialAd({config});
 cordova.plugins.emiAdmobPlugin.showInterstitialAd(); // default
 
- //  Advanced load (Optional)
-    cordova.plugins.emiAdmobPlugin.loadInterstitialAd(config,
-
-    (data) => {
-
-    console.log("Micros: " + data.micros);
-    console.log("Currency: " + data.currency);
-    console.log("Precision: " + data.precision);
-    console.log("AdUnitId: " + data.adUnitId};
-
-     },
-    (error) => {
-
-     console.error("Error: " + error);
-
-    });
  <br> 
 </pre>
  <li>example:</li></ul>
 <pre> 
 
-WARNING options configuration was previously an array [], now v.1.4.9 or later must be an object{}
-example
-```
-/*
-previous example 
-[ adUnitId = Interstitial_ID, autoShow = true ] // Deprecated
 
-{ adUnitId: Interstitial_ID, autoShow: true } // NEW
-*/
  cordova.plugins.emiAdmobPlugin.loadInterstitialAd({ adUnitId: "ca-app-pub-3940256099942544/1033173712", autoShow: true });
  ```
 
@@ -641,6 +568,7 @@ on.interstitial.impression
 on.interstitial.show
  // new
  on.interstitial.revenue
+ on.interstitialAd.responseInfo
  <br>
 </pre>
  <li>example:</li></ul>
@@ -666,7 +594,7 @@ document.addEventListener('on.interstitial.dismissed', () => {
 </details>
 
 
-[FULL Interstitial basic: Not yet updated](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/interstitial_ads.html) index.html
+[FULL Interstitial basic: ](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/Example/www/js/interstitialAd.js) 
 
 
 
@@ -687,25 +615,6 @@ cordova.plugins.emiAdmobPlugin.showRewardedInterstitialAd(); // default
 <pre> 
 
  cordova.plugins.emiAdmobPlugin.loadRewardedInterstitialAd({ adUnitId: Rewarded_Interstitial_ID, autoShow: true });
-
-    //  Advanced load (Optional)
-    cordova.plugins.emiAdmobPlugin.loadRewardedInterstitialAd(config,
-
-    (data) => {
-
-    console.log("Micros: " + data.micros);
-    console.log("Currency: " + data.currency);
-    console.log("Precision: " + data.precision);
-    console.log("AdUnitId: " + data.adUnitId};
-
-     },
-    (error) => {
-
-     console.error("Error: " + error);
-
-    });
-
-
  
 </pre>
 </details>
@@ -724,6 +633,7 @@ on.rewardedInt.userEarnedReward
  // new
 on.rewardedInt.revenue
 on.rewardedInt.ad.skip
+on.rewardedIntAd.responseInfo
  <br>
 </pre>
  <li>example:</li></ul>
@@ -769,23 +679,6 @@ cordova.plugins.emiAdmobPlugin.showRewardedAd(); // default
 
  cordova.plugins.emiAdmobPlugin.loadRewardedAd({ adUnitId: Rewarded_ID, autoShow: true });
 
-//  Advanced load (Optional)
-    cordova.plugins.emiAdmobPlugin.loadRewardedAd(config,
-
-    (data) => {
-
-    console.log("Micros: " + data.micros);
-    console.log("Currency: " + data.currency);
-    console.log("Precision: " + data.precision);
-    console.log("AdUnitId: " + data.adUnitId};
-
-     },
-    (error) => {
-
-     console.error("Error: " + error);
-
-    });
-
  
 </pre>
 </details>
@@ -804,6 +697,7 @@ on.reward.userEarnedReward
  // new
 on.rewarded.revenue
 on.rewarded.ad.skip
+on.rewardedAd.responseInfo
 
  <br>
 </pre>
@@ -829,7 +723,7 @@ document.addEventListener('on.rewarded.dismissed', () => {
 </pre>
 </details>
 
-[FULL Rewarded basic: Not yet updated](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/rewarded_ads.html) index.html
+[FULL Rewarded basic: ](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/Example/www/js/rewardedAd.js) 
 
 
 

package/example/www/css/index.css

@@ -0,0 +1,110 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+* {
+    -webkit-tap-highlight-color: rgba(0,0,0,0); /* make transparent link selection, adjust last value opacity 0 to 1.0 */
+}
+
+body {
+    -webkit-touch-callout: none;                /* prevent callout to copy image, etc when tap to hold */
+    -webkit-text-size-adjust: none;             /* prevent webkit from resizing text to fit */
+    -webkit-user-select: none;                  /* prevent copy paste, to allow, change 'none' to 'text' */
+    background-color:#E4E4E4;
+    background-image:linear-gradient(to bottom, #A7A7A7 0%, #E4E4E4 51%);
+    font-family: system-ui, -apple-system, -apple-system-font, 'Segoe UI', 'Roboto', sans-serif;
+    font-size:12px;
+    height:100vh;
+    margin:0px;
+    padding:0px;
+    /* Padding to avoid the "unsafe" areas behind notches in the screen */
+    padding: env(safe-area-inset-top, 0px) env(safe-area-inset-right, 0px) env(safe-area-inset-bottom, 0px) env(safe-area-inset-left, 0px);
+    text-transform:uppercase;
+    width:100%;
+}
+
+/* Portrait layout (default) */
+.app {
+    background:url(../img/logo.png) no-repeat center top; /* 170px x 200px */
+    position:absolute;             /* position in the center of the screen */
+    left:50%;
+    top:50%;
+    height:50px;                   /* text area height */
+    width:225px;                   /* text area width */
+    text-align:center;
+    padding:180px 0px 0px 0px;     /* image height is 200px (bottom 20px are overlapped with text) */
+    margin:-115px 0px 0px -112px;  /* offset vertical: half of image height and text area height */
+                                   /* offset horizontal: half of text area width */
+}
+
+/* Landscape layout (with min-width) */
+@media screen and (min-aspect-ratio: 1/1) and (min-width:400px) {
+    .app {
+        background-position:left center;
+        padding:75px 0px 75px 170px;  /* padding-top + padding-bottom + text area = image height */
+        margin:-90px 0px 0px -198px;  /* offset vertical: half of image height */
+                                      /* offset horizontal: half of image width and text area width */
+    }
+}
+
+h1 {
+    font-size:24px;
+    font-weight:normal;
+    margin:0px;
+    overflow:visible;
+    padding:0px;
+    text-align:center;
+}
+
+.event {
+    border-radius:4px;
+    color:#FFFFFF;
+    font-size:12px;
+    margin:0px 30px;
+    padding:2px 0px;
+}
+
+.event.listening {
+    background-color:#333333;
+    display:block;
+}
+
+.event.received {
+    background-color:#4B946A;
+    display:none;
+}
+
+#deviceready.ready .event.listening { display: none; }
+#deviceready.ready .event.received { display: block; }
+
+@keyframes fade {
+    from { opacity: 1.0; }
+    50% { opacity: 0.4; }
+    to { opacity: 1.0; }
+}
+
+.blink {
+    animation:fade 3000ms infinite;
+    -webkit-animation:fade 3000ms infinite;
+}
+
+
+@media screen and (prefers-color-scheme: dark) {
+    body {
+        background-image:linear-gradient(to bottom, #585858 0%, #1B1B1B 51%);
+    }
+}

package/example/www/index.html

@@ -0,0 +1,27 @@
+<html>
+<head>
+    <script type="text/javascript" src="cordova.js"></script>
+    <script src="js/appOpenAd.js" defer></script>
+    <script src="js/bannerAd.js" defer></script>
+    <script src="js/interstitialAd.js" defer></script>
+    <script src="js/rewardedAd.js" defer></script>
+    <script src="js/deviceready.js" defer></script>
+</head>
+<body>
+
+<label for="event">Debug Event All response :</label>
+<textarea id="log" name="log" rows="5" cols="40"></textarea>
+
+<p> <button onclick="loadAppOpen();">Auto Show App Open Ad</button></p>
+
+
+<p> <button onclick="loadInterstitial();">Load Interstitial Ad</button></p>
+<p> <button onclick="showInterstitial();">Show Interstitial Ad</button></p>
+
+<p> <button onclick="loadRewarded();">Load Rewarded Ad</button></p>
+<p> <button onclick="showRewarded();">Show Rewarded Ad</button></p>
+
+<p> <button onclick="cleanText();">Clean response Text</button></p>
+
+</body>
+</html>

package/example/www/js/appOpenAd.js

@@ -0,0 +1,146 @@
+
+
+/*
+
+Best practices
+App open ads help you monetize your app's loading screen, when the app first launches and during app switches, 
+but it's important to keep best practices in mind so that your users enjoy using your app. It's best to:
+
+Show your first app open ad after your users have used your app a few times.
+Show app open ads during times when your users would otherwise be waiting for your app to load.
+If you have a loading screen under the app open ad, 
+and your loading screen completes loading before the ad is dismissed, 
+you may want to dismiss your loading screen in the on.appOpenAd.dismissed method.
+
+*/
+
+
+
+
+
+
+
+
+let isAppOpenAdLoad = false;
+
+function loadAppOpen() {
+
+    if (typeof cordova !== 'undefined') {
+        cordova.plugins.emiAdmobPlugin.loadAppOpenAd({ adUnitId: App_Open_ID, autoShow: true });
+    }
+
+}
+
+
+/*
+function showAppOpen() {
+
+    if (typeof cordova !== 'undefined') {
+        if (isAppOpenAdLoad) {
+            cordova.plugins.emiAdmobPlugin.showAppOpenAd();
+        }
+    }
+
+}
+
+*/
+
+
+/*
+on.appOpenAd.loaded
+ on.appOpenAd.failed.loaded
+ on.appOpenAd.dismissed
+ on.appOpenAd.failed.show
+ on.appOpenAd.show
+
+ // New event plugin v1.5.5 or higher
+
+on.appOpenAd.revenue
+on.appOpenAd.responseInfo
+
+
+*/
+
+
+
+document.addEventListener('on.appOpenAd.loaded', () => {
+    isAppOpenAdLoad = true;
+    console.log("on.appOpenAd.loaded");
+    window.log.value += ("\n on.appOpenAd.loaded");
+});
+
+
+document.addEventListener('on.appOpenAd.failed.loaded', (error) => {
+    isAppOpenAdLoad = false;
+    console.log("on.appOpenAd.failed.loaded" + JSON.stringify(error));
+
+    window.log.value += ("\n on.appOpenAd.failed.loaded" + JSON.stringify(error));
+});
+
+
+document.addEventListener('on.appOpenAd.failed.show', (error) => {
+    isAppOpenAdLoad = false;
+    console.log("on.appOpenAd.failed.show" + JSON.stringify(error));
+
+    window.log.value += ("\n on.appOpenAd.failed.show" + JSON.stringify(error));
+});
+
+
+
+// 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.appOpenAd.dismissed', () => {
+    // Stop loading the app, go straight to the main menu of the app.
+    isAppOpenAdLoad = false;
+    console.log("Stop loading the app, go straight to the main menu of the app.");
+    console.log("you can load ads automatically after the ads are closed by users");
+   
+
+    window.log.value += ("\n you can load ads automatically after the ads are closed by users");
+
+});
+
+
+
+
+
+
+
+
+
+
+
+/*
+// DEBUG
+// isResponseInfo: true, // debug Default false
+document.addEventListener('on.appOpenAd.responseInfo', (data) => {
+
+    console.log("on.appOpenAd.responseInfo" + JSON.stringify(data));
+    if (window.log) window.log.value += ("\n on.appOpenAd.responseInfo" + JSON.stringify(data));
+});
+
+*/
+
+
+
+
+
+/*
+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.appOpenAd.revenue', (data) => {
+
+    console.log(data.value)
+    console.log(data.currencyCode)
+    console.log(data.precision)
+    console.log(data.adUnitId)
+
+   // console.log("on.appOpenAd.revenue" + JSON.stringify(data));
+    if (window.log) window.log.value += ("\n on.appOpenAd.revenue" + JSON.stringify(data));
+});