kanishkkunal / cordova-plugin-admob

AdMob Plugin for Cordova/PhoneGap, support Android, iOS and Windows Phone. Monetize your Cordova apps/games.

cordova-plugin-admob

AdMob Cordova Plugin, provides a way to request AdMob ads natively from JavaScript.

Platform SDK supported

• iOS, using AdMob SDK for iOS, v6.12.0
• Android, using Google Play Service for Android, r19
• Windows Phone, using AdMob SDK for Windows Phone 8, v6.5.13

How to use?

To install this plugin, follow the Command-line Interface Guide.

cordova plugin add https://github.com/floatinghotpot/cordova-plugin-admob.git

Or,

cordova plugin add com.rjfun.cordova.plugin.admob

Note: ensure you have a proper AdMob account and create an Id for your app.

Quick example with cordova CLI

    cordova create <project_folder> com.<company_name>.<app_name> <AppName>
    cd <project_folder>
    cordova platform add android
    cordova platform add ios

    // cordova will handle dependency automatically
    cordova plugin add com.rjfun.cordova.plugin.admob

    // now remove the default www content, copy the demo html file to www
    rm -r www/*;
    cp plugins/com.rjfun.cordova.plugin.admob/test/index.html www/

    cordova prepare; cordova run android; cordova run ios;
    // or import into Xcode / eclipse

Javascript API

APIs:

setOptions(options, success, fail);

createBannerView(options, success, fail);
requestAd(options, success, fail);  // optional, will be absolete
showAd(true/false, success, fail); 
destroyBannerView();

createInterstitialView(options, success, fail);
requestInterstitialAd(options, success, fail); // optional, will be absolete
showInterstitialAd();

Example code

Call the following code inside onDeviceReady(), because only after device ready you will have the plugin working.

     function onDeviceReady() {
        initAd();

        // display a banner at startup
        window.plugins.AdMob.createBannerView();
        
        // prepare the interstitial
        window.plugins.AdMob.createInterstitialView();
        
        // somewhere else, show the interstital, not needed if set autoShow = true
        window.plugins.AdMob.showInterstitialAd();
    }
    function initAd(){
        if ( window.plugins && window.plugins.AdMob ) {
    	    var ad_units = {
				ios : {
					banner: 'ca-app-pub-xxx/4806197152',
					interstitial: 'ca-app-pub-xxx/7563979554'
				},
				android : {
					banner: 'ca-app-pub-xxx/9375997553',
					interstitial: 'ca-app-pub-xxx/1657046752'
				},
				wp8 : {
					banner: 'ca-app-pub-xxx/9375997559',
					interstitial: 'ca-app-pub-xxx/1657046759'
				}
    	    };
    	    var admobid = "";
    	    if( /(android)/i.test(navigator.userAgent) ) {
    	    	admobid = ad_units.android;
    	    } else if(/(iphone|ipad)/i.test(navigator.userAgent)) {
    	    	admobid = ad_units.ios;
    	    } else {
    	    	admobid = ad_units.wp8;
    	    }
            
            window.plugins.AdMob.setOptions( {
                publisherId: admobid.banner,
                interstitialAdId: admobid.interstitial,
                bannerAtTop: false, // set to true, to put banner at top
                overlap: false, // set to true, to allow banner overlap webview
                offsetTopBar: false, // set to true to avoid ios7 status bar overlap
                isTesting: false, // receiving test ad
                autoShow: true // auto show interstitial ad when loaded
            });

            registerAdEvents();
            
        } else {
            alert( 'admob plugin not ready' );
        }
    }
	// optional, in case respond to events
    function registerAdEvents() {
    	document.addEventListener('onReceiveAd', function(){});
        document.addEventListener('onFailedToReceiveAd', function(data){});
        document.addEventListener('onPresentAd', function(){});
        document.addEventListener('onDismissAd', function(){ });
        document.addEventListener('onLeaveToAd', function(){ });
        document.addEventListener('onReceiveInterstitialAd', function(){ });
        document.addEventListener('onPresentInterstitialAd', function(){ });
        document.addEventListener('onDismissInterstitialAd', function(){ });
    }

See the working example code in demo under test folder, and here are some screenshots.

Screenshots (banner Ad / interstitial Ad)

iPhone:

Credits

This plugin is mainly maintained by Raymond Xie, and also thanks to following contributors:

• @jumin-zhu, added interstitial support for Android.
• @fersingb, added interstitial support for iOS.
• @AlexB71, improved WP8 support.
• @ihshim523, added initial WP8 support.
• And, bugfix patches from @chrisschaub, @jmelvin, @mbektchiev, @grahamkennery, @bastaware, @EddyVerbruggen, @codebykevin, @codebykevin, @zahhak.

You can use this plugin for FREE. To support the project, donation is welcome.

• Donate via PayPal to [email protected]
• Keep the 2% Ad traffic sharing code.

Forking and improving is welcome. Please ADD VALUE, instead of changing the name only.

See Also

Enhanced Cordova/PhoneGap plugins for the world leading Mobile Ad services:

• AdMob Plugin Pro, enhanced Google AdMob plugin, easy API, with mediation to multiple Ad networks.
• mMedia Plugin Pro, for Millennial Media Ad service, support impressive video Ad.
• iAd Plugin, Apple iAd service.
• FacebookAds Plugin, for Facebook Audience Network Ads service.
• FlurryAds Plugin, for Yahoo Flurry Ads service.
• MoPub Plugin Pro, for MobPub Ads service.
• MobFox Plugin Pro, for MobFox Ads service, support video Ad and many other Ad network with server-side integration.

AdMob Plugin Pro is highly recommended.

N-in-1 Advert Plugin for Cordova/PhoneGap. Maximize revenue with mediation to AdMob, DoubleClick, iAd, Flurry, Millennial Media, InMobi, Mobfox, and much more.

Highlights:

• Easy-to-use: Can display Ad with single line of Js code.
• Powerful: Support banner, interstitial, and video Ad.
• Max revenue: Support mediation with up to 8 leading mobile Ad services.
• Multi-size: Multiple banner size, also support custom size.
• Flexible: Fixed and overlapped mode, put banner at any position with overlap mode.
• Smart: Auto fit on orientation change.
• Up to date: Latest SDK and Android Google play services.
• Good support: Actively maintained, prompt response.

Tested with:

• Cordova CLI, v3.0+ (do not use the buggy v3.4)
• Intel XDK, r1095+
• IBM Worklight, v6.2+

Mediation with:

• AdMob
• DFP (DoubleClick for Publisher)
• Facebook Audience Network
• Flurry
• iAd
• InMobi
• Millennial Media
• MobFox

News:

• Recommended by Telerik in Verified Plugins Marketplace. read more ...
• Recommended by William SerGio in code project (20 Jun 2014), read more ...
• Recommended by Arne in Scirra Game Dev Forum (07 Aug, 2014), read more ...
• Recommended by Intel XDK team (08/22/2014), read more ...

More plugins by Raymond Xie, click here.

Project outsourcing and consulting service is also available. Please contact us if you have the business needs.