cordova-admob-jimmy

A Cordova AdMob plugin used for Android and iOS. It is free, with no ad sharing or remote code. It gets updated as needed to support the apps I develop and maintain. There may be other plugins with more features, but I can depend on this code to fullful my needs and not crash my code.

Quick start

To install this plugin, follow the Command-line Interface Guide. You can use one of the following command lines:

cordova plugin add cordova-admob-jimmy --variable ADMOB_APP_ID="<YOUR_ANDROID_ADMOB_APP_ID_AS_FOUND_IN_ADMOB>" --variable IOS_APP_ID="<YOUR_IOS_ADMOB_APP_ID>"

• Note: If you add the correct ADMOB_APP_ID after the build you may need to remove the plugin and re-add it as the original value is saved in the plugin folder and overrides the config settings.

Change Log

4.8.0

• App Open Ad format

4.7.0

• Update podspec to new format

4.6.1

• Update sdks and dependecies

4.5.0

• Update sdks and dependecies

• Android: https://developers.google.com/admob/android/quick-start

• ios: uses CocoaPods and removed packaged sdk

4.4.0

• Added required android AndroidManifest.xml meta-data tag.use the variable in the config add your abmob's appid. <meta-data android:name="com.google.android.gms.ads.APPLICATION_ID" android:value="[ADMOB_APP_ID]"/>. See: https://developers.google.com/admob/android/quick-start
• MobileAds.initialize(appid) is executed internally as required by the current admob sdk

Cordova AdMob plugin

Monetize your Cordova/Phonegap/XDK apps with AdMob ads, using latest Google AdMob SDK. With this Cordova/Phonegap/XDK plugin you can show AdMob ads as easy as:

admob.createBannerView({bannerAdId: "ca-app-pub-XXXXXXXXXXXXXXXX/BBBBBBBBBB"});

Or

admob.requestInterstitialAd({interstitialAdId: "ca-app-pub-XXXXXXXXXXXXXXXX/IIIIIIIIII"});

---

Platform SDK supported

• iOS, using AdMob SDK for iOS, v7.46.0
• Android, using Google Play Service for Android, v7.5

---

Quick start

To install this plugin, follow the Command-line Interface Guide. You can use one of the following command lines:

• cordova plugin add https://github.com/jamesfdickinson/admob-google-cordova-clean.git --variable ADMOB_APP_ID="123456789"

To start showing ads, place the following code in your onDeviceReady callback. Replace corresponding id's with yours:

Note: ensure you have a proper AdMob aaccount and get your admob's appid id's.

    
    function onDeviceReady() {
      document.removeEventListener('deviceready', onDeviceReady, false);
      
      // Set AdMobAds options:
      admob.setOptions({
        appId:                "ca-app-pub-XXXXXXXXXXXXXXXX~AAAAAAAAAA",  // Required, refer to AdMob's App ID
        bannerAdId:           "ca-app-pub-XXXXXXXXXXXXXXXX/BBBBBBBBBB",  // Optional
        interstitialAdId:     "ca-app-pub-XXXXXXXXXXXXXXXX/IIIIIIIIII",  // Optional
        tappxIdiOS:           "/XXXXXXXXX/Pub-XXXX-iOS-IIII",            // Optional
        tappxIdAndroid:       "/XXXXXXXXX/Pub-XXXX-Android-AAAA",        // Optional
        tappxShare:           0.5                                        // Optional
      });
      
      // Start showing banners (atomatic when autoShowBanner is set to true)
      admob.createBannerView();
      
      // Request interstitial (will present automatically when autoShowInterstitial is set to true)
      admob.requestInterstitialAd();
    }
    
    document.addEventListener("deviceready", onDeviceReady, false);

If you don't specify tappxId, no tappx requests will be placed (even if you specify a tappxShare). See Tappx configuration for more detailed info.

⚠️ Be sure to only fire on "deviceready" otherwise, the plugin would not work.

---

Full documentation

Visit the wiki of Google AdMob Cordova plugin. Table of contents:

