Socket
Book a DemoInstallSign in
Socket

cordova-plugin-appsflyer-sdk

Package Overview
Dependencies
Maintainers
8
Versions
132
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

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

Comparing version

to
6.16.2-rc1

Cordova SDK v6.16.2-releasenotes.txt

105

docs/API.md

@@ -13,46 +13,46 @@ # API

| method name | params | description |
|-----------------------------------------------------------------------|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| [`initSdk`](#initSdk) | `(Object args, function success, function error)` | Initialize the SDK |
| [`startSdk`](#startSdk) | `()` | Starts the SDK - Must call initSdk first in order to make this work |
| [`logEvent`](#trackEvent) | `(String eventName, Object eventValue, function success, function error)` | Track rich in-app events |
| [`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 |
| [`setAppUserId`](#setAppUserId) | `(String customerUserId)` | Set custom_user_id |
| [`setGCMProjectNumber`](#initSdk) | `(String gcmProjectNumber)` | |
| [`getAppsFlyerUID`](#getAppsFlyerUID) | `(function success)` | Get AppsFlyer’s proprietary Device ID |
| [`anonymizeUser`](#deviceTrackingDisabled) | `(Boolean isDisabled)` | Anonymize user data |
| [`Stop`](#stopTracking) | `(Boolean isStopTracking)` | Shut down all SDK tracking |
| [`updateServerUninstallToken`](#updateServerUninstallToken) | `(String token)` | (Android) Pass GCM/FCM Tokens |
| [`registerUninstall`](#registerUninstall) | `(String token)` | (iOS) Pass APNs Tokens |
| [`setAppInviteOneLinkID`](#setAppInviteOneLinkID) | `(Object args)` | Set AppsFlyer’s OneLink ID |
| [`generateInviteLink`](#generateInviteLink) | `(Object args, function success, function error)` | Error callback |
| [`logCrossPromotionImpression`](#trackCrossPromotionImpression) | `(String appId, String campaign)` | Track cross promotion impression |
| [`logCrossPromotionAndOpenStore`](#trackAndOpenStore) | `(String appId, String campaign, Object params)` | Launch the app store's app page (via Browser) |
| [`handleOpenUrl`](#deep-linking-tracking) | `(String url)` | |
| [`getSdkVersion`](#getSdkVersion) | `((function success)` | Get the current SDK version |
| [`setSharingFilterForAllPartners`](#setSharingFilterForAllPartners) | | Used by advertisers to exclude all networks/integrated partners from getting data |
| [`setSharingFilter`](#setSharingFilter) | `(partners)` | Used by advertisers to exclude specified networks/integrated partners from getting data |
| [`setSharingFilterForPartners`](#setSharingFilterForPartners) | `(partners)` | Used by advertisers to exclude specified networks/integrated partners from getting data |
| [`validateAndLogInAppPurchase`](#validateAndLogInAppPurchase) | `(Object purchaseInfo, function success, function error)` | API for server verification of in-app purchases |
| [`setUseReceiptValidationSandbox`](#setUseReceiptValidationSandbox) | `(boolean isSandbox, function success, function error)` | In app purchase receipt validation Apple environment |
| [`disableCollectASA`](#disableCollectASA) | `(boolean collectASA, function success)` | **iOS** - set the SDK to load OR not to load iAd.framework dynamically |
| [`setDisableAdvertisingIdentifier`](#setDisableAdvertisingIdentifier) | `(boolean disableAdvertisingIdentifier, function success)` | Disable collection of Apple, Google, Amazon and Open advertising ids (IDFA, GAID, AAID, OAID). |
| [`setOneLinkCustomDomains`](#setOneLinkCustomDomains) | `(domains, function success, function error)` | Set Onelink custom/branded domains |
| [`enableFacebookDeferredApplinks`](#enableFacebookDeferredApplinks) | `(boolean isEnabled)` | support deferred deep linking from Facebook Ads |
| [`setUserEmails`](#setUserEmails) | `(emails, function success)` | Set user emails for FB Advanced Matching |
| [`setPhoneNumber`](#setPhoneNumber) | `(String phoneNumber, function success)` | Set phone number for FB Advanced Matching |
| [`setHost`](#setHost) | `(String hostPrefix, String hostName)` | Set custom host prefix and host name |
| [`addPushNotificationDeepLinkPath`](#addPushNotificationDeepLinkPath) | `(path)` | configure push notification deep link resolution |
| [`setResolveDeepLinkURLs`](#setResolveDeepLinkURLs) | `(urls)` | get the OneLink from click domains |
| [`disableSKAD`](#disableSKAD) | `(boolean disableSkad)` | disable or enable SKAD |
| [`setCurrentDeviceLanguage`](#setCurrentDeviceLanguage) | `(string language)` | Set the language of the device. |
| [`setAdditionalData`](#setAdditionalData) | `(Object additionalData)` | Allows you to add custom data to events sent from the SDK. |
| [`setPartnerData`](#setPartnerData) | `(partnerId, data)` | Allows sending custom data for partner integration purposes. |
| [`sendPushNotificationData`](#sendPushNotificationData) | `(Object data)` | Measure and get data from push-notification campaigns. |
| method name | params | description |
|-----------------------------------------------------------------------|---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| [`initSdk`](#initSdk) | `(Object args, function success, function error)` | Initialize the SDK |
| [`startSdk`](#startSdk) | `()` | Starts the SDK - Must call initSdk first in order to make this work |
| [`logEvent`](#trackEvent) | `(String eventName, Object eventValue, function success, function error)` | Track rich in-app events |
| [`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 |
| [`setAppUserId`](#setAppUserId) | `(String customerUserId)` | Set custom_user_id |
| [`setGCMProjectNumber`](#initSdk) | `(String gcmProjectNumber)` | |
| [`getAppsFlyerUID`](#getAppsFlyerUID) | `(function success)` | Get AppsFlyer’s proprietary Device ID |
| [`anonymizeUser`](#deviceTrackingDisabled) | `(Boolean isDisabled)` | Anonymize user data |
| [`Stop`](#stopTracking) | `(Boolean isStopTracking)` | Shut down all SDK tracking |
| [`updateServerUninstallToken`](#updateServerUninstallToken) | `(String token)` | (Android) Pass GCM/FCM Tokens |
| [`registerUninstall`](#registerUninstall) | `(String token)` | (iOS) Pass APNs Tokens |
| [`setAppInviteOneLinkID`](#setAppInviteOneLinkID) | `(Object args)` | Set AppsFlyer’s OneLink ID |
| [`generateInviteLink`](#generateInviteLink) | `(Object args, function success, function error)` | Error callback |
| [`logCrossPromotionImpression`](#trackCrossPromotionImpression) | `(String appId, String campaign)` | Track cross promotion impression |
| [`logCrossPromotionAndOpenStore`](#trackAndOpenStore) | `(String appId, String campaign, Object params)` | Launch the app store's app page (via Browser) |
| [`handleOpenUrl`](#deep-linking-tracking) | `(String url)` | |
| [`getSdkVersion`](#getSdkVersion) | `((function success)` | Get the current SDK version |
| [`setSharingFilterForAllPartners`](#setSharingFilterForAllPartners) | | Used by advertisers to exclude all networks/integrated partners from getting data |
| [`setSharingFilter`](#setSharingFilter) | `(partners)` | Used by advertisers to exclude specified networks/integrated partners from getting data |
| [`setSharingFilterForPartners`](#setSharingFilterForPartners) | `(partners)` | Used by advertisers to exclude specified networks/integrated partners from getting data |
| [`validateAndLogInAppPurchase`](#validateAndLogInAppPurchase) | `(Object purchaseInfo, function success, function error)` | API for server verification of in-app purchases |
| [`setUseReceiptValidationSandbox`](#setUseReceiptValidationSandbox) | `(boolean isSandbox, function success, function error)` | In app purchase receipt validation Apple environment |
| [`disableCollectASA`](#disableCollectASA) | `(boolean collectASA, function success)` | **iOS** - set the SDK to load OR not to load iAd.framework dynamically |
| [`setDisableAdvertisingIdentifier`](#setDisableAdvertisingIdentifier) | `(boolean disableAdvertisingIdentifier, function success)` | Disable collection of Apple, Google, Amazon and Open advertising ids (IDFA, GAID, AAID, OAID). |
| [`setOneLinkCustomDomains`](#setOneLinkCustomDomains) | `(domains, function success, function error)` | Set Onelink custom/branded domains |
| [`enableFacebookDeferredApplinks`](#enableFacebookDeferredApplinks) | `(boolean isEnabled)` | support deferred deep linking from Facebook Ads |
| [`setUserEmails`](#setUserEmails) | `(emails, function success)` | Set user emails for FB Advanced Matching |
| [`setPhoneNumber`](#setPhoneNumber) | `(String phoneNumber, function success)` | Set phone number for FB Advanced Matching |
| [`setHost`](#setHost) | `(String hostPrefix, String hostName)` | Set custom host prefix and host name |
| [`addPushNotificationDeepLinkPath`](#addPushNotificationDeepLinkPath) | `(path)` | configure push notification deep link resolution |
| [`setResolveDeepLinkURLs`](#setResolveDeepLinkURLs) | `(urls)` | get the OneLink from click domains |
| [`disableSKAD`](#disableSKAD) | `(boolean disableSkad)` | disable or enable SKAD |
| [`setCurrentDeviceLanguage`](#setCurrentDeviceLanguage) | `(string language)` | Set the language of the device. |
| [`setAdditionalData`](#setAdditionalData) | `(Object additionalData)` | Allows you to add custom data to events sent from the SDK. |
| [`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. |
| [`setConsentData`](#setConsentData) | `(boolean disable)` | Use to manually collecting the consent data from the user. |
| [`enableTCFDataCollection`](#enableTCFDataCollection) | `(boolean enable)` | instruct the SDK to collect the TCF data from the device. |
| [`logAdRevenue`](#logAdRevenue) | `(Object adRevenueData, Object additionalParams)` | Log ad revenue event. |
| [`setConsentData`](#setConsentData) | `(AppsFlyerConsent consent)` | Set consent fields manually (e.g. by prompting user and collecting results). |
| [`enableTCFDataCollection`](#enableTCFDataCollection) | `(boolean enable)` | instruct the SDK to collect the TCF data from the device. |
| [`logAdRevenue`](#logAdRevenue) | `(Object adRevenueData, Object additionalParams)` | Log ad revenue event. |

@@ -766,12 +766,17 @@

When GDPR applies to the user and your app does not use a CMP compatible with TCF v2.2, use this API to provide the consent data directly to the SDK.
The AppsFlyerConsent object has 2 methods:
The AppsFlyerConsent object has 4 parameters:
AppsFlyerConsent.forNonGDPRUser: Indicates that GDPR doesn’t apply to the user and generates nonGDPR consent object. This method doesn’t accept any parameters.
AppsFlyerConsent.forGDPRUser: create an AppsFlyerConsent object with 2 parameters:
| parameter | type | description |
| ----------- |----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `isUserSubjectToGDPR` | `boolean\null` | Indicates whether GDPR regulations apply to the user (true if the user is a subject of GDPR). It also serves as a flag for compliance with relevant aspects of DMA regulations. |
| `hasConsentForDataUsage` | `boolean\null` | Indicates whether the user has consented to use their data for advertising purposes. This can apply under GDPR, DMA, or other applicable privacy regulations.|
| `hasConsentForAdsPersonalization` | `boolean\null` | Indicates whether the user has consented to use their data for personalized advertising. This can apply under GDPR, DMA, or other applicable privacy regulations. |
| `hasConsentForAdStorage` | `boolean\null` | Indicates whether the user has provided consent for the storage of their advertising data. This can be relevant for GDPR, DMA, or other regulatory compliance purposes. |
| parameter | type | description |
| ----------- |-----------------------------|--------------|
| `hasConsentForDataUsage` | `boolean` | Indicates whether the user has consented to use their data for advertising purposes |
| `hasConsentForAdsPersonalization` | `boolean` | Indicates whether the user has consented to use their data for personalized advertising |
<b>Deprecated functions</b>
<s>AppsFlyerConsent.forNonGDPRUser: Indicates that GDPR doesn’t apply to the user and generates nonGDPR consent object. This method doesn’t accept any parameters.
AppsFlyerConsent.forGDPRUser: create an AppsFlyerConsent object with 2 parameters.
</s>
*Example:*

@@ -778,0 +783,0 @@

@@ -5,3 +5,3 @@ {

"version": "6.15.11",
"version": "6.16.2-rc1",

@@ -8,0 +8,0 @@ "description": "Cordova AppsFlyer SDK Plugin",

@@ -28,3 +28,3 @@

- From version **6.14.3** the plugin requires Target version 12 and higher in iOS.
- From version **6.15.1** the plugin requires adding the value '/usr/lib/swift' to Build Settings 'RunPath Search Paths' key in iOS.
- From version **6.15.11** the plugin requires adding the value '/usr/lib/swift' to Build Settings 'RunPath Search Paths' key in iOS.
----------

@@ -48,6 +48,6 @@

- iOS AppsFlyerSDK **v6.15.1**
- Android AppsFlyerSDK **v6.15.0**
- iOS AppsFlyerSDK **v6.15.3**
- Android AppsFlyerSDK **v6.15.2**
### <a id="breakingChanges"> ❗v6.15.1 Breaking Changes
### <a id="breakingChanges"> ❗v6.15.11 Breaking Changes

@@ -54,0 +54,0 @@ iOS platform:

@@ -0,1 +1,6 @@

## 6.15.3
Release date: *2024-12-02*
- Cordova >> Update Plugin to v6.15.3
## 6.15.11

@@ -10,7 +15,2 @@ Release date: *2024-09-03*

## 6.15.1
Release date: *2024-09-02*
- Cordova >> Update Plugin to v6.15.1
## 6.14.3

@@ -17,0 +17,0 @@ Release date: *2024-04-30*

@@ -41,24 +41,39 @@ var exec = require('cordova/exec'),

// Expose AppsFlyerConsent to the global scope
global.AppsFlyerConsent = (function () {
// Private constructor
function AppsFlyerConsent(isUserSubjectToGDPR, hasConsentForDataUsage, hasConsentForAdsPersonalization) {
this.isUserSubjectToGDPR = isUserSubjectToGDPR;
this.hasConsentForDataUsage = hasConsentForDataUsage;
this.hasConsentForAdsPersonalization = hasConsentForAdsPersonalization;
}
/**
* @class AppsFlyerConsent
* @constructor
* @param {boolean|null} isUserSubjectToGDPR - Indicates if the user is subject to GDPR.
* @param {boolean|null} hasConsentForDataUsage - User's consent for data usage.
* @param {boolean|null} hasConsentForAdsPersonalization - User's consent for ads personalization.
* @param {boolean|null} hasConsentForAdStorage - User's consent for ad storage.
*/
function AppsFlyerConsent(isUserSubjectToGDPR, hasConsentForDataUsage, hasConsentForAdsPersonalization, hasConsentForAdStorage) {
this.isUserSubjectToGDPR = isUserSubjectToGDPR;
this.hasConsentForDataUsage = hasConsentForDataUsage;
this.hasConsentForAdsPersonalization = hasConsentForAdsPersonalization;
this.hasConsentForAdStorage = hasConsentForAdStorage;
}
return {
// Factory method for GDPR user
forGDPRUser: function(hasConsentForDataUsage, hasConsentForAdsPersonalization) {
return new AppsFlyerConsent(true, hasConsentForDataUsage, hasConsentForAdsPersonalization);
},
/**
* @deprecated Use the constructor directly with four parameters instead.
* Factory method for GDPR user.
*/
AppsFlyerConsent.forGDPRUser = function (hasConsentForDataUsage, hasConsentForAdsPersonalization) {
window.console.warn("[DEPRECATED] 'forGDPRUser' is deprecated. Use 'new AppsFlyerConsent' instead.");
return new AppsFlyerConsent(true, hasConsentForDataUsage, hasConsentForAdsPersonalization, null);
};
// Factory method for non GDPR user
forNonGDPRUser: function() {
return new AppsFlyerConsent(false, null, null);
}
};
})();
/**
* @deprecated Use the constructor directly with four parameters instead.
* Factory method for non-GDPR user.
*/
AppsFlyerConsent.forNonGDPRUser = function () {
window.console.warn("[DEPRECATED] 'forNonGDPRUser' is deprecated. Use 'new AppsFlyerConsent' instead.");
return new AppsFlyerConsent(false, null, null, null);
};
// Expose AppsFlyerConsent to the global scope
global.AppsFlyerConsent = AppsFlyerConsent;
/**

@@ -65,0 +80,0 @@ * initialize the SDK.

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

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.