Example:
appsFlyer.initSdk(
{
devKey: 'K2***********99',
isDebug: false,
appId: '41*****44',
},
(result) => {
console.log(result);
},
(error) => {
console.error(error);
}
);
Since users may or may not have the mobile app installed, there are 3 types of deep linking:
- Deferred Deep Linking - Serving personalized content to new or former users, directly after the installation.
- Direct Deep Linking - Directly serving personalized content to existing users, which already have the mobile app installed.
- Unified deep linking - Unified deep linking sends new and existing users to a specific in-app activity as soon as the app is opened.
For more info please check out the OneLink™ Deep Linking Guide.
Check out the deferred deep linking guide from the AppFlyer knowledge base here.
Code Sample to handle the conversion data:
const onInstallConversionDataCanceller = appsFlyer.onInstallConversionData(
(res) => {
const isFirstLaunch = res?.data?.is_first_launch;
if (isFirstLaunch && JSON.parse(isFirstLaunch) === true) {
if (res.data.af_status === 'Non-organic') {
const media_source = res.data.media_source;
const 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(/*...*/);Note: The code implementation for onInstallConversionData must be made prior to the initialization code of the SDK.
Important
The appsFlyer.onInstallConversionData returns function to unregister this event listener. If you want to remove the listener for any reason, you can simply call onInstallConversionDataCanceller(). This function will call NativeAppEventEmitter.remove().
When a deep link is clicked on the device the AppsFlyer SDK will return the link in the onAppOpenAttribution method.
const onAppOpenAttributionCanceller = appsFlyer.onAppOpenAttribution((res) => {
console.log(res);
});
appsFlyer.initSdk(/*...*/);Note: The code implementation for onAppOpenAttribution must be made prior to the initialization code of the SDK.
Important
The appsFlyer.onAppOpenAttribution returns function to unregister this event listener. If you want to remove the listener for any reason, you can simply call onAppOpenAttributionCanceller(). This function will call NativeAppEventEmitter.remove().
In order to use the unified deep link you need to send the onDeepLinkListener: true flag inside the object that sent to the sdk.
NOTE: when sending this flag, the sdk will ignore onAppOpenAttribution!
For more information about this api, please check OneLink Guide Here
const onDeepLinkCanceller = appsFlyer.onDeepLink(res => {
console.log('onDeepLinking: ' + JSON.stringify(res));
console.log('status: '+ res.status);
console.log('type: '+ res.type);
})
appsFlyer.initSdk(
{
devKey: 'K2***********99',
isDebug: false,
appId: '41*****44',
onInstallConversionDataListener: true,
onDeepLinkListener: true
},
(result) => {
console.log(result);
},
(error) => {
console.error(error);
}
);Note: The code implementation for onDeepLink must be made prior to the initialization code of the SDK.
Important
The appsFlyer.onDeepLink returns function to unregister this event listener. If you want to remove the listener for any reason, you can simply call onDeepLinkCanceller(). This function will call NativeAppEventEmitter.remove().
import appsFlyer from 'react-native-appsflyer';
const onAppOpenAttributionCanceller = appsFlyer.onAppOpenAttribution((res) => {
console.log(res);
});
const onDeepLinkCanceller = appsFlyer.onDeepLink(res => {
console.log('onDeepLinking: ' + JSON.stringify(res));
})
const onInstallConversionDataCanceller = appsFlyer.onInstallConversionData(
(res) => {
const isFirstLaunch = res?.data?.is_first_launch;
if (isFirstLaunch && JSON.parse(isFirstLaunch) === true) {
if (res.data.af_status === 'Non-organic') {
const media_source = res.data.media_source;
const 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(
{
devKey: 'K2***********99',
isDebug: false,
appId: '41*****44',
},
(result) => {
console.log(result);
},
(error) => {
console.error(error);
}
);
// ...
class App extends Component<{}> {
componentWillUnmount() {
// Optionaly remove listeners for deep link data if you no longer need them after componentWillUnmount
if (onInstallConversionDataCanceller) {
onInstallConversionDataCanceller();
console.log('unregister onInstallConversionDataCanceller');
onInstallConversionDataCanceller = null;
}
if (onAppOpenAttributionCanceller) {
onAppOpenAttributionCanceller();
console.log('unregister onAppOpenAttributionCanceller');
onAppOpenAttributionCanceller = null;
}
if (onDeepLinkCanceller) {
onDeepLinkCanceller();
console.log('unregister onDeepLinkCanceller');
onDeepLinkCanceller = null;
}
}
}Init SDK with Hooks:
import React, {useEffect, useState} from 'react';
import {AppState, SafeAreaView, Text, View} from 'react-native';
import appsFlyer from 'react-native-appsflyer';
const onInstallConversionDataCanceller = appsFlyer.onInstallConversionData(
(res) => {
const isFirstLaunch = res?.data?.is_first_launch;
if (isFirstLaunch && JSON.parse(isFirstLaunch) === true) {
if (res.data.af_status === 'Non-organic') {
const media_source = res.data.media_source;
const campaign = res.data.campaign;
console.log('This is first launch and a Non-Organic install. Media source: ' + media_source + ' Campaign: ' + campaign);
} else if (res.data.af_status === 'Organic') {
console.log('This is first launch and a Organic Install');
}
} else {
console.log('This is not first launch');
}
},
);
const onAppOpenAttributionCanceller = appsFlyer.onAppOpenAttribution((res) => {
console.log(res);
});
appsFlyer.initSdk(
{
devKey: 'K2a*********99',
isDebug: false,
appId: '41******5',
},
(result) => {
console.log(result);
},
(error) => {
console.error(error);
},
);
const Home = (props) => {
useEffect(() => {
return () => {
// Optionaly remove listeners for deep link data if you no longer need them after componentWillUnmount
if (onInstallConversionDataCanceller) {
onInstallConversionDataCanceller();
console.log('unregister onInstallConversionDataCanceller');
onInstallConversionDataCanceller = null;
}
if (onAppOpenAttributionCanceller) {
onAppOpenAttributionCanceller();
console.log('unregister onAppOpenAttributionCanceller');
onAppOpenAttributionCanceller = null;
}
};
}, []);
return (
<SafeAreaView>
<View>
<Text>{'App'}</Text>
</View>
</SafeAreaView>
);
};In order to record retargeting and use the onAppOpenAttribution callbacks in iOS, the developer needs to pass the User Activity / URL to our SDK, via the following methods in the AppDelegate.m file:
#import <RNAppsFlyer.h>If using react-native-appsflyer plugin version <= 6.1.30
#import <React/RCTLinkingManager.h>
#if __has_include(<AppsFlyerLib/AppsFlyerLib.h>) // from Pod
#import <AppsFlyerLib/AppsFlyerLib.h>
#else
#import "AppsFlyerLib.h"
#endif- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler {
// version >= 6.2.10
[[AppsFlyerAttribution shared] continueUserActivity:userActivity restorationHandler:restorationHandler];
// version < 6.2.10
[[AppsFlyerLib shared] continueUserActivity:userActivity restorationHandler:restorationHandler];
return YES;
}// Reports app open from deep link from apps which do not support Universal Links (Twitter) and for iOS8 and below
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString*)sourceApplication annotation:(id)annotation {
// version >= 6.2.10
[[AppsFlyerAttribution shared] handleOpenUrl:url sourceApplication:sourceApplication annotation:annotation];
// version < 6.2.10
[[AppsFlyerLib shared] handleOpenURL:url sourceApplication:sourceApplication withAnnotation:annotation];
return YES;
}
// Reports app open from URL Scheme deep link for iOS 10
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary *) options {
// version >= 6.2.10
[[AppsFlyerAttribution shared] handleOpenUrl:url options:options];
// version < 6.2.10
[[AppsFlyerLib shared] handleOpenUrl:url options:options];
return YES;
}On Android, AppsFlyer SDK inspects activity intent object during onResume(). Because of that, for each activity that may be configured or launched with any non-standard launch mode please make sure to add the following code to MainActivity.java in android/app/src/main/java/com...:
...
import android.content.Intent;
...
public class MainActivity extends ReactActivity {
...
@Override
public void onNewIntent(Intent intent) {
super.onNewIntent(intent);
setIntent(intent);
}
}
This method makes sure that you get the latest deep link data even if the app was initially launched with another deep link. See the Android developer documentation for more details.
AppsFlyer enables you to measure app uninstalls. To handle notifications it requires to modify your AppDelegate.m. Use didRegisterForRemoteNotificationsWithDeviceToken to register to the uninstall feature.
Example:
@import AppsFlyerLib;
...
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
// notify AppsFlyerLib
[[AppsFlyerLib shared] registerUninstall:deviceToken];
}Read more about Uninstall register: Appsflyer SDK support site
Pass the device token to AppsFlyer
Example:
appsFlyer.updateServerUninstallToken(deviceToken, (success) => {
//...
});Update Firebase device token so it can be sent to AppsFlyer
Example:
appsFlyer.updateServerUninstallToken(newFirebaseToken, (success) => {
//...
});Read more about Android Uninstall Measurement: Appsflyer SDK support site