React Native plugin

Your AppsFlyer dev key is unique and identifies your account. Its use is mandatory as it allows the SDK to securely send and retrieve data belonging to your AppsFlyer account. Only your Admin can retrieve the dev key.

To retrieve a dev key:

1. Go to the AppsFlyer platform.
2. In the menu bar, go to Configuration and click App settings.
3. Under SDK installation, copy the dev key shown in the field.

To initialize the plugin:

1. In app.js, import the following:
   

   import appsFlyer from 'react-native-appsflyer';

2. Call the initSDK method using these parameters:

Options

Example: Initialize the plugin

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, // set to true if you want to see data in the logs 
    appId: '4*******4', // iOS app id
  },
  (result) => {
    console.log(result);
  },
  (error) => {
    console.error(error);
  }
);

To record in-app events, use this list of recommended event names and parameters.

Recommended practice! Use event names and parameters for the following reasons:

• Standard naming: AppsFlyer can automatically map events to SRNs such as Facebook, Google, Twitter, and Snapchat.
• Backward compatibility: No issue arises if AppsFlyer changes an event name or parameter as your implementation is backward compatible.

Use the trackEvent method to record in-app events.

trackEvent Parameters

const eventName = "af_add_to_cart";
 const eventValues = {
   "af_content_id": "id123",
 };
 appsFlyer.trackEvent(
      eventName,
      eventValues,
      (res) => {
        console.log(res);
      },
      (err) => {
        console.error(err);
      }
    );

Send revenue with any in-app event by using the af_revenue event parameter.

• Populate af_revenue with any numeric value, positive or negative.
• af_revenue is the only event parameter considered as real revenue in raw data reports and on the dashboard. Click here for more details.

Learn more about currency settings, display, and currency conversion.

Consider these currency code factors when sending events with revenue:

• Default currency: USD
• Set currency codes as a 3 character ISO 4217 code.
• Revenue values cannot contain comma separators, currency symbols, or text.
  Example revenue event: 1234.56

Example: Record an in-app event with revenue

const eventName = "purchase";
const eventValues = {
   "af_content_id": "id123",
   "af_currency":"USD",
   "af_revenue": "2"
};

 appsFlyer.trackEvent(eventName, eventValues, (error, result) => {
   if (error) {
     console.error(error);
   } else {
     //...
   }
 });

Sometimes it is necessary to record negative revenue, such as when giving a user a refund on a purchase.

const eventName = "refund";
const eventValues = {
   "af_content_id": "id123",
   "af_currency":"USD",
   "af_revenue": "-2" // The revenue value is preceded by a minus sign.
};

 appsFlyer.trackEvent(eventName, eventValues, (error, result) => {
   if (error) {
     console.error(error);
   } else {
     //...
   }
 });

• Event name: up to 45 characters
• Event value: up to 1000 characters; if longer, it can be truncated
• Non-English characters are supported from iOS and Android versions 4.81.1 (or in-app events and other SDK API)
• Pricing and revenue:
  • Only use numbers and decimals such as 5 or 5.2
  • Up to 5 numbers after the decimal such as 5.12345

This capability is not available in the React Native plugin. Set up in-app purchase validation natively for each OS:

• Android
• iOS

There are two methods to get conversion data:

• Deferred deep linking directs users to specific activities and customized content according to conversion data.
• Direct deep linking opens an app at a specific activity and the content can be customized according to conversion data.

Deferred deep linking: onInstallConversionData

To get conversion data, implement onInstallConversionData. Code sample:

this.onInstallConversionDataCanceller = appsFlyer.onInstallConversionData(
  (res) => {
    if (JSON.parse(res.data.is_first_launch) == true) {
      if (res.data.af_status === 'Non-organic') {
        var media_source = res.data.media_source;
        var campaign = res.data.campaign;
        alert('This is first launch and a Non-Organic install. Media source: ' + media_source + ' Campaign: ' + campaign);
      } else if (res.data.af_status === 'Organic') {
        alert('This is first launch and a Organic Install');
      }
    } else {
      alert('This is not first launch');
    }
  }
);

appsFlyer.initSdk(/*...*/);

Direct deep linking: onAppOpenAttribution

To get conversion data, implement onAppOpenAttribution. Code sample:

this.onAppOpenAttributionCanceller = appsFlyer.onAppOpenAttribution((res) => {
  console.log(res);
  // implement logic to customize content
});

appsFlyer.initSdk(/*...*/);

