Skip to content
This repository has been archived by the owner on May 19, 2021. It is now read-only.

Latest commit

 

History

History
155 lines (93 loc) · 12.2 KB

README.md

File metadata and controls

155 lines (93 loc) · 12.2 KB
Raw

Cordova AdMob Plugin

A free, no ad-sharing version of Google AdMob plugin for Cordova.

Status

All cordova-plugin-admob-free should switch to use admob-plus-cordova for latest improvements.

I have been asking the interest about funding this project a while, got some encouraging feedback, finally have setup a funding page.

Please use admob-plus if possible.

While my focus is admob-plus, I will keep maintaining cordova-plugin-admob-free until all exisiting features are available with the new plugin.

If you are earning more than USD$200 monthly from using this plugin, please consider funding my work.

Features

  • No Ad-Sharing

    Unlike some other plugins, this plugin does not share your advertising revenue by randomly display developer's owned ads.

  • Fully Open Sourced

    Except Google provided AdMob SDKs, every line of code are on Github. You don't execute compiled binary without seeing the source code.

  • No Remote Control

    Do not send your application information to a remote server to control whether ad could be displayed. Therefore, you don't lose revenue because some server bugs,

    NOTE(2018-03-17): The above issue links are broken due to the author removed the discussions, the fact is the cordova-plugin-admobpro is sending requests to http://adlic.rjfun.com/adlic with application information for controling ad display, and some users reported losting more revenue than advertised, so use it at your own risk.

Compare to other projects

Project No Ad-Sharing Fully Open Sourced No Remote Control
admob Not Sure ❌ ❌ Not Sure
cordova-admob ❌ ✅ ✅
cordova-plugin-ad-admob ❌ ✅ ✅
cordova-plugin-admob-free ✅ ✅ ✅
cordova-plugin-admob-simple ❌ ✅ ❌
cordova-plugin-admobpro ❌ ❌ ❌ ❌ ❌

Click ❌ to see the detail.

NOTE(2018-03-17): cordova-plugin-admobpro is using cordova-plugin-extension for its compiled code, the author removed the repository casusing the above broken links. For those interested could download the npm tarball for investigation.

Installation

cordova plugin add cordova-plugin-admob-free --save

Since the version 17 of play-services-ads and the 0.21.0 version of the plugin the ADMOB_APP_ID must be added to the AndroidManifest.xml. To install the plugin without errors and to insert the ADMOB_APP_ID to the manifest file automatically use the following code:

cordova plugin add cordova-plugin-admob-free --save --variable ADMOB_APP_ID="<YOUR_ANDROID_ADMOB_APP_ID_AS_FOUND_IN_ADMOB>"

Since version 7.42 of the Google AdMob Mobile Ads SDK for iOS, you must add the ADMOB_APP_ID to your Info.plist, which you can do by adding the folowing inside the <platform name="ios"> section in your config.xml file:

<config-file target="*-Info.plist" parent="GADApplicationIdentifier">
    <string>YOUR_IOS_ADMOB_APP_ID_AS_FOUND_IN_ADMOB</string>
</config-file>

Note that cordova plugin add [GIT_URL] is not supported.

Usage

1. Create Ad Unit ID for your banner and interstitial.

Go to the AdMob portal and add your app (if you haven't done so already), once your app is added to your AdMob account, create a new ad unit for it.

2. Display advertisements

Banner Ad

Interstitial Ad

Reward Video Ad

3. Profit

If you find this plugin useful, please star it on Github.

Screenshots

Android Banner Android Interstitial
ScreenShot ScreenShot
iOS Banner iOS Interstitial
ScreenShot ScreenShot

API

See documentation page.

Customize Google Play Services versions (Android only)

The default PLAY_SERVICES_VERSION is set to 11.0.4. If you need a different version, edit config.xml with following,

<plugin name="cordova-admob-sdk" spec="~0.13.1">
    <variable name="PLAY_SERVICES_VERSION" value="11.6.0" />
</plugin>

Note that if you are adding these lines to an existing project, you need to remove both admob-free plugin and android platform and add them back again to affect the version number.

Contributing

You can use this Cordova plugin for free. You can contribute to this project in many ways:

Help with documentation is always appreciated and can be done via pull requests.

Read Contributing Guide to learn how to contribute.

Ionic Support

While the Ionic community have provided an Ionic Native Plugin, plugin users need more examples and tutorials.

As I (@ratson) don't use Ionic myself, it would be great if some experienced Ionic developers could help answering questions or come up with more examples. HELP WANTED HERE.

Credits

Thanks for the cordova-plugin-admob-simple author for forking the original project cordova-plugin-admob to make it functional and open source it.

Screenshots are copied from cordova-admob-pro.

Disclaimer

This is NOT an official Google product. It is just a community-driven project, which use the Google AdMob SDKs.

License

MIT