appsflyer-unity-plugin

🛠 In order for us to provide optimal support, we would kindly ask you to submit any issues to [email protected]

When submitting an issue please specify your AppsFlyer sign-up (account) email , your app ID , production steps, logs, code snippets and any additional relevant information.

Table of content

• Breaking changes 6.3.0
• Migration from older plugin versions
• Adding the SDK to your project
• Initializing the SDK
  • Using the AppsFlyerObject.prefab
  • Manual integration
• Guides
• API

---

This plugin is built for

• Android AppsFlyer SDK v6.3.2
• iOS AppsFlyer SDK v6.3.2

❗❗ Breaking changes when updating to 6.3.0 ❗❗

• 6.3.0 supports Universal Windows Platform. As part of this update, the AppsFlyerObjectScript changes to include the app_id for your UWP app. If you made changes to this file, please merge them with the new AppsFlyerObjectScript. Please also note that you can leave the uwp app id field empty.

• From version 6.3.0, we use xcframework for iOS platform, then you need to use cocoapods version >= 1.10

📲 Adding the SDK to your project

Using unitypackage:

1. Clone / download this repository.
2. Import the appsflyer-unity-plugin-*.unitypackage into your Unity project.
3. Go to Assets >> Import Package >> Custom Package.
4. Select the appsflyer-unity-plugin-*.unitypackage file.

Note: The plugin uses the The External Dependency Manager for Unity (EDM4U) (formerly Play Services Resolver / Jar Resolver). If you do not want to use EDM4U see the Installation guide for more details.

Using Unity Package Manager:

1. Go to your packages folder, and open manifest.json
2. Add Google game package registery fpr the external dependency Manager.

  "scopedRegistries": [
    {
      "name": "Game Package Registry by Google",
      "url": "https://unityregistry-pa.googleapis.com",
      "scopes": [
        "com.google"
      ]
    }
  ]

4. Add appsflyer-unity-plugin in the dependency : Add this line for the regular mode

 "appsflyer-unity-plugin": "https://github.com/AppsFlyerSDK/appsflyer-unity-plugin.git#upm"

Or this line for Strict mode :

 "appsflyer-unity-plugin": "https://github.com/AppsFlyerSDK/appsflyer-unity-plugin.git#Strict-upm"

🚀 Initializing the SDK

Using the AppsFlyerObject.prefab

1. Go to Assets > AppsFlyer and drag AppsFlyerObject.prefab to your scene.

2. Update the following fields:

Setting	Description
Dev Key	AppsFlyer's Dev Key, which is accessible from the AppsFlyer dashboard.
App ID	Your iTunes Application ID. (If your app is not for iOS the leave field empty)
Get Conversion Data	Set this to true if your app is using AppsFlyer for deep linking.
Is Debug	Set this to true to view the debug logs. (for development only!)

3. Update the code in Assets > AppsFlyer > AppsFlyerObjectScript.cs with other available API.

Manual integration

Create a game object and add the following init code:

using AppsFlyerSDK;

public class AppsFlyerObjectScript : MonoBehaviour
{
  void Start()
  {
    AppsFlyer.initSDK("devkey", "appID");
    AppsFlyer.startSDK();
  }
}

Note: Make sure not to call destroy on the game object.

📖 Guides

• Installation
• Init SDK
• Deep Linking
• Uninstall
• User Invite

📑 API

See the full API available for this plugin.

⏩ Migration

Migrating from the old plugin? (version V4)
View the migration docs here.

⚠️ There are breaking changes when migrating to Unity v5. This includes new API, different class/package names, and the removal of com.appsflyer.GetDeepLinkingActivity.