Admob Native Extension for Adobe Air

This AdMob will add the support to use AdMob Mobile monetization platform with Adobe Air. The Extension support Android Platform and iOS Platform. Different Packages are available according to the needs'

• Android Only
• iOS Oly
• Both Platforms

This is the Only Native extension available for Adobe Air, which offer a complete coverage of every function and possibility offer by AdMob. Moreover the Extension has been compiled and maintained with the very latest AdMob SDK for either Android and iOS!

VERY IMPORTANT:

• Every Native Extension out there are make from old SDK, which, in the case of android, will not be accepted anymore in Google play from 1 Aug. 2014. While in iOS the old SDK will not pass the Application approval from Apple.

##What is AdMob?

AdMob is the world's largest mobile advertising platforms which serve more than 40 billion mobile banner and text ads per month across mobile Web sites and handset applications

http://www.google.com/ads/admob/

##Features:

• Allow Multiple Banners for Application This permit two have, one, two or more banner visible and manageable in the same application view. Or to have several banner pre-cached and show/hide on demand.

• Full Interstitial Ads Management and Pre-caching

• Full Request Customization

• Support Any adMob Size:

BANNER
MEDIUM_RECTANGLE
FULL_BANNER
LEADERBOARD
WIDE_SKYSCRAPER
SMART_BANNER
SMART_BANNER_PORT
SMART_BANNER_LAND

• Auto relative Docking for:

TOP_LEFT
TOP_CENTER
TOP_RIGHT
MIDDLE_LEFT
MIDDLE_CENTER
MIDDLE_RIGHT
BOTTOM_LEFT
BOTTOM_CENTER
BOTTOM_RIGHT

• Custom Absolute Position (off screen included)

• Extensive in line AsDoc Documentation

• Full Extension Documentation in /Documentation

##Admob SDK Details Android: Latest 4.3 Google Play services Library iOS: AdMob SDK 6.8

##Further Info: Android: The Extension is build using the latest Google Play service library which will guaranty the application approval also after 01 Aug. 2014

iOS: The Extension is build using the latest 6.8 AdMob SDK, in xCode 5.1.1 using iOS SDK 7.1.which will guaranty the apple store approval for the application by Apple.

##Device Compatibility: Android: From version 2.2 iOS: From version 4.3

##Install the library

Add the AdMob ANE library to your project.

In Flash Builder 4.7:

1. Go to Project Properties
2. Select Native Extensions under Actionscript Build Path
3. Choose Add ANE... and navigate to the AdMob.ane file
4. Select Actionscript Build Packaging > Google Android, Apple IOS or Both
5. Select the Native Extensions tab, and click the 'Package' check box next to the extension

Please note: When adding the ANE be sure to have the checkbox "Update Air Application Descriptor" selected. If it is not selected make certain that the application Id is available in the Air Application Descriptor as follow:

<extensions>
	<extensionID>com.codealchemy.ane.admobane</extensionID>
</extensions>

##Usage Import the library

import com.codealchemy.ane.admobane.AdMobManager;

Get The Manager Instance

var adMobManager:AdMobManager = AdMobManager.manager;

Check Extension Support

if(adMobManager.isSupported){
    ...
}

Set Manager Verbose Mode [Optional] The Verbose mode will allow to have debug output from all places, AS, Java and iOS console

adMobManager.verbose = true;

Set Manager Operation Mode [Optional... Until Operation] This setting will allow to set the extension in either test mode or operation mode. By default the extension will work in Test Mode, when the application needs to be release it will be needed to switch the operation into Production mode

adMobManager.operationMode = AdMobManager.TEST_MODE;

Set Common AdMob Unit Id for Banners [Recommended] Setting a common Admob Id will allow to avoid to specify an Id during banner creation If the manager has an adMob unit id set all the banner will be created using that id, unless a new id s specified during banner creation. In that case the banner will use the id included on its parameters.

adMobManager.bannersAdMobId = "ADMOB_BANNER_ID";

Set Common AdMob Unit Id for interstitial [Recommended] Same as for the banner the common AdMob Id for interstitial will be use for any interstitial created unless a new id is given during interstitial creation. In that case the interstitial will use the id included on its parameters.

