• Android
• iOS 8+

• iOS AppsFlyerSDK v4.8.4
• Android AppsFlyerSDK v4.8.11

$ cordova plugin add cordova-plugin-appsflyer-sdk

or directly from git:

$ cordova plugin add https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk.git

For Google Install referrer support:

Open the build.gradle file for your application. Make sure that the repositories section includes a maven section with the "https://maven.google.com" endpoint. For example:

allprojects {
    repositories {
        jcenter()
        maven {
            url "https://maven.google.com"
        }
    }
}

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" />

Inside the <aplication> tag, add the following receiver:

<receiver android:exported="true"    android:name="com.appsflyer.MultipleInstallBroadcastReceiver">
    <intent-filter>
        <action android:name="com.android.vending.INSTALL_REFERRER" />
    </intent-filter>
</receiver>

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.

Copy:

• AppsFlyerPlugin.h
• AppsFlyerPlugin.m
• AppsFlyerTracker.h
• libAppsFlyerLib.a to platforms/ios/<ProjectName>/Plugins

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

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);

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

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

initialize the SDK.

options

Example:

var onSuccess = function(result) {
  //handle result
  /*
  {
  "status": "success",
  "type": "onInstallConversionDataLoaded",
  "data": {
    "af_dp": "https://ionic.fess.onelink.me",
    "af_click_lookback": "7d",
    "install_time": "2018-07-05 08:06:50.828",
    "cost_cents_USD": "0",
    "iscache": "true",
    "media_source": "someMedia",
    "click_time": "2018-07-05 08:06:02.956",
    "orig_cost": "0.0",
    "campaign": "boo",
    "key": "val",
    "af_status": "Non-organic",
    "is_first_launch": "false"
  }
}
*/   
};

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

• 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 want 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.

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);

End User Opt-Out (Optional) AppsFlyer provides you a method to opt‐out specific users from AppsFlyer analytics. This method complies with the latest privacy requirements and complies with Facebook data and privacy policies. Default is FALSE, meaning tracking is enabled by default.

Examples:

window.plugins.appsFlyer.setDeviceTrackingDisabled(true);

Examples:

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

Setting your own Custom ID enables you to cross-reference your own unique ID with AppsFlyer’s user ID and the other devices’ IDs. This ID is available in 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 this API during the deviceready event, where possible.

Example:

window.plugins.appsFlyer.setAppUserId(userId);

Setting your own Custom ID enables you to cross-reference your own unique ID with AppsFlyer’s user ID and the other devices’ IDs. This ID is available in 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 this API during the deviceready event, where possible.

Example:

window.plugins.appsFlyer.stopTracking(true);

In any event, the SDK can be reactivated by calling the same API, but to pass false.

Example:

window.plugins.appsFlyer.registerOnAppOpenAttribution(function        
   onAppOpenAttributionSuccess(res){
     /*
     {
    "data": {
      "af_deeplink": "true",
      "campaign": "boo",
      "key": "val",
      "media_source": "someMedia",
      "install_time": "2018-07-12 13:20:19",
      "af_status": "Non-organic",
      "path": "",
      "scheme": "https",
      "host": "ionic.fess.onelink.me"
    },
    "type": "onAppOpenAttribution",
    "status": "success"
  }
     */
   }, 
   function onAppOpenAttributionError(err){
    //...
 });

Allows to pass GCM/FCM Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for Uninstall Tracking.

Get AppsFlyer’s proprietary Device ID. The AppsFlyer Device ID is the main ID used by AppsFlyer in Reports and APIs.

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

Example:

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

Set AppsFlyer’s OneLink ID. Setting a valid OneLink ID will result in shortened User Invite links, when one is generated. The OneLink ID can be obtained on the AppsFlyer Dashboard.

Example:

window.plugins.appsFlyer.setAppInviteOneLinkID("Ab1C");

Allowing your existing users to invite their friends and contacts as new users to your app can be a key growth factor for your app. AppsFlyer allows you to track and attribute new installs originating from user invites within your app.

Example:

var inviteOptions {
  channel: "gmail",
  campaign: "myCampaign",
  customerID: "1234",
  
  userParams {
    myParam : "newUser",
    anotherParam : "fromWeb",
    amount : 1
  }
};

var onInviteLinkSuccess = function(link) {
  console.log(link); // Handle Generated Link Here
}

function onInviteLinkError(err) {
  console.log(err);
}

window.plugins.appsFlyer.generateInviteLink(inviteOptions, onInviteLinkSuccess, onInviteLinkError);

Use this call to track an impression use the following API call. Make sure to use the promoted App ID as it appears within the AppsFlyer dashboard.

Example:

window.plugins.appsFlyer.trackCrossPromotionImpression("com.myandroid.app", "myCampaign");

Use this call to track the click and launch the app store's app page (via Browser)

Example:

var crossPromOptions {
  customerID: "1234",
  myCustomParameter: "newUser"
};

window.plugins.appsFlyer.trackAndOpenStore("com.myandroid.app", "myCampaign", crossPromOptions);

In ver. >4.2.5 deeplinking metadata (scheme/host) is sent automatically

Add the following lines to your code to be able to track deeplinks with AppsFlyer attribution data:

for pure Cordova - add a function 'handleOpenUrl' to your root, and call our SDK as shown:

    window.plugins.appsFlyer.handleOpenUrl(url);

It appears as follows:

var handleOpenURL = function(url) {
    window.plugins.appsFlyer.handleOpenUrl(url);
}