Cordova/PhoneGap Plugin for iAd with Banner and Interstitial
Objective-C HTML JavaScript
Latest commit b3f8d48 Apr 27, 2015 @floatinghotpot Merge pull request #5 from leecrossley/patch-1
Remove notice now iPhone interstitial support

README.md

iAd Plugin Pro

Present Apple iAd in Mobile App/Games natively from JavaScript.

Highlights:

  • Easy-to-use APIs. Display Ad with single line of Js code.
  • Support Banner, Interstitial Ad.
  • Multiple banner size, also support custom size.
  • Fixed and overlapped mode.
  • Auto fit on orientation change.
  • Same API with other RjFun Ad plugins, easily switch to other Ad networks.

Compatible with:

  • Cordova CLI, v3.5+
  • Intel XDK and Crosswalk, r1095+
  • IBM Worklight, v6.2+

How to use?

If use with Cordova CLI:

cordova plugin add com.rjfun.cordova.iad

If use with Intel XDK: Project -> CORDOVA 3.X HYBRID MOBILE APP SETTINGS -> PLUGINS AND PERMISSIONS -> Third-Party Plugins -> Add a Third-Party Plugin -> Get Plugin from the Web, input:

Name: iAdPluginPro
Plugin ID: com.rjfun.cordova.iad
[x] Plugin is located in the Apache Cordova Plugins Registry

Quick Start

Before using the plugin in your project, please verify the plugin by build the demo index.html coming with the plugin:

cordova create test1 com.rjfun.test1 test1;
cd test1;
cordova platform add ios;
cordova plugin add com.rjfun.cordova.iad;
rm -r www/*;
cp -r plugins/com.rjfun.cordova.iad/test/* www/;
cordova prepare;
cordova run ios;

Quick Start Example Code

Step 1: Create a banner with single line of javascript

// it will display smart banner at top center, using the default options
if(iAd) iAd.createBanner( { autoShow:true } );

Or, show the banner Ad in some other way:

// or, show a default banner at bottom
if(iAd) iAd.createBanner( {
    position:iAd.AD_POSITION.BOTTOM_CENTER, 
    autoShow:true
} );

Step 2: Prepare an interstitial, and show it when needed

// preppare and load ad resource in background, e.g. at begining of game level
if(iAd) iAd.prepareInterstitial( { autoShow:false } );

// show the interstitial later, e.g. at end of game level
if(iAd) iAd.showInterstitial();

Javascript API Overview

Methods:

// set default value for other methods
setOptions(options, success, fail);
// for banner
createBanner(options, success, fail);
removeBanner();
showBanner(position);
showBannerAtXY(x, y);
hideBanner();
// for interstitial
prepareInterstitial(options, success, fail);
showInterstitial();

Detailed Documentation

The APIs, Events and Options are detailed documented.

Read the detailed API Reference Documentation English.

FAQ

If encounter problem when using the plugin, please read the FAQ first.

Full Example Code

This MobFox Plugin Pro offers the most flexibility and many options.

Check the test/index.html.

Screenshots

iPhone Portrait iPhone Landscape
ScreenShot ScreenShot
iPad Banner iPad Interstitial
ScreenShot ScreenShot

Ad PluginPro series for the world leading Mobile Ad services:

More Cordova/PhoneGap plugins by Raymond Xie, find them in plugin registry.

If use in commercial project or need prompt support, please buy a license, you will be served with high priority.

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