1. Implement onInstallConversionData and onAppOpenAttribution in your React Native project.
2. Set up an app to support deep linking. Follow the instructions for each OS:

• Android
• iOS

Measure the uninstall rate of users coming from different sources. This significant KPI helps you analyze and optimize your campaigns. Read about uninstall measurement instructions.

To integrate on the SDK level with external partner platforms (including Segment, Adobe, and Urban Airship), it is necessary to use the setAdditionalData API.

Only use this API if the partner's integration article specifically states the setAdditionalData API is needed.

appsFlyer.setAdditionalData(
  {
    val1: 'data1',
    val2: false,
    val3: 23,
  },
  (res) => {
    //...
  }
);

Not available in React Native plugin. See instructions for each OS.

• Android
• iOS

Not available in the React Native plugin. See instructions for Android.

Not available in React Native plugin. See instructions for each OS.

• Android
• iOS

Not available in React Native plugin. See instructions for each OS.

• Android
• iOS

If you allow existing app users to invite their friends and contacts to become new users, this can be a key growth factor for your app.

With AppsFlyer, you can attribute and record installs that originate from user invites within your app.

There are two steps:

1. Set OneLink ID.
2. Generate invite link.

Set OneLink ID

setAppInviteOneLinkID(oneLinkID, callback)

Generate invite link

appsFlyer.generateInviteLink(
 {
   channel: 'gmail',
   campaign: 'myCampaign',
   customerID: '1234',
   userParams: {
     myParam: 'newUser',
     anotherParam: 'fromWeb',
     amount: 1,
   },
 },
 (link) => {
   console.log(link);
 },
 (err) => {
   console.log(err);
 }
);

Not available in the React Native plugin. See instructions for each OS.

• Android
• iOS

An AppsFlyer ID is created for every new install of an app. You can use the AppsFlyer ID for various purposes:

• Send server-to-server in-app events.
• Match the AppsFlyer ID with user records in your back-end systems.
• Map entries when merging data from pull and push API.

Use this API to obtain a unique AppsFlyer ID:

appsFlyer.getAppsFlyerUID((err, appsFlyerUID) => {
  if (err) {
    console.error(err);
  } else {
    console.log('on getAppsFlyerUID: ' + appsFlyerUID);
  }
});

Set your own unique customer user ID (CUID) and cross-reference it with a unique AppsFlyer ID.

Unique CUID:

• Appear in AppsFlyer raw data CSV reports.
• Can be used in postback APIs to cross-reference with internal IDs.

To set your CUID, use:

appsFlyer.setCustomerUserId('some_user_id', (res) => {
  //..
});

Recommended practice! Set the CUID early in the app flow—it is only associated with events reported after its setup.

Call setCustomerUserId before calling trackAppLaunch

• Recorded events will be associated with the CUID.
• Related data will appear in the raw data reports for installs and events.
• If set later, then the CUID will only be associated with events recorded after setting the CUID.

Different scenarios, such as legal and privacy compliance issues, may lead to a decision to opt-out and stop all SDK tracking. Best practice! Follow the exact instructions for the scenario relevant to your app.

To stop tracking:

• Call isStopTracking and set to true.

stopTracking(isStopTracking, callback)

• SDK stops functioning and no longer communicates with AppsFlyer servers.

To reactivate tracking: Call isStopTrackingIn and set to false.

Not available in the React Native plugin. See instructions for each OS:

• Android
• iOS

In some cases, advertisers may want to stop sharing user-level data with ad networks/partners for specific users. Reasons for this include: 

• Privacy policies such as CCPA or GDPR
• User opt-out mechanisms
• Competition with some partners (ad networks, 3rd parties)

AppsFlyer provides two API methods to stop sharing data with some or all partners:

• setSharingFilter: Used by advertisers to prevent sharing data with some (one or more) networks/integrated partners.
• setSharingFilterForAllPartners: Used by advertisers to prevent sharing data with all networks/integrated partners.

These filtering methods are supported as of SDK V5.4.1.

The filtering method must be called every time the SDK is initialized and affects the whole session. If it takes time to determine whether you need to set the sharing filters, then delay the SDK initialization. 

When the method is activated before the first trackAppLaunch call:

• Users from SRNs are attributed as Organic, and their data is not shared with integrated partners.
• Users from click ad networks (non-SRNs) are attributed correctly in AppsFlyer, but not shared with the ad networks via postbacks, APIs, raw data reports, or by any other method.

Currently, uninstall data can't be filtered using these methods. However, you can stop sending Uninstall events to partners using their setup pages in AppsFlyer.