• Home
• Table of contents
• Change Log
• Testimonials
• Setup
• Angular.js, Ionic apps
• Tappx configuration
• Javascript API
  • setOptions
  • Banners
    • createBannerView
    • showBannerAd
    • destroyBannerView
  • Interstitials
    • requestInterstitialAd
    • showInterstitialAd
  • In app purchase
    • recordResolution
    • recordPlayBillingResolution
  • Events
    • onAdLoaded
    • onAdFailedToLoad
    • onAdOpened
    • onAdClosed
    • onAdLeftApplication
    • onInAppPurchaseRequested
• Complete example code
• Contributing
• Screenshots

---

Complete example code

Note that the admob ads are configured inside onDeviceReady(). This is because only after device ready the AdMob Cordova plugin will be working.

 
    var isAppForeground = true;
    
    function initAds() {
      if (admob) {
        var adPublisherIds = {
          ios : {
            app : "ca-app-pub-XXXXXXXXXXXXXXXX~AAAAAAAAAA",
            banner : "ca-app-pub-XXXXXXXXXXXXXXXX/BBBBBBBBBB",
            interstitial : "ca-app-pub-XXXXXXXXXXXXXXXX/IIIIIIIIII"
          },
          android : {
            app : "ca-app-pub-XXXXXXXXXXXXXXXX~AAAAAAAAAA",
            banner : "ca-app-pub-XXXXXXXXXXXXXXXX/BBBBBBBBBB",
            interstitial : "ca-app-pub-XXXXXXXXXXXXXXXX/IIIIIIIIII"
          }
        };
        
        var admobid = (/(android)/i.test(navigator.userAgent)) ? adPublisherIds.android : adPublisherIds.ios;
            
        admob.setOptions({
          appId:            admobid.app,
          bannerAdId:       admobid.banner,
          interstitialAdId: admobid.interstitial,
          tappxIdiOS:       "/XXXXXXXXX/Pub-XXXX-iOS-IIII",
          tappxIdAndroid:   "/XXXXXXXXX/Pub-XXXX-Android-AAAA",
          tappxShare:       0.5,
          
        });
 
        registerAdEvents();
        
      } else {
        alert('AdMobAds plugin not ready');
      }
    }
    
    function onAdLoaded(e) {
      if (isAppForeground) {
        if (e.adType === admob.AD_TYPE.INTERSTITIAL) {
          console.log("An interstitial has been loaded and autoshown. If you want to load the interstitial first and show it later, set 'autoShowInterstitial: false' in admob.setOptions() and call 'admob.showInterstitialAd();' here");
        } else if (e.adType === admob.AD_TYPE_BANNER) {
          console.log("New banner received");
        }
      }
    }
    
    function onPause() {
      if (isAppForeground) {
        admob.destroyBannerView();
        isAppForeground = false;
      }
    }
    
    function onResume() {
      if (!isAppForeground) {
        setTimeout(admob.createBannerView, 1);
        setTimeout(admob.requestInterstitialAd, 1);
        isAppForeground = true;
      }
    }
    
    // optional, in case respond to events
    function registerAdEvents() {
      document.addEventListener(admob.events.onAdLoaded, onAdLoaded);
      document.addEventListener(admob.events.onAdFailedToLoad, function (e) {});
      document.addEventListener(admob.events.onAdOpened, function (e) {});
      document.addEventListener(admob.events.onAdClosed, function (e) {});
      document.addEventListener(admob.events.onAdLeftApplication, function (e) {});
      document.addEventListener(admob.events.onInAppPurchaseRequested, function (e) {});
      
      document.addEventListener("pause", onPause, false);
      document.addEventListener("resume", onResume, false);
    }
        
    function onDeviceReady() {
      document.removeEventListener('deviceready', onDeviceReady, false);
      initAds();
 
      // display a banner at startup
      admob.createBannerView();
        
      // request an interstitial
      admob.requestInterstitialAd();
    }
    
    document.addEventListener("deviceready", onDeviceReady, false);

---

Screenshots

iPhone:

iPad Banner Portrait:

iPad Banner Landscape:

---

License

The MIT License

Copyright (c) 2014 AppFeel

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---

Credits

• appFeel