cordova-plugin-appsflyer-sdk

Cordova AppsFlyer plugin for Android and iOS.

---

❗️Important
Cordova AppsFlyer plugin version 4.4.0 and higher are meant to be used with cordova-android@7.0.0 and up
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 [e-mail]

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
• V6 Breaking Changes
• Installation
• Guides
• Setup
• API
• Demo
• Ionic

This plugin is built for

• iOS AppsFlyerSDK v6.0.5
• Android AppsFlyerSDK v5.4.4

❗v6 Breaking Changes

We have renamed the following APIs:

Old API	New API
trackEvent	logEvent
stopTracking	stop
trackCrossPromotionImpression	logCrossPromotionImpression
trackAndOpenStore	logCrossPromotionAndOpenStore
setDeviceTrackingDisabled	anonymizeUser

📲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
• Set plugin for IOS 14

🚀 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.
waitForATTUserAuthorization - For iOS14 only. Time for the sdk to wait before launch.

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
      waitForATTUserAuthorization: 10, //time for the sdk to wait before launch - IOS 14 ONLY!
    },
      (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.
There is 1 demo project called demoC, run npm run setup_c in the appsflyer-cordova-plugin folder and then open the ios project in Xcode to see implementation for IOS 14.
Check out our Sample-App Let's cook! here if you want to implement our SDK inside React-Cordova app

📍 Ionic

In case you are using Ionic framework, you have 2 options:

1 - Using Ionic native plugin

Ionic 4

run this commands: With Cordova:

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

With Capacitor:

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

Then 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';
import {Platform} from '@ionic/angular';

constructor(private appsflyer: Appsflyer, public platform: Platform) { 
...
this.platform.ready().then(() => {
            this.appsflyer.initSdk(options);
        });
}

Ionic 2/3

If you're using Ionic 2/3, you'd need to install a previous version of the Ionic Native dependency (notice the @4 at the end of the npm install command):

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

Then add the following to app.module.ts(with no /ngx)

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

And finally in your main ts file:

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

2. Using the window object directly

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