Overview

This document guides you on how to install the CleverTap SDK, track your first user event, and view this information within the CleverTap dashboard in less than ten minutes. The plugin includes the Unity Native SDK, which is packaged within the same Unity module and extends support for multiple platforms, including macOS, Windows, Linux, and WebGL.

Install SDK

The installation involves the following major steps:

1. Import the CleverTap Unity Package.
2. Set Up the Unity SDK.
3. Initialize CleverTap SDK.

Import the CleverTap Unity Package

To import the CleverTap Unity Package into your project:

1. Download the latest CleverTap Unity package from the GitHub Releases page. Then, in Unity, go to Assets > Import Package > Custom Package, and select the downloaded .unitypackage file.
2. Add the PlayServiceResolver and the ExternalDependencyManager folders in your project. These folders install the EDM4U plugin, which automatically adds all the Android and iOS dependencies during the build process.

3. Check that the AndroidPostImport script is added, as it sets up clevertap-android-wrapper library for Android.

Optional

You can install the CleverTap Unity SDK using the .unitypackage file or as a local dependency via the Unity Package Manager (UPM).

To install via UPM:

1. Clone the latest release of the CleverTap Unity SDK.
2. Open Unity and go to Window > Package Manager.
3. Click the + icon > Add package from disk.
4. Select the package.json file from the cloned repo folder.

Set Up Unity SDK

CleverTap API can be accessed anywhere in your project by calling the static CleverTap class. You need not create a GameObject with the CleverTapUnity name or attach any script. The new architecture handles the following:

• Instantiation of platform-specific binding
• Creation of GameObject
• Script attachment

Initialize CleverTap SDK

The WebGL initialization requires region code. Use the LaunchWithCredentialsForRegion method to initialize with the correct region code.

// Initialize CleverTap
#if UNITY_WEBGL
	CleverTap.LaunchWithCredentialsForRegion({YOUR_CLEVERTAP_ACCOUNT_ID}, {YOUR_CLEVERTAP_ACCOUNT_TOKEN}, {CLEVERTAP_ACCOUNT_REGION});
#endif

Find CleverTap Account ID and Token

You can view your CleverTap Account ID and CleverTap Account Token from the CleverTap dashboard by navigating to the Settings > Project page on the CleverTap dashboard.

📘

CORS Credentials Configuration

If you are using JavaScript Fetch to call APIs from your client, ensure that requests to CleverTap domains do not include credentials. Setting "credentials": "include" on such requests may lead to CORS issues.

Use the following snippet to override the default behavior and selectively apply credentials only for non-CleverTap domains:

JavaScript

fetch = function (url, data) {
    if (url.indexOf('clevertap') == -1) {
        data.credentials = 'include';
    }
    return originalFetch(url, data);
};

This ensures that cross-origin calls to CleverTap avoid unnecessary credential sharing and CORS conflicts.

Callbacks

A new mechanism to handle callbacks is introduced. You can now add an event listener for a callback directly through the CleverTap static events. You need not set all callbacks in the CleverTapUnity.cs anymore.

CleverTap.OnCleverTapProfileInitializedCallback += YOUR_CALLBACK_METHOD;  
CleverTap.OnCleverTapProfileUpdatesCallback += YOUR_CALLBACK_METHOD;

This introduces breaking changes in the CleverTapUnity.cs, rendering all existing callback methods obsolete, and these methods will not be called anymore. If you still want to use the callbacks through the CleverTapUnity.cs methods, each method must subscribe to a new event listener found at CleverTap.On{CleveTapUnity_Callback_MethodName}.

The following is a sample code for subscribing to new event listeners with existing methods in CleverTapUnity.cs:

CleverTap.OnCleverTapProfileInitializedCallback += CleverTapProfileInitializedCallback;
CleverTap.OnCleverTapProfileUpdatesCallback += CleverTapProfileUpdatesCallback;
CleverTap.OnCleverTapInitCleverTapIdCallback += CleverTapInitCleverTapIdCallback;

Track User Profiles

Create a User profile when the user logs in with the OnUserLogin method:

Dictionary<string, string> newProps = new Dictionary<string, string>();
newProps.Add("email", "[email protected]");
newProps.Add("Identity", "123456");
newProps.put("Name", "Jack Montana");    // String
newProps.put("Identity", "61026032");      // String
newProps.put("Email", "[email protected]"); // Email address of the user
newProps.put("Phone", "+14155551234");   // Phone (with the country code, starting with +)
newProps.put("Gender", "M");             // Can be either M or F
CleverTap.OnUserLogin(newProps);

Track User Events

• Record an event without event data:

// record basic event with no properties
CleverTap.RecordEvent("testEvent");

• Record an event with event data as follows:

// record event with properties
Dictionary<string, object> Props = new Dictionary<string, object>();
Props.Add("testKey", "testValue");
CleverTap.RecordEvent("testEventWithProps", Props);