cordova-plugin-appsflyer-sdk
Advanced tools
Comparing version 6.2.0 to 6.2.10
@@ -18,2 +18,3 @@ # API | ||
| [`registerOnAppOpenAttribution`](#registerOnAppOpenAttribution) | `(function success, function error)` | Get the deeplink data | | ||
| [`registerDeepLink`](#registerDeepLink) | `(function callBack)` | Get unified deep link data | | ||
| [`setCurrencyCode`](#setCurrencyCode) | `(String currencyId)` | Set currency code | | ||
@@ -208,23 +209,26 @@ | [`setAppUserId`](#setAppUserId) | `(String customerUserId)` | Set custom_user_id | | ||
window.plugins.appsFlyer.registerOnAppOpenAttribution(function(res) { | ||
console.log('AppsFlyer OAOA ==> ' + res); | ||
alert('AppsFlyer OAOA ==> ' + res); | ||
}, | ||
function onAppOpenAttributionError(err) { | ||
console.log(err); | ||
}); | ||
{ | ||
"data": { | ||
"af_deeplink": "true", | ||
"campaign": "boo", | ||
"key": "val", | ||
"media_source": "someMedia", | ||
"install_time": "2018-07-12 13:20:19", | ||
"af_status": "Non-organic", | ||
"path": "", | ||
"scheme": "https", | ||
"host": "ionic.fess.onelink.me" | ||
}, | ||
"type": "onAppOpenAttribution", | ||
"status": "success" | ||
} | ||
}, | ||
function onAppOpenAttributionError(err){ | ||
// ... | ||
``` | ||
--- | ||
##### <a id="registerDeepLink"> **`registerDeepLink(callBack): void`** | ||
**Note:** most be called before `initSdk()` and it overrides `registerOnAppOpenAttribution`. | ||
| parameter | type | description | | ||
| ----------- |-----------------------------|--------------| | ||
| `callBack` | `(message: stringifed JSON)=>void` | function called after receiving dep link data| | ||
*Example:* | ||
```javascript | ||
window.plugins.appsFlyer.registerDeepLink(function(res) { | ||
console.log('AppsFlyer DDL ==> ' + res); | ||
alert('AppsFlyer DDL ==> ' + res); | ||
}); | ||
``` | ||
@@ -231,0 +235,0 @@ --- |
@@ -12,2 +12,3 @@ # Cordova Appsflyer Plugin Guides | ||
- [Direct Deeplinking](#handle-deeplinking) | ||
- [Unified Deeplinking](#Unified-deep-linking) | ||
- [Android Deeplink Setup](#android-deeplink) | ||
@@ -75,3 +76,3 @@ - [iOS Deeplink Setup](#ios-deeplink) | ||
#### The 2 Deep Linking Types: | ||
#### The 3 Deep Linking Types: | ||
Since users may or may not have the mobile app installed, there are 2 types of deep linking: | ||
@@ -81,2 +82,4 @@ | ||
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). | ||
@@ -160,3 +163,33 @@ 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="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 | ||
@@ -222,3 +255,5 @@ | ||
} | ||
[[AppsFlyerLib shared] setDelegate:_AppsFlyerdelegate]; | ||
[[AppsFlyerLib shared] setDelegate:_AppsFlyerdelegate]; //if you want to use onAppOpenAttribution listener (registerOnAppOpenAttribution()) | ||
//OR | ||
[[AppsFlyerLib shared] setDeepLinkDelegate:_AppsFlyerdelegate]; //if you want to use DDL listener (registerDeepLink()) | ||
``` | ||
@@ -225,0 +260,0 @@ And `#import "AppsFlyerPlugin.h"` to `AppDelegate.m` |
# Release Notes | ||
### 6.2.10 | ||
Release date **January 27, 2021** | ||
Release type: Major / **Minor** / Hotfix | ||
**Overview and Highlights:** | ||
- Add Unified DDL | ||
### 6.2.0 | ||
@@ -3,0 +11,0 @@ Release date **January 17, 2021** |
{ | ||
"name": "cordova-plugin-appsflyer-sdk", | ||
"version": "6.2.0", | ||
"version": "6.2.10", | ||
"description": "Cordova AppsFlyer SDK Plugin", | ||
@@ -5,0 +5,0 @@ "cordova": { |
@@ -62,2 +62,11 @@ var exec = require('cordova/exec'), | ||
/** | ||
* Register Unified deep link listener | ||
* @param onDeepLinkListener: ddl callback triggered when deep linked has been clicked and onDeepLinkListener = true; | ||
*/ | ||
AppsFlyer.prototype.registerDeepLink = function (onDeepLinkListener) { | ||
callbackMap.ddlSuc = onDeepLinkListener; | ||
exec(onDeepLinkListener, null, 'AppsFlyerPlugin', 'registerDeepLink', []); | ||
}; | ||
/** | ||
* currencyId: ISO 4217 Currency Codes | ||
@@ -64,0 +73,0 @@ */ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
272201
778