rarago / cordova-plugin-appsflyer-sdk

AppsFlyer plugin for Cordova

Cordova AppsFlyer plugin for Android and iOS.

---

❗️Important
Cordova AppsFlyer plugin version 4.4.0 and higher are meant to be used with [email protected]
For lower versions of cordova-android please use plugin version 4.3.3 available @ https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk/tree/4.3.3

---

🛠 In order for us to provide optimal support, we would kindly ask you to submit any issues to [email protected]

When submitting an issue please specify your AppsFlyer sign-up (account) email , your app ID , reproduction steps, code snippets, logs, and any additional relevant information.

---

Table of content

• SDK versions
• Installation
• Guides
• Setup
• API
• Demo
• Ionic

This plugin is built for

• iOS AppsFlyerSDK v4.9.0
• Android AppsFlyerSDK v4.9.0

📲Installation

$ cordova plugin add cordova-plugin-appsflyer-sdk

To install cordova manually check out the doc here.

NOTE: for Ionic installation see this section

📖 Guides

Great installation and setup guides can be viewed here.

• init SDK Guide
• Deeplinking Guide
• Uninstall Guide

🚀 Setup

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 is 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 the following lines to your code to be able to initialize tracking with your own AppsFlyer dev key:

document.addEventListener('deviceready', function() {

   window.plugins.appsFlyer.initSdk({
      devKey: 'K2***************99', // your AppsFlyer devKey
      isDebug: false,
      appId: '41*****44' // your ios appID
    },
      (result) => {
        console.log(result);
      },
      (error) => {
        console.error(error);
      }
    );
  
}, false);

---

📑 API

See the full API available for this plugin.

📱 Demo

Check out the demo for this project here.

📍 Ionic

In case you are using Ionic framework, you have 2 options: 1 - Using Ionic native plugin run this commands:

$ ionic cordova plugin add cordova-plugin-appsflyer-sdk
$ npm install @ionic-native/appsflyer

add the following to app.module.ts

import { Appsflyer } from "@ionic-native/appsflyer/ngx";
...
providers: [
    Appsflyer,
  	...,
]

and in your main ts file:

import { Appsflyer } from '@ionic-native/appsflyer/ngx';


constructor(private appsflyer: Appsflyer) { }

...

this.appsflyer.initSdk(options);

2. You can use the plugin the same way like in Cordova with only one exception: instead of window.plugins... use window['plugins']...

Check out the full API for more information