cordova-plugin-appsflyer-sdk - npm Package Compare versions

Comparing version 6.5.2 to 6.8.0-rc1

docs/API.md

@@ -51,4 +51,5 @@ # API
 | [`setPartnerData`](#setPartnerData) | `(partnerId, data)` | Allows sending custom data for partner integration purposes. |
+| [`sendPushNotificationData`](#sendPushNotificationData) | `(Object data)` | Measure and get data from push-notification campaigns.|
+| [`setDisableNetworkData`](#setDisableNetworkData) | `(boolean disable)` | Use to opt-out of collecting the network operator name (carrier) and sim operator name from the device.|
 
-
   
@@ -718,3 +719,29 @@ ---
 
+------
+##### <a id="sendPushNotificationData"> **`sendPushNotificationData(pushData): void`**
+Measure and get data from push-notification campaigns.
+*Example:*
+ 
+```javascript
+appsFlyer.sendPushNotificationData({apps: "Flyer", cuid: "123abc", someKey: "Some Value"});
+```
+
+| parameter | type | description |
+| ----------- |-----------------------------|--------------|
+| `pushData` |  `Object` | JSON object contains the push data |
+
 ---
+##### <a id="sendPushNotificationData"> **`setDisableNetworkData(disable): void`**
+Measure and get data from push-notification campaigns.
+*Example:*
+ 
+```javascript
+appsFlyer.setDisableNetworkData(true);
+```
+
+| parameter | type | description |
+| ----------- |-----------------------------|--------------|
+| `disable` |  `boolean` | If should opt out, default to false|
+
+---
 ### <a id="deep-linking-tracking"> Deep linking Tracking
@@ -721,0 +748,0 @@

docs/Guides.md

 
-# Cordova Appsflyer Plugin Guides
+  
+# Cordova Appsflyer Plugin Guides  
+  
+<img src="https://massets.appsflyer.com/wp-content/uploads/2016/06/26122512/banner-img-ziv.png"  width="300">  
+  
+## Table of content  
+  
+- [Init SDK](#init-sdk)  
+- [Set plugin for IOS 14](#ios14)  
+- [DeepLinking](#deeplinking)  
+  - [Deferred Deep Linking (Get Conversion Data)](#deferred-deep-linking)  
+  - [Direct Deeplinking](#handle-deeplinking)  
+  - [Unified Deeplinking](#Unified-deep-linking)  
+  - [Android Deeplink Setup](#android-deeplink)  
+  - [iOS Deeplink Setup](#ios-deeplink)  
+- [Uninstall](#uninstall)  
+  - [Android Uninstall Setup](#android-uninstall)  
+  - [iOS Uninstall Setup](#ios-uninstall)  
+- [Send SKAN postback copies](#skanPostback)  
+- [Demo](#demo)  
+  
+  
+##  <a id="init-sdk"> Init SDK  
+  To initialize the AppsFlyer SDK you need to call `initSdk()`. To see a full list of the `options` check our the API doc [here](./API.md#initSdk).   
+      
+Example:  
+      
+      
+```javascript  
+var onSuccess = function(result) {// handle result };  
+  
+function onError(err) {  
+// handle error  
+}  
+  
+var options = {  devKey: 'd3********wL',  
+  appId: '1******9',  
+  isDebug: false,  
+  waitForATTUserAuthorization: 10  
+};  
+  
+window.plugins.appsFlyer.initSdk(options, onSuccess, onError);  
+```  
+  
+##  <a id="ios14"> Set plugin for IOS 14  
+  
+1. Add ```#import <AppTrackingTransparency/AppTrackingTransparency.h>``` in your ```Classes/MainViewController.m``` file<br>  
+2. Add the ATT pop-up for IDFA collection. your ```MainViewController.m``` should look like this:  
+  
+  
+```javascript  
+- (void)viewDidLoad {  
+ [super viewDidLoad]; [self.launchView setAlpha:1];  
+  
+ if @available(iOS 14, *) { [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {  
+ NSLog(@"Status: %lu", (unsigned long)status);  
+ }]; }}  
+```  
+  
+3.Add ```Privacy - Tracking Usage Description``` inside your ```.plist``` file in Xcode.<br>  
+4.For more info visit our Support integration guide [Here](https://support.appsflyer.com/hc/en-us/articles/360011451918#integration)  
+  
+  
+##  <a id="deeplinking"> Deep Linking  
+  ![alt text](https://massets.appsflyer.com/wp-content/uploads/2018/03/21101417/app-installed-Recovered.png "")  
+  
+  
+#### The 3 Deep Linking Types:  
+Since users may or may not have the mobile app installed, there are 2 types of deep linking:  
+  
+1. Deferred Deep Linking - Serving personalized content to new or former users, directly after the installation.   
+2. Direct Deep Linking - Directly serving personalized content to existing users, which already have the mobile app installed.  
+3. Unified deep linking - Unified deep linking sends new and existing users to a specific in-app activity as soon as the app is opened.<br>  
+For more info please check out the [OneLink™ Deep Linking Guide](https://dev.appsflyer.com/docs/initial-setup-for-deep-linking-and-deferred-deep-linking).  
+  
+For more info please check out the [OneLink™ Deep Linking Guide](https://support.appsflyer.com/hc/en-us/articles/208874366-OneLink-Deep-Linking-Guide#Intro).  
+  
+###  <a id="deferred-deep-linking"> 1. Deferred Deep Linking (Get Conversion Data)  
+  
+Check out the deferred deeplinkg guide from the AppFlyer knowledge base [here](https://support.appsflyer.com/hc/en-us/articles/207032096-Accessing-AppsFlyer-Attribution-Conversion-Data-from-the-SDK-Deferred-Deeplinking-#Introduction)  
+  
+Code Sample to handle the conversion data:  
+  
+```javascript  
+function onSuccess(result) {  
+ var conversionData = JSON.parse(result);  
+  
+ if (conversionData.data.is_first_launch === true) {  
+         if(conversionData.data.af_status === 'Non-organic') {  
+             var media_source = conversionData.data.media_source;  
+ var campaign = conversionData.data.campaign;  
+  console.log('This is a Non-Organic install. Media source: ' + media_source + ' Campaign: ' + campaign);  
+         } else if(af_status === 'Organic'){  
+  console.log('Organic Install');  
+ }  
+ } else if (conversionData.data.is_first_launch === false) {  
+ // Not first launch    }  
+}  
+  
+function onError(err) {  
+  console.log(err);  
+}  
+  
+var options = {  devKey:  'K2aMGPY3SkC9WckYUgHJ99',  
+  isDebug: true,  
+  appId: "4166357985",  
+  onInstallConversionDataListener: true  // required for get conversion data };  
+  
+window.plugins.appsFlyer.initSdk(options , onSuccess , onError);  
+```  
+  
+  
+  
+  
+###  <a id="handle-deeplinking"> 2. Direct Deeplinking  
+  In order to implement deeplink with AppsFlyer, you must call `registerOnAppOpenAttribution` **before** `initSdk`<br>  
+For more information on deeplinks, please read [here](https://dev.appsflyer.com/docs/getting-started)  
+  
+  
+  
+  
+```javascript  
+window.plugins.appsFlyer.registerOnAppOpenAttribution(function(res) {  
+  
+  console.log(res);  
+ var deeplinkData = JSON.parse(res);  
+     if(deeplinkData.type === 'onAppOpenAttribution'){         var link = deeplinkData.data.link;  
+  console.log(link);  
+ // redirect here     } else {  
+  console.log('onAppOpenAttribution error');  
+ }}, function onAppOpenAttributionError(err){  
+  console.log(err);  
+});  
+  
+```  
+  
+###  <a id="Unified-deep-linking"> 3. Unified deep linking  
+In order to use the unified deep link you need to send the `onDeepLinkListener: true` flag inside the object that sent to the sdk.<br>  
+**NOTE:** when sending this flag, the sdk will ignore `onAppOpenAttribution`!<br>  
+For more information about this api, please check [OneLink Guide Here](https://dev.appsflyer.com/docs/android-unified-deep-linking)  
+  
+  
+```javascript  
+window.plugins.appsFlyer.registerDeepLink(function(res) {  
+  console.log('AppsFlyer DDL ==> ' + res);  
+  alert('AppsFlyer DDL ==> ' + res);  
+});  
+  
+let options = {  devKey: 'UsxXxXxed',  
+  isDebug: true,  
+  appId: '74xXxXx91',  
+  onInstallConversionDataListener: true,  
+  onDeepLinkListener: true // by default onDeepLinkListener is false!  
+};  
+  
+window.plugins.appsFlyer.initSdk(options, function(res) {  
+  console.log('AppsFlyer GCD ==>' + res);  
+  alert('AppsFlyer GCD ==> ' + res);  
+  
+ }, function(err) {  console.log(`AppsFlyer GCD ==> ${err}`);  
+});  
+```  
+  
+**Note:** The code implementation for `onDeepLink` must be made **prior to the initialization** code of the SDK.  
+  
+###  <a id="android-deeplink"> Android Deeplink Setup  
+       
+ #### URI Scheme  
+Please follow the instructions [here](https://dev.appsflyer.com/docs/initial-setup-for-deep-linking-and-deferred-deep-linking#deciding-on-a-uri-scheme) <br>  
+In your app’s manifest add the following intent-filter to your relevant activity:  
+```xml <intent-filter>  
+ <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:scheme="your unique scheme" /></intent-filter>  
+```  
+  
+  
+#### App Links  
+Please follow the instructions [here](https://dev.appsflyer.com/docs/initial-setup-for-deep-linking-and-deferred-deep-linking#generating-a-sha256-fingerprint) <br>  
+In your app’s manifest add the following intent-filter to your relevant activity:  
+```xml  
+<intent-filter android:autoVerify="true">  
+ <action android:name="android.intent.action.VIEW" />  
+  
+ <category android:name="android.intent.category.DEFAULT" />  
+ <category android:name="android.intent.category.BROWSABLE" />  
+ <data  android:host="onelink-basic-app.onelink.me"  
+  android:pathPrefix="/H5hv"  
+  android:scheme="https" />  
+</intent-filter>  
+```  
+  
+###  <a id="ios-deeplink"> iOS Deeplink Setup  
+#### Starting from V6.3.3   
+ Since **V6.3.3**, the plugin will resolve the deep links automatically. If you are using another plugin for deep linking(like `cordova-plugin-deeplinks`, `ionic-plugin-deeplinks`, etc.) , you’ll need to enable method swizzling.  
+ * To enable method swizzling, please add the [preprocessor macro](https://stackoverflow.com/a/26928784) flag `​AFSDK_SHOULD_SWIZZLE=1`  
+ * To completely disable AppsFlyer deep links implementation, please add the [preprocessor macro](https://stackoverflow.com/a/26928784) flag `​AFSDK_DISABLE_APP_DELEGATE=1`  
+ * Please follow the [URI](#ios-uri) and [Univeral Links](#ios-universal) setup sections **if you choose to disable** the automatically resolving or using older versions.  
+  
+![alt text](https://raw.githubusercontent.com/AppsFlyerSDK/appsflyer-cordova-plugin/releases/6.x.x/6.3.x/6.3.30/resources/PreprocessorMacroExample.png)  
+* You can add the Preprocessor Macro using our [Hooks](/docs/Hooks.md).  
+  
+  
+#### Starting from V6.3.0 up to V6.3.2  
+* Since **V6.3.0**, the plugin will resolve the deep links automatically. (⚠️ Potential conflict with other deep linking plugins ⚠️)  
+  
+  
+#### Below V6.3.0 * Please follow the [URI](#ios-uri) and [Univeral Links](#ios-universal) setup sections.  
+#### <a id="ios-uri"> URI Scheme  
+  
+For more on URI-schemes check out the guide [here](https://dev.appsflyer.com/docs/initial-setup-2#deciding-on-a-uri-scheme)  
+  
+Add the following lines to your code to be able to track deeplinks with AppsFlyer attribution data:  
+  
+for pure Cordova - add a function 'handleOpenUrl' to your root, and call our SDK as shown:  
+```javascript  
+window.plugins.appsFlyer.handleOpenUrl(url);  
+```  
+It appears as follows:  
+  
+```javascript  
+var handleOpenURL = function(url) {window.plugins.appsFlyer.handleOpenUrl(url);  
+}  
+```  
+Now you will get deep link information in the onAppOpenAttribution callback  
+  
+#### <a id="ios-universal"> If you are using Ionic+Capacitor or Ionic+Cordova:<br>  
+##### import:<br>  
+`#import "AppsFlyerPlugin.h"` to `AppDelegate.m`   
+For plugin version **6.1.30** and less:  
+  
+`#import "AppsFlyerLib.h"` to `AppDelegate.m`  
+  
+In both cases, you need to add this code before the `@end` tag:<br>  
+```  
+// Deep linking  
+// Open URI-scheme for iOS 9 and above  
+- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary *) options {  
+ // version >= 6.2.30 [[AppsFlyerAttribution shared] handleOpenUrl:url options:options];  
+ // version < 6.2.30    [[AppsFlyerLib shared] handleOpenUrl:url options:options];  
+ return YES;}  
+// Open URI-scheme for iOS 8 and below  
+- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString*)sourceApplication annotation:(id)annotation {  
+ // version >= 6.2.30 [[AppsFlyerAttribution shared] handleOpenUrl:url sourceApplication:sourceApplication annotation:annotation];  
+ // version < 6.2.30 [[AppsFlyerLib shared] handleOpenUrl:url sourceApplication:sourceApplication withAnnotation:annotation]; return YES;}  
+// Open Universal Links  
+- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler {  
+ // version >= 6.2.30 [[AppsFlyerAttribution shared] continueUserActivity:userActivity restorationHandler:restorationHandler];      
+    //version < 6.2.30  
+ [[AppsFlyerLib shared] continueUserActivity:userActivity restorationHandler:restorationHandler]; return YES;}  
+```  
+  
+  
+### Universal Links  
+  For more on Universal Links check out the guide [here](https://support.appsflyer.com/hc/en-us/articles/208874366-OneLink-Deep-Linking-Guide#setups-universal-links).  
+      
+Essentially, the Universal Links method links between an iOS mobile app and an associate website/domain, such as AppsFlyer’s OneLink domain (xxx.onelink.me). To do so, it is required to:  
+  
+1. Configure OneLink sub-domain and link to mobile app (by hosting the ‘apple-app-site-association’ file - AppsFlyer takes care of this part in the onelink setup on your dashboard)  
+2. Configure the mobile app to register approved domains:  
+  
+```xml  
+<?xml version="1.0" encoding="UTF-8"?>  
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">  
+<plist version="1.0">  
+ <dict> <key>com.apple.developer.associated-domains</key> <array> <string>applinks:test.onelink.me</string> </array> </dict></plist>  
+```  
+  
+##  <a id="uninstall"> Uninstall Measurement  
+  
+###  <a id="android-uninstall"> Android Uninstall Setup  
+  There are 2 main approaches of enabling uninstall measurement for Android:  
+  
+1. Use FirebaseMessagingService from AppsFlyer SDK - only needs change to AndroidManifest  
+2. Manually pass token to SDK - should be used if you have custom logic in place when token us updated.  
+  
+For more info on Android Uninstall setup check out the guide [here](https://support.appsflyer.com/hc/en-us/articles/210289286-Uninstall-Measurement#android-uninstall-android-uninstall-measurement).     
+  
+In JavaScript level a third party plugin is required to fetch the token and pass it to AppsFlyer. <br>  
+  
+A known plugin is [cordova-plugin-firebase-messaging](https://github.com/chemerisuk/cordova-plugin-firebase-messaging).  
+  
+Set-up Steps:<br>  
+1. Add the plugin -  `cordova plugin add cordova-plugin-firebase-messaging --save`<br>  
+Plugin depends on cordova-support-google-services for setting up google services properly. Please read the plugin documentation carefully in order to avoid common issues with a project configuration.  
+2. Send the token to AppsFlyer by calling `updateServerUninstallToken`.<br>  
+  
+```javascript  
+window.plugins.appsFlyer.initSdk(options , onSuccess , onError);  
+cordova.plugins.firebase.messaging.onTokenRefresh(function() {  
+  console.log("Device token updated");  
+ cordova.plugins.firebase.messaging.getToken().then(function(token) {  
+  window.plugins.appsFlyer.updateServerUninstallToken(token);  
+ });})  
+  ```  
+  
+###  <a id="ios-uninstall"> iOS Uninstall Setup  
+  ##### Option 1 - Send the token as NSData to AppsFlyer natively  
+  
+Code sample for Classes/AppDelegate.m:  
+  
+```objectivec  
+#import "AppDelegate.h"  
+#import "MainViewController.h"  
+#import "AppsFlyerPlugin.h"  
+  
+@implementation AppDelegate  
+  
+- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions  
+{  
+ UIUserNotificationType userNotificationTypes = (UIUserNotificationTypeAlert | UIUserNotificationTypeBadge | UIUserNotificationTypeSound); UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:userNotificationTypes categories:nil]; [application registerUserNotificationSettings:settings]; [application registerForRemoteNotifications];     self.viewController = [[MainViewController alloc] init];  
+ return [super application:application didFinishLaunchingWithOptions:launchOptions];}  
+  
+- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {  
+ [[AppsFlyerTracker sharedTracker] registerUninstall:deviceToken];}  
+  
+  
+@end  
+```      
+ ##### Option 2 - Pass the token as a String to AppsFlyer in the js code  
+  
+Note : If you use this method you will need to collect the APNs token using a third party platform of your choice.   
+  
+```javascript  
+window.plugins.appsFlyer.registerUninstall("<token>");  
+```  
+  
+  
+  
+## <a id="skanPostback"> Send SKAN postback copies directly to AppsFlyer (iOS 15+)  
+*At a glance:* Starting iOS 15, configure your app to send postback copies to AppsFlyer in addition to sending them to ad networks. Doing so enables AppsFlyer to validate the conversion value (CV) and verify postback integrity. Configure AppsFlyer Push API to forward postback copies to an additional selected endpoint.  
+  
+Related reading: [Apple developer](https://developer.apple.com/documentation/storekit/skadnetwork/configuring_an_advertised_app?changes=latest_minor#see-also)   
+  
+  For more info check out the guide [here](https://support.appsflyer.com/hc/en-us/articles/4402320969617).     
 
-<img src="https://massets.appsflyer.com/wp-content/uploads/2016/06/26122512/banner-img-ziv.png"  width="300">
+**To register the AppsFlyer endpoint:**
 
-## Table of content
-
-- [Init SDK](#init-sdk)
-- [Set plugin for IOS 14](#ios14)
-- [DeepLinking](#deeplinking)
-    - [Deferred Deep Linking (Get Conversion Data)](#deferred-deep-linking)
-    - [Direct Deeplinking](#handle-deeplinking)
-    - [Unified Deeplinking](#Unified-deep-linking)
-    - [Android Deeplink Setup](#android-deeplink)
-    - [iOS Deeplink Setup](#ios-deeplink)
-- [Uninstall](#uninstall)
-    - [Android Uninstall Setup](#android-uninstall)
-    - [iOS Uninstall Setup](#ios-uninstall)
-- [Demo](#demo)
-
-
-##  <a id="init-sdk"> Init SDK
-    
-To initialize the AppsFlyer SDK you need to call `initSdk()`. To see a full list of the `options` check our the API doc [here](./API.md#initSdk). 
-    
-Example:
-    
-    
-```javascript
-var onSuccess = function(result) {
-// handle result  
-};
-
-function onError(err) {
-// handle error
-}
-
-var options = {
-    devKey: 'd3********wL',
-    appId: '1******9',
-    isDebug: false,
-    waitForATTUserAuthorization: 10
-};
-
-window.plugins.appsFlyer.initSdk(options, onSuccess, onError);
-```
-
-##  <a id="ios14"> Set plugin for IOS 14
-
-1. Add ```#import <AppTrackingTransparency/AppTrackingTransparency.h>``` in your ```Classes/MainViewController.m``` file<br>
-2. Add the ATT pop-up for IDFA collection. your ```MainViewController.m``` should look like this:
-
-
-```javascript
-- (void)viewDidLoad {
-    [super viewDidLoad];
-    [self.launchView setAlpha:1];
-
-    if @available(iOS 14, *) {
-      [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
-        NSLog(@"Status: %lu", (unsigned long)status);
-      }];
-    }
-}
-```
-
-3.Add ```Privacy - Tracking Usage Description``` inside your ```.plist``` file in Xcode.<br>
-4.For more info visit our Support integration guide [Here](https://support.appsflyer.com/hc/en-us/articles/360011451918#integration)
-
-
-##  <a id="deeplinking"> Deep Linking
-    
-![alt text](https://massets.appsflyer.com/wp-content/uploads/2018/03/21101417/app-installed-Recovered.png "")
-
-
-#### The 3 Deep Linking Types:
-Since users may or may not have the mobile app installed, there are 2 types of deep linking:
-
-1. Deferred Deep Linking - Serving personalized content to new or former users, directly after the installation. 
-2. Direct Deep Linking - Directly serving personalized content to existing users, which already have the mobile app installed.
-3. Unified deep linking - Unified deep linking sends new and existing users to a specific in-app activity as soon as the app is opened.<br>
-For more info please check out the [OneLink™ Deep Linking Guide](https://dev.appsflyer.com/docs/initial-setup-for-deep-linking-and-deferred-deep-linking).
-
-For more info please check out the [OneLink™ Deep Linking Guide](https://support.appsflyer.com/hc/en-us/articles/208874366-OneLink-Deep-Linking-Guide#Intro).
-
-###  <a id="deferred-deep-linking"> 1. Deferred Deep Linking (Get Conversion Data)
-
-Check out the deferred deeplinkg guide from the AppFlyer knowledge base [here](https://support.appsflyer.com/hc/en-us/articles/207032096-Accessing-AppsFlyer-Attribution-Conversion-Data-from-the-SDK-Deferred-Deeplinking-#Introduction)
-
-Code Sample to handle the conversion data:
-
-```javascript
-function onSuccess(result) {
-    var conversionData = JSON.parse(result);
-
-    if (conversionData.data.is_first_launch === true) {
-    
-        if(conversionData.data.af_status === 'Non-organic') {
-        
-            var media_source = conversionData.data.media_source;
-            var campaign = conversionData.data.campaign;
-            
-            console.log('This is a Non-Organic install. Media source: ' + media_source + ' Campaign: ' + campaign);
-            
-        } else if(af_status === 'Organic'){
-            console.log('Organic Install');
-        }
-
-    } else if (conversionData.data.is_first_launch === false) {
-        // Not first launch 
-    }
-}
-
-function onError(err) {
-    console.log(err);
-}
-
-var options = {
-    devKey:  'K2aMGPY3SkC9WckYUgHJ99',
-    isDebug: true,
-    appId: "4166357985",
-    onInstallConversionDataListener: true  // required for get conversion data             
-};
-
-window.plugins.appsFlyer.initSdk(options , onSuccess , onError);
-```
-
-
-
-
-###  <a id="handle-deeplinking"> 2. Direct Deeplinking
-    
-In order to implement deeplink with AppsFlyer, you must call `registerOnAppOpenAttribution` **before** `initSdk`<br>
-For more information on deeplinks, please read [here](https://dev.appsflyer.com/docs/getting-started)
-
-
-
-
-```javascript
-window.plugins.appsFlyer.registerOnAppOpenAttribution(function(res) {
-
-    console.log(res);
-    var deeplinkData = JSON.parse(res);
-    
-    if(deeplinkData.type === 'onAppOpenAttribution'){
-    
-        var link = deeplinkData.data.link;
-        console.log(link);
-        // redirect here
-        
-    } else {
-        console.log('onAppOpenAttribution error');
-    }
-}, 
-function onAppOpenAttributionError(err){
-    console.log(err);
-});
-
-```
-
-###  <a id="Unified-deep-linking"> 3. Unified deep linking
-In order to use the unified deep link you need to send the `onDeepLinkListener: true` flag inside the object that sent to the sdk.<br>
-**NOTE:** when sending this flag, the sdk will ignore `onAppOpenAttribution`!<br>
-For more information about this api, please check [OneLink Guide Here](https://dev.appsflyer.com/docs/android-unified-deep-linking)
-
-
-```javascript
-window.plugins.appsFlyer.registerDeepLink(function(res) {
-    console.log('AppsFlyer DDL ==> ' + res);
-    alert('AppsFlyer DDL ==> ' + res);
-});
-
-let options = {
-    devKey: 'UsxXxXxed',
-    isDebug: true,
-    appId: '74xXxXx91',
-    onInstallConversionDataListener: true,
-    onDeepLinkListener: true // by default onDeepLinkListener is false!
-};
-
-window.plugins.appsFlyer.initSdk(options, function(res) {
-    console.log('AppsFlyer GCD ==>' + res);
-    alert('AppsFlyer GCD ==> ' + res);
-
-    }, function(err) {
-    console.log(`AppsFlyer GCD ==> ${err}`);
-});
-```
-
-**Note:** The code implementation for `onDeepLink` must be made **prior to the initialization** code of the SDK.
-
-###  <a id="android-deeplink"> Android Deeplink Setup
-    
-    
-    
-#### URI Scheme
-Please follow the instructions [here](https://dev.appsflyer.com/docs/initial-setup-for-deep-linking-and-deferred-deep-linking#deciding-on-a-uri-scheme) <br>
-In your app’s manifest add the following intent-filter to your relevant activity:
-```xml 
-<intent-filter>
-    <action android:name="android.intent.action.VIEW" />
-    <category android:name="android.intent.category.DEFAULT" />
-    <category android:name="android.intent.category.BROWSABLE" />
-    <data android:scheme="your unique scheme" />
-</intent-filter>
-```
-
-
-#### App Links
-Please follow the instructions [here](https://dev.appsflyer.com/docs/initial-setup-for-deep-linking-and-deferred-deep-linking#generating-a-sha256-fingerprint) <br>
-In your app’s manifest add the following intent-filter to your relevant activity:
+1. Open your project's `config.xml` in file.
+2. Paste the following snippet inside the `widget` element. 
 ```xml
-<intent-filter android:autoVerify="true">
-    <action android:name="android.intent.action.VIEW" />
-
-    <category android:name="android.intent.category.DEFAULT" />
-    <category android:name="android.intent.category.BROWSABLE" />
-    <data
-        android:host="onelink-basic-app.onelink.me"
-        android:pathPrefix="/H5hv"
-        android:scheme="https" />
-</intent-filter>
+    <config-file platform="ios" target="*-Info.plist" parent="NSAdvertisingAttributionReportEndpoint">
+        <string>https://appsflyer-skadnetwork.com/</string>
+    </config-file>
 ```
-
-###  <a id="ios-deeplink"> iOS Deeplink Setup
-#### Starting from V6.3.3 
- Since **V6.3.3**, the plugin will resolve the deep links automatically. If you are using another plugin for deep linking(like `cordova-plugin-deeplinks`, `ionic-plugin-deeplinks`, etc.) , you’ll need to enable method swizzling.
- * To enable method swizzling, please add the [preprocessor macro](https://stackoverflow.com/a/26928784) flag `​AFSDK_SHOULD_SWIZZLE=1`
- * To completely disable AppsFlyer deep links implementation, please add the [preprocessor macro](https://stackoverflow.com/a/26928784) flag `​AFSDK_DISABLE_APP_DELEGATE=1`
- * Please follow the [URI](#ios-uri) and [Univeral Links](#ios-universal) setup sections **if you choose to disable** the automatically resolving or using older versions.
-
-![alt text](https://raw.githubusercontent.com/AppsFlyerSDK/appsflyer-cordova-plugin/releases/6.x.x/6.3.x/6.3.30/resources/PreprocessorMacroExample.png)
-* You can add the Preprocessor Macro using our [Hooks](/docs/Hooks.md).
-
-
-#### Starting from V6.3.0 up to V6.3.2
-* Since **V6.3.0**, the plugin will resolve the deep links automatically. (⚠️   Potential conflict with other deep linking plugins ⚠️)
-
-
-#### Below V6.3.0 
-* Please follow the [URI](#ios-uri) and [Univeral Links](#ios-universal) setup sections.
-#### <a id="ios-uri"> URI Scheme
-
-For more on URI-schemes check out the guide [here](https://dev.appsflyer.com/docs/initial-setup-2#deciding-on-a-uri-scheme)
-
-Add the following lines to your code to be able to track deeplinks with AppsFlyer attribution data:
-
-for pure Cordova - add a function 'handleOpenUrl' to your root, and call our SDK as shown:
-```javascript
-window.plugins.appsFlyer.handleOpenUrl(url);
-```
-It appears as follows:
-
-```javascript
-var handleOpenURL = function(url) {
-window.plugins.appsFlyer.handleOpenUrl(url);
-}
-```
-Now you will get deep link information in the onAppOpenAttribution callback
-
-#### <a id="ios-universal"> If you are using Ionic+Capacitor or Ionic+Cordova:<br>
-##### import:<br>
-`#import "AppsFlyerPlugin.h"` to `AppDelegate.m` 
-
-For plugin version **6.1.30** and less:
-
-`#import "AppsFlyerLib.h"` to `AppDelegate.m`
-
-In both cases, you need to add this code before the `@end` tag:<br>
-```
-// Deep linking
-// Open URI-scheme for iOS 9 and above
-- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary *) options {
-    // version >= 6.2.30
-    [[AppsFlyerAttribution shared] handleOpenUrl:url options:options];
-
-    // version < 6.2.30    
-    [[AppsFlyerLib shared] handleOpenUrl:url options:options];
-    return YES;
-}
-// Open URI-scheme for iOS 8 and below
-- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString*)sourceApplication annotation:(id)annotation {
-    // version >= 6.2.30
-    [[AppsFlyerAttribution shared] handleOpenUrl:url sourceApplication:sourceApplication annotation:annotation];
-
-    // version < 6.2.30
-    [[AppsFlyerLib shared] handleOpenUrl:url sourceApplication:sourceApplication withAnnotation:annotation];
-    return YES;
-}
-// Open Universal Links
-- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler {
-    // version >= 6.2.30
-    [[AppsFlyerAttribution shared] continueUserActivity:userActivity restorationHandler:restorationHandler];    
-    
-    //version < 6.2.30
-    [[AppsFlyerLib shared] continueUserActivity:userActivity restorationHandler:restorationHandler];
-    return YES;
-}
-```
-
-
-### Universal Links
-    
-For more on Universal Links check out the guide [here](https://support.appsflyer.com/hc/en-us/articles/208874366-OneLink-Deep-Linking-Guide#setups-universal-links).
-    
-Essentially, the Universal Links method links between an iOS mobile app and an associate website/domain, such as AppsFlyer’s OneLink domain (xxx.onelink.me). To do so, it is required to:
-
-1. Configure OneLink sub-domain and link to mobile app (by hosting the ‘apple-app-site-association’ file - AppsFlyer takes care of this part in the onelink setup on your dashboard)
-2. Configure the mobile app to register approved domains:
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-    <dict>
-        <key>com.apple.developer.associated-domains</key>
-        <array>
-            <string>applinks:test.onelink.me</string>
-        </array>
-    </dict>
-</plist>
-```
-
-##  <a id="uninstall"> Uninstall Measurement
-
-###  <a id="android-uninstall"> Android Uninstall Setup
-    
-There are 2 main approaches of enabling uninstall measurement for Android:
-
-1. Use FirebaseMessagingService from AppsFlyer SDK - only needs change to AndroidManifest
-2. Manually pass token to SDK - should be used if you have custom logic in place when token us updated.
-
-For more info on Android Uninstall setup check out the guide [here](https://support.appsflyer.com/hc/en-us/articles/210289286-Uninstall-Measurement#android-uninstall-android-uninstall-measurement).   
-
-In JavaScript level a third party plugin is required to fetch the token and pass it to AppsFlyer. <br>
-
-A known plugin is [cordova-plugin-firebase-messaging](https://github.com/chemerisuk/cordova-plugin-firebase-messaging).
-
-Set-up Steps:<br>
-1. Add the plugin -  `cordova plugin add cordova-plugin-firebase-messaging --save`<br>
-Plugin depends on cordova-support-google-services for setting up google services properly. Please read the plugin documentation carefully in order to avoid common issues with a project configuration.
-2. Send the token to AppsFlyer by calling `updateServerUninstallToken`.<br>
-
-```javascript
-window.plugins.appsFlyer.initSdk(options , onSuccess , onError);
-
-cordova.plugins.firebase.messaging.onTokenRefresh(function() {
-    console.log("Device token updated");
-    cordova.plugins.firebase.messaging.getToken().then(function(token) {
-        window.plugins.appsFlyer.updateServerUninstallToken(token);
-    });
-})
-   
-```
-
-###  <a id="ios-uninstall"> iOS Uninstall Setup
-    
-##### Option 1 - Send the token as NSData to AppsFlyer natively
-
-Code sample for Classes/AppDelegate.m:
-
-```objectivec
-#import "AppDelegate.h"
-#import "MainViewController.h"
-#import "AppsFlyerPlugin.h"
-
-@implementation AppDelegate
-
-- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions
-{
-    UIUserNotificationType userNotificationTypes = (UIUserNotificationTypeAlert |
-                                                    UIUserNotificationTypeBadge |
-                                                    UIUserNotificationTypeSound);
-    UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:userNotificationTypes
-                                                                             categories:nil];
-    [application registerUserNotificationSettings:settings];
-    [application registerForRemoteNotifications];
-    
-    self.viewController = [[MainViewController alloc] init];
-    return [super application:application didFinishLaunchingWithOptions:launchOptions];
-}
-
-- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
-    [[AppsFlyerTracker sharedTracker] registerUninstall:deviceToken];
-}
-
-
-@end
-```    
-    
-##### Option 2 - Pass the token as a String to AppsFlyer in the js code
-
-Note : If you use this method you will need to collect the APNs token using a third party platform of your choice. 
-
-```javascript
-window.plugins.appsFlyer.registerUninstall("<token>");
-```
-
-
-##  <a id="demo"> Demo
-
-
-This plugin has an `examples` folder with `cordova` (pure Cordova (javascript))  and `ionic-cordova` (ionic) projects bundled with it. To give it a try , clone this repo and from root a.e. `cordova-plugin-appsflyer-sdk` execute the following:
-
-For Cordova:
-```sh
-npm run setupCordova 
-```
--  `npm run runCordovaIos` - run iOS
--  `npm run runCordovaAndroid` - run Android
-
-For Ionic-Cordova:
-```sh
-npm run setupIonicCordova
-```
--  `npm run runIonicCordovaIos` - run iOS
--  `npm run runIonicCordovaAndroid` - run Android
+  3. The element will be added to the `plist` file after the command `cordova prepare ios`.
+  
+##  <a id="demo"> Demo  
+  
+  
+This plugin has an `examples` folder with `cordova` (pure Cordova (javascript))  and `ionic-cordova` (ionic) projects bundled with it. To give it a try , clone this repo and from root a.e. `cordova-plugin-appsflyer-sdk` execute the following:  
+  
+For Cordova:  
+```sh  
+npm run setupCordova ```  
+- `npm run runCordovaIos` - run iOS  
+- `npm run runCordovaAndroid` - run Android  
+  
+For Ionic-Cordova:  
+```sh  
+npm run setupIonicCordova  
+```  
+- `npm run runIonicCordovaIos` - run iOS  
+- `npm run runIonicCordovaAndroid` - run Android

examples/cordova/package.json

@@ -16,5 +16,6 @@ {
   "devDependencies": {
-    "cordova-android": "^9.0.0",
+    "cordova-android": "^10.1.2",
     "cordova-ios": "^6.2.0",
-    "cordova-plugin-whitelist": "^1.3.4"
+    "cordova-plugin-androidx-adapter": "^1.1.3",
+    "cordova-plugin-whitelist": "^1.3.5"
   },
@@ -31,2 +32,2 @@ "cordova": {
   "dependencies": {}
-}
+}

package.json

 {
   "name": "cordova-plugin-appsflyer-sdk",
-  "version": "6.5.2",
+  "version": "6.8.0-rc1",
   "description": "Cordova AppsFlyer SDK Plugin",
@@ -5,0 +5,0 @@ "cordova": {

README.md

@@ -44,4 +44,4 @@
   
-- iOS AppsFlyerSDK **v6.5.2**  
-- Android AppsFlyerSDK **v6.5.2**  
+- iOS AppsFlyerSDK **v6.8.0**  
+- Android AppsFlyerSDK **v6.8.0**  
   
@@ -66,7 +66,16 @@ ### <a id="breakingChanges"> ❗v6 Breaking Changes
 ```  
-  
 To install cordova manually check out the doc [here](/docs/Installation.md).  
   
 > **_NOTE:_** for Ionic installation see [this](#ionic) section  
+
   
+## ⚠️ Adding AD_ID permission for Android ⚠️
+In v6.8.0 of the AppsFlyer SDK, we added the normal permission `com.google.android.gms.permission.AD_ID` to the SDK's AndroidManifest, 
+to allow the SDK to collect the Android Advertising ID on apps targeting API 33.
+If your app is targeting children, you need to revoke this permission to comply with Google's Data policy.
+You can read more about it [here](https://dev.appsflyer.com/hc/docs/install-android-sdk#the-ad_id-permission). </br>
+
+
+
+  
 ## <a id="appKids">👨‍👩‍👧‍👦 Add or Remove Strict mode for App-kids  
@@ -105,2 +114,3 @@ Starting from version **6.1.10** iOS SDK comes in two variants: **Strict** mode and **Regular** mode. Please read more [here](https://support.appsflyer.com/hc/en-us/articles/207032066#integration-strict-mode-sdk)
 - [Set plugin for IOS 14](/docs/Guides.md#ios14)  
+- [Send SKAN postback copies for IOS 15](/docs/Guides.md#skanPostback)  
   
@@ -146,4 +156,3 @@
   
-In case you are using Ionic framework, you have 2 options:  
-###  1. Using the `window` object directly  
+###  Using the `window` object directly  
 Install the cordova plugin:  
@@ -171,54 +180,3 @@ ```
   
-### 2 - Using Ionic native plugin  
-####  Ionic 4  and 5
-run this commands:  
-**With Cordova**:  
-```  
-$ ionic cordova plugin add cordova-plugin-appsflyer-sdk  
-$ npm install @ionic-native/appsflyer  
-```  
-**With Capacitor**:  
-* Please see [this note](#capacitornote)
-```  
-$ 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';  
-```  
+
 Check out the full [API](/docs/API.md) for more information

www/appsflyer.js

@@ -376,3 +376,20 @@ var exec = require('cordova/exec'),
 
+    /**
+     * Measure and get data from push-notification campaigns.
+     * @param pushData - JSON object contains the push data
+     */
+    AppsFlyer.prototype.sendPushNotificationData = function (pushData){
+        exec(null, null, 'AppsFlyerPlugin', 'sendPushNotificationData', [pushData]);
+    };
+
+    /**
+     * Use to opt-out of collecting the network operator name (carrier) and sim operator name from the device.
+     * @param disable - Defaults to false
+     */
+    AppsFlyer.prototype.setDisableNetworkData = function (disable){
+        exec(null, null, 'AppsFlyerPlugin', 'setDisableNetworkData', [disable]);
+    };
+
+
     module.exports = new AppsFlyer();
 })(window);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of package files

164

increased by1.23%

Lines of code

1736

increased by0.81%

Worsened metrics

Total package byte prevSize

3118333

decreased by-0.54%

Number of medium maintenance alerts

1

increased byInfinity%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

178

decreased by-19.09%

No dependency changes