# Cordova AppsFlyer plugin for Android and iOS. [![npm version](https://badge.fury.io/js/cordova-plugin-appsflyer-sdk.svg)](https://badge.fury.io/js/cordova-plugin-appsflyer-sdk) [![Build Status](https://travis-ci.org/AppsFlyerSDK/appsflyer-cordova-plugin.svg?branch=master)](https://travis-ci.org/AppsFlyerSDK/appsflyer-cordova-plugin) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Downloads](https://img.shields.io/npm/dm/cordova-plugin-appsflyer-sdk.svg)](https://www.npmjs.com/package/cordova-plugin-appsflyer-sdk) ---------- 🛠 In order for us to provide optimal support, please contact AppsFlyer support through the Customer Assistant Chatbot for assistance with troubleshooting issues or product guidance.
To do so, please follow [this article](https://support.appsflyer.com/hc/en-us/articles/23583984402193-Using-the-Customer-Assistant-Chatbot) ---------- ###

⚠️ Note for Capacitor users ⚠️

**Please check out our brand new [Capacitor plugin](https://github.com/AppsFlyerSDK/appsflyer-capacitor-plugin).**
This plugin is not 100% compatible for use with Capacitor! To use this plugin with Capacitor, you have to make changes and customize the code by yourself. (Feel free to fork the project) ---------- **❗️Important**
- Cordova AppsFlyer plugin version **4.4.0** and higher are meant to be used with **cordova-android@7.0.0** and up
For lower versions of cordova-android please use plugin version 4.3.3 available @ https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk/tree/4.3.3
- From version **6.1.10** the plugin uses cocoapods(NOT StaticLib) in order to support iOS app-kids Strict mode.
You can read more [here](https://support.appsflyer.com/hc/en-us/articles/207032066#integration-strict-mode-sdk) - From version **6.10.2** the plugin requires using the implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.6.20' in Android. - From version **6.14.3** the plugin requires Target version 12 and higher 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. ---------- ## Table of content - [SDK versions](#plugin-build-for) - [V6 Breaking Changes](#breakingChanges) - [Installation](#installation) - [Add or Remove Strict mode for App-kids](#appKids) - [Guides](#guides) - [Setup](#setup) - [API](#api) - [Demo](#demo) - [Ionic](#ionic) ### This plugin is built for - iOS AppsFlyerSDK **v6.17.8** - Android AppsFlyerSDK **v6.17.5** ### ❗v6.15.11 Breaking Changes iOS platform: The plugin requires adding the value '/usr/lib/swift' to Build Settings 'RunPath Search Paths' key in iOS, Otherwise there might be some compilation errors. ### ❗v6.14.3 Breaking Changes Android platform: In order to receive data regarding install-referrer from AppGallery now, there is a need to add implementation to the gradle file.
following the instructions in [this](https://dev.appsflyer.com/hc/docs/install-android-sdk#huawei-install-referrer) link.
please follow also these Cordova doc guidlines [here](https://cordova.apache.org/docs/en/11.x/guide/platforms/android/#extending-buildgradle). ### ❗v6 Breaking Changes We have renamed the following APIs: | Old API | New API | |---------|---------| |trackEvent | logEvent| |stopTracking | Stop| |trackCrossPromotionImpression | logCrossPromotionImpression| |trackAndOpenStore | logCrossPromotionAndOpenStore| |setDeviceTrackingDisabled | anonymizeUser| ## 📲Installation ``` $ cordova plugin add cordova-plugin-appsflyer-sdk ``` 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).
## 👨‍👩‍👧‍👦 Add or Remove Strict mode for App-kids 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) ***Change to Strict mode***
After you [installed](#installation) the AppsFlyer plugin, go to the `ios` folder inside `platform` folder: ``` cd platform/ios ``` open the `Podfile` and replace `pod 'AppsFlyerFramework', '6.1.1'` with `pod 'AppsFlyerFramework/Strict', '6.1.1'` Run `pod install` inside the `ios` folder inside xcode, go to your target and define Preprocessor Macro `AFSDK_NO_IDFA=1` ![Add Preprocessor macro](https://github.com/amit-kremer93/resources/blob/main/preprocessorMacro.png)
* You can add the Preprocessor Macro using our [Hooks](/docs/Hooks.md). ***Change to Regular mode***
Go to the `ios` folder inside `platform` folder: ``` cd platform/ios ``` open the `Podfile` and replace `pod 'AppsFlyerFramework/Strict', '6.1.1'` with `pod 'AppsFlyerFramework', '6.1.1'` Run `pod install` inside the `ios` folder inside xcode, go to your target and remove the Preprocessor Macro `AFSDK_NO_IDFA=1` ## 📖 Guides Great installation and setup guides can be viewed [here](/docs/Guides.md). - [init SDK Guide](/docs/Guides.md#init-sdk) - [Deeplinking Guide](/docs/Guides.md#deeplinking) - [Uninstall Guide](/docs/Guides.md#uninstall) - [Set plugin for IOS 14](/docs/Guides.md#ios14) - [Send SKAN postback copies for IOS 15](/docs/Guides.md#skanPostback) ## 🚀 Setup #### Set your App_ID (iOS only), Dev_Key and enable AppsFlyer to detect installations, sessions (app opens) and updates. > This is the minimum requirement to start tracking your app installs and is already implemented in this plugin. You **MUST** modify this call and provide: **devKey** - Your application devKey provided by AppsFlyer.
**appId** - ***For iOS only.*** Your iTunes Application ID.
**waitForATTUserAuthorization** - ***For iOS14 only.*** Time for the sdk to wait before launch. Add the following lines to your code to be able to initialize tracking with your own AppsFlyer dev key: ```javascript document.addEventListener('deviceready', function() { window.plugins.appsFlyer.initSdk({ devKey: 'K2***************99', // your AppsFlyer devKey isDebug: false, appId: '41*****44', // your ios appID waitForATTUserAuthorization: 10, //time for the sdk to wait before launch - IOS 14 ONLY! }, (result) => { console.log(result); }, (error) => { console.error(error); } ); }, false); ``` --- ## 📑 API See the full [API](/docs/API.md) available for this plugin. ## 📱 Demo Check out the demo for this project [here](docs/Guides.md#demo).
There is 1 demo project called ```demoC```, run ```npm run setup_c``` in the appsflyer-cordova-plugin folder and then open the ios project in Xcode to see implementation for IOS 14.
Check out our Sample-App **Let's cook!** [here](https://github.com/AppsFlyerSDK/appsflyer-cordova-app) if you want to implement our SDK inside React-Cordova app ## 📍 Ionic ***NOTICE!*** In AppsFlyer Cordova plugin version 6.x.x we replaced the word ``track`` with ``log`` from all our api but Ionic-Navite Appsflyer plugin still uses ``track``
So the latest version that can work with Ionic-Native for now is **5.4.30**
### Using the `window` object directly Install the cordova plugin: ``` $ ionic cordova plugin add cordova-plugin-appsflyer-sdk ``` In your main ts file, declare a window variable: ```javascript declare var window; ``` Now you can use the AppsFlyer plugin directly from cordova: ```javascript import {Component} from '@angular/core'; import {Platform} from '@ionic/angular'; declare var window; ... export class HomePage { constructor(public platform: Platform) { this.platform.ready().then(() => { window.plugins.appsFlyer.initSdk(options, success, error); }); }} ``` Check out the full [API](/docs/API.md) for more information