Skip to content
AppsFlyer plugin for React Native
Objective-C Java JavaScript Ruby
Branch: master
Clone or download
Latest commit 103e1bc Aug 20, 2019

README.md

React Native AppsFlyer plugin for Android and iOS.

🛠 In order for us to provide optimal support, we would kindly ask you to submit any issues to support@appsflyer.com

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

npm version

Table of content

This plugin is built for

  • iOS AppsFlyerSDK v4.8.12
  • Android AppsFlyerSDK v4.8.20

📲Installation

$ npm install react-native-appsflyer --save

Then run:

$ react-native link react-native-appsflyer

iOS

With Cocoapods

Add the appsFlyerFramework to podfile and run pod install.

pod 'react-native-appsflyer',
:path => '../node_modules/react-native-appsflyer'

Note that You must also have the React dependencies defined in the Podfile as described here.

Check out the sample pod file for a working example.

Without Cocoapods

  1. Download the Static Lib of the AppsFlyer iOS SDK from here.
  2. Unzip and copy the contents of the Zip file into your project directory.
  3. Copy RNAppsFlyer.h and RNAppsFlyer.m from node_modulesreact-native-appsflyer to your project directory.

For more info check out the Installation guide here.

Android

Running react-native link react-native-appsflyer will complete the Android integration.

For the manual integration steps, check out the Installation guide here.

🚀 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:

import React, {Component} from 'react';
import {Platform, StyleSheet, Text, View} from 'react-native';
import appsFlyer from 'react-native-appsflyer';

appsFlyer.initSdk(
  {
    devKey: 'K2***********99',
    isDebug: false,
    appId: '41*****44',
  },
  (result) => {
    console.log(result);
  },
  (error) => {
    console.error(error);
  }
);

Important - For iOS another step is required for tracking. AppState logic is required to track Background-to-foreground transitions. Check out the relevant guide to see how this manidtory step is impelemented.

📖 Guides

Great installation and setup guides can be viewed here.

📑 API

See the full API available for this plugin.

📱 Demo

Check out the demo for this project here.

You can’t perform that action at this time.