Cordova/PhoneGap AppsFlyer plugin for Android and iOS. (v4.2.4)

Supported Platforms

• Android
• iOS 8+

Cordova >= 4.3.x.

This plugin is built for

• iOS AppsFlyerSDK v4.5.9
• Android AppsFlyerSDK v4.6.0

Installation using CLI:

$ cordova plugin add appsflyer

or directly from git:

$ cordova plugin add https://github.com/AppsFlyerSDK/PhoneGap.git

Manual installation:

1. Add the following xml to your config.xml in the root directory of your www folder:

<!-- for iOS -->
<feature name="AppsFlyerPlugin">
  <param name="ios-package" value="AppsFlyerPlugin" />
</feature>

<!-- for Android -->
<feature name="AppsFlyerPlugin">
  <param name="android-package" value="com.appsflyer.cordova.plugin.AppsFlyerPlugin" />
</feature>

2. For Android, add the following xml to your AndroidManifest.xml:

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

3. Copy appsflyer.js to www/js/plugins and reference it in index.html:

<script type="text/javascript" src="js/plugins/appsflyer.js"></script>

4. Download the source files and copy them to your project.

iOS: Copy AppsFlyerPlugin.h, AppsFlyerPlugin.m, AppsFlyerTracker.h and libAppsFlyerLib.a to platforms/ios/<ProjectName>/Plugins

Android: Copy AppsFlyerPlugin.java to platforms/android/src/com/appsflyer/cordova/plugins (create the folders)

Usage:

1. Set your App_ID (iOS only), Dev_Key and enable AppsFlyer to detect installations, sessions (app opens), and updates.

This is the minimum requirement to start tracking your app installs and it's already implemented in this plugin. You MUST modify this call and provide:
-devKey - Your application devKey provided by AppsFlyer. -appId - For iOS only. Your iTunes application id.

Add following lines to your code to be able to initialize tracking with your own AppsFlyer dev key:

for pure Cordova:

document.addEventListener("deviceready", function(){
    
   var options = {
             devKey:  'xxXXXXXxXxXXXXxXXxxxx8'// your AppsFlyer devKey               
           };

    var userAgent = window.navigator.userAgent.toLowerCase();
                          
    if (/iphone|ipad|ipod/.test( userAgent )) {
        options.appId = "123456789";            // your ios app id in app store        
    }
    window.plugins.appsFlyer.initSdk(options);
}, false);

For Ionic

  $ionicPlatform.ready(function() {      
    
    var options = {
           devKey:  'xxXXXXXxXxXXXXxXXxxxx8'// your AppsFlyer devKey               
         };
                              
    if (ionic.Platform.isIOS()) {
        options.appId = "123456789";            // your ios app id in app store 
    }

      window.plugins.appsFlyer.initSdk(options);      
  });

API Methods

---

initSdk(options, onSuccess, onError): void

initialize the SDK.

parameter	type	description
options	Object	SDK configuration
onSuccess	(message: string)=>void	Success callback - called after successfull SDK initiation. (optional)
onError	(message: string)=>void	Error callback - called when error occurs during initialization. (optional)

options

name	type	default	description
devKey	string		Appsflyer Dev key
appId	string		Apple Application ID (for iOS only)
isDebug	boolean	true	debug mode (optional)

Example:

var onSuccess = function(result) {
     //handle result
};

function onError(err) {
    // handle error
}
var options = {
               devKey:  'd3Ac9qPnrpVYZxfWmCspwL',
               appId: '123456789',
               isDebug: false
             };
window.plugins.appsFlyer.initSdk(options, onSuccess, onError);

---

setCurrencyCode(currencyId): void

parameter	type	Default	description
currencyId	String	USD	ISO 4217 Currency Codes

Examples:

window.plugins.appsFlyer.setCurrencyCode("USD");
window.plugins.appsFlyer.setCurrencyCode("GBP"); // British Pound

---

setAppUserId(customerUserId): void

Setting your own custom ID will enable you to cross-reference your own unique ID with AppsFlyer’s user ID and the other devices’ IDs. This ID will be available at AppsFlyer CSV reports along with postbacks APIs for cross-referencing with you internal IDs.

Note: The ID must be set during the first launch of the app at the SDK initialization. The best practice is to call to this API during deviceready event if possible.

parameter	type	description
customerUserId	String

Example:

window.plugins.appsFlyer.setAppUserId(userId);

---

setGCMProjectID(GCMProjectID): void

Set the GCM API key. AppsFlyer requires a Google Project Number and GCM API Key to enable uninstall tracking.

parameter	type	description
GCMProjectID	String

registerUninstall(token): void

AEnables tracking app. uninstalls.

parameter	type	description
token	String

---

getAppsFlyerUID(successCB): void (Advanced)

Get AppsFlyer’s proprietary device ID. AppsFlyer device ID is the main ID used by AppsFlyer in the Reports and API’s.

function getUserIdCallbackFn(id){/* ... */} 
window.plugins.appsFlyer.getAppsFlyerUID(getUserIdCallbackFn);

Example:

var getUserIdCallbackFn = function(id) {
    alert('received id is: ' + id);
}
window.plugins.appsFlyer.getAppsFlyerUID(getUserIdCallbackFn);

parameter	type	description
getUserIdCallbackFn	() => void	Success callback

---

trackEvent(eventName, eventValues): void (optional)

• These in-app events help you track how loyal users discover your app, and attribute them to specific campaigns/media-sources. Please take the time define the event/s you would like to measure to allow you to track ROI (Return on Investment) and LTV (Lifetime Value).
• The trackEvent method allows you to send in-app events to AppsFlyer analytics. This method allows you to add events dynamically by adding them directly to the application code.

parameter	type	description
eventName	String	custom event name, will be represented in your dashboard. Event list you can see HERE
eventValue	Object	event details

Example:

var eventName = "af_add_to_cart";
var eventValues = {
           "af_content_id": "id123",
           "af_currency":"USD",
           "af_revenue": "2"
           };
window.plugins.appsFlyer.trackEvent(eventName, eventValues);

---

onInstallConversionDataLoaded(conversionData): void

Accessing AppsFlyer Attribution / Conversion Data from the SDK (Deferred Deep-linking). Read more: Android, iOS
Note: AppsFlyer plugin will fire onInstallConversionDataLoaded event with attribution data. You must implement onInstallConversionDataLoaded listener to receive the data.

parameter	type	description
conversionData	Object

Example:

document.addEventListener('onInstallConversionDataLoaded', function(e){
    var attributionData = (JSON.stringify(e.detail));
    alert(attributionData);
}, false);

---

Sample app:

We posted af-cordova-ionic-demo as separate repo in github, you can download and run it.