adMobManager.interstitialAdMobId = "ADMOB_INTERSTITIAL_ID";

Set Gender Request Targeting [Optional] This setting allow to create the ad request specifically for a gender. Please note that all banner created after will included the given gender. Request targeting option can be update before the creation of new banner for offer different target banner.

adMobManager.gender = AdMobManager.GENDER_MALE;

Set Birthday Request Targeting [Optional] This setting allow to have specific banner for a given age If wish to set the age range then the year will be mandatory, while month and day can be optional. If month and day are not specified the default value of 1 will be used. Request targeting option can be update before the creation of new banner for offer different target banner.

adMobManager.birthYear = 1996;
adMobManager.birthMonth = 1;
adMobManager.birthDay = 24;

Set the Tag for child directed treatment [Optional] This setting allow to have specific banner for a children in accordance to Children's Online Privacy Protection Act (COPPA). Request targeting option can be update before the creation of new banner for offer different target banner.

adMobManager.isCDT = true;

This getter will allow to get the current quantity of banner created and available in the Manager

var num:int = adMobManager.bannersQuantity;

This getter will allow to get all the banners id of banner created and available in the Manager

var bannerIds:Array = adMobManager.bannersNames;

This getter will allow to get the information of which device is currently in use (Android or iOS)

var device:String = adMobManager.device;

Create an AdMob Banner in an relative Position The parameter ae as follow:

Banner Size [Mandatory]

• Banner specific size

Banner Position [Mandatory]

• Banner specific Position

Banner Id [Optional]

• Useful when you wish to create more than one banner. If an id is not specified a random id will be generated

AdMobId [Optional]

• Banner specific AdMobId, Useful if you are tracking the banner result assigning individual id. If an id is not specified the common id will be used.

AutoShow Option [Optional]

• This option allow to automatically show the banner one it is loaded. The default value is set to false, so you can load the banner in cache and show it only on specific application phases

adMobManager.createBannerAbsolute(AdMobSize.BANNER,AdMobPosition.BOTTOM_CENTER,"BottomBanner1", null, true);

Create an AdMob Banner in an absolute Position The parameter ae as follow:

Banner Size [Mandatory]

• Banner specific size

Banner X Position [Mandatory]

• Banner specific X Position

Banner Y Position [Mandatory]

• Banner specific Y Position

Banner Id [Optional]

• Useful when you wish to create more than one banner. If an id is not specified a random id will be generated

AdMobId [Optional]

• Banner specific AdMobId, Useful if you are tracking the banner result assigning individual id. If an id is not specified the common id will be used.

AutoShow Option [Optional]

• This option allow to automatically show the banner one it is loaded. The default value is set to false, so you can load the banner in cache and show it only on specific application phases

adMobManager.createBannerAbsolute(AdMobSize.BANNER,100, 200, "BottomBanner1", null, true);

Show a specific Banner The function will allow to show a specific banner, recognized by its Id. This is specifically useful when your app wish to manage several ads. The parameter are as follow: Banner Id [Mandatory]

• Specific banner Id for the banner to be show

adMobManager.showBanner("BottomBanner1");

Hide a specific Banner The function will allow to hide a specific banner, recognized by its Id. This is specifically useful when your app wish to manage several ads. The parameter are as follow: Banner Id [Mandatory]

• Specific banner Id for the banner to be hide

adMobManager.hideBanner("BottomBanner1");

Remove a specific Banner The function will allow to remove a specific banner, recognized by its Id. This is specifically useful when your app wish to manage several ads. The parameter are as follow: Banner Id [Mandatory]

• Specific banner Id for the banner to be removed

adMobManager.removeBanner("BottomBanner1");

Show all existing hidden banners The function will show all available banners

adMobManager.showAllBanner();

Hide all existing hidden banners The function will hide all available banners

adMobManager.hideAllBanner();

Remove all existing hidden banners The function will remove all available banners

adMobManager.removeAllBanner();

Create the AdMob Interstitial The parameter are as follow:

AdMobId [Optional]

