Skip to content

OutSystemsExperts/appsflyer-cordova-plugin

 
 

Repository files navigation

Cordova AppsFlyer plugin for Android and iOS.

npm version Build Status


❗️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

  • iOS AppsFlyerSDK v5.4.3
  • Android AppsFlyerSDK v5.4.3
$ cordova plugin add cordova-plugin-appsflyer-sdk

To install cordova manually check out the doc here.

NOTE: for Ionic installation see this section

Great installation and setup guides can be viewed here.

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

See the full API available for this plugin.

Check out the demo for this project here.

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

constructor(private appsflyer: Appsflyer) { }
...
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

About

AppsFlyer plugin for Cordova

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Objective-C 52.5%
  • Java 30.9%
  • JavaScript 16.6%