• Interstitial specific AdMobId. If an id is not specified the common id will be used.

AutoShow Option [Optional]

• This option allow to automatically show the banner one it is loaded. The default value is set to false, so you can load the banner in cache and show it only on specific application phases

• Please note, in iOS the Interstitial will ALWAYS be automatically show regardless of the setting.

adMobManager.createInterstitial(null,true);

Cache the AdMob Interstitial

• Android Only The parameter ae as follow:

AdMobId [Optional]

• Banner speciic AdMobId, Useful if you are tracking the banner result assigning individual id. If an id is not specified the common id will be used.

AutoShow Option [Optional]

• This option allow to automatically show the banner one it is loaded. The default value is set to false, so you can load the banner in cache and show it only on specific application phases

• Please note, in iOS the Interstitial will ALWAYS be automatically show regardless of the setting.

adMobManager.cacheInterstitial(null,true);

Cache the AdMob Interstitial The function will show the cached AdMob Interstitial

• Android Only

adMobManager.showInterstitial();

Check the Interstitial load state

var state:Boolean = adMobManager.isInterstitialLoaded();

##Listen to Events In order to listen to event you need to attache the event listener to the extension dispatcher. The easiest way is to create an internal dispatcher instance:

/**
 * Extension event dispatcher instance
 **/
private function get dispatcher():EventDispatcher
{
    // Return the extension dispatcher
    return adMobManager.dispatcher;
}

Then you can add all the listener for the event you need:

// onBannerLoaded Event Listener
if (!dispatcher.hasEventListener(AdMobEvent.BANNER_LOADED))
    dispatcher.addEventListener(AdMobEvent.BANNER_LOADED, onBannerLoaded);


/**
 * onBannerLoaded Event listener
 *
 * @param e AdMobEvent Object
 **/
static private function onBannerLoaded(e:AdMobEvent):void
{
    // Do Something like show the banner...
    adMobManager.showAllBanner();
}

The event will also pass the banner id for the banner who did dispatch the event. The example above will show all the banner, if you wish to, for example, show only the specific banner who did dispatch the event you can do as follow:

/**
 * onBannerLoaded Event listener
 *
 * @param e AdMobEvent Object
 **/
static private function onBannerLoaded(e:AdMobEvent):void
{
    // Show the specific banner who did dispatch the event
    // e.data:String = Banner unique ID
    adMobManager.showBanner(e.data);
}

One of the most important characteristic of Admob ANE Extension is that it was develop aimed to allow multiple banner instance to be used and managed while available in cache. For this reason all the event will always pass the Banner id s parameter. This include also the error Event. If you need to check the error events details simply set the verbose mode to "true" then all the details will be available in the console logs.

The Extension available Event are as follow:

BANNER_LOADED // The banner has been received and it is ready to be show
BANNER_FAILED_TO_LOAD // There was an error with the banner request. most of the time, it is a wrong adMobId or missing connection
BANNER_AD_OPENED // The banner has been clicked by the user
BANNER_AD_CLOSED // The User left the banner destination (webpage/store) and is returning to the application
BANNER_LEFT_APPLICATION // The banner has been remove from the application
INTERSTITIAL_LOADED // The Interstitial has been received and it is ready to be show (iOS will be show directly)
INTERSTITIAL_FAILED_TO_LOAD // There was an error with the Interstitial request. most of the time, it is a wrong adMobId or missing connection
INTERSTITIAL_AD_OPENED // The Interstitial has been clicked by the user
INTERSTITIAL_AD_CLOSED // The User left the Interstitial destination (webpage/store) and is returning to the application
INTERSTITIAL_LEFT_APPLICATION // The Interstitial has been remove from the application (especially useful for listen when the user close the Interstitial)

##Setup for Android

Update Your Application Descriptor

You'll need to be using the AIR 3.1 SDK or higher, include the extension in your Application Descriptor XML, and update the Android Manifest Additions with some settings.

Add the following settings in tag.

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

Add the following settings in tag.

<meta-data android:name="com.google.android.gms.version" android:value="4323000"/>
<activity android:name="com.google.android.gms.ads.AdActivity" android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize" />