Unity Epic

Link to repository
GitHub

AppsFlyer Unity Epic SDK integration

AppsFlyer empowers gaming marketers to make better decisions by providing powerful tools to perform cross-platform attribution.

Game attribution requires the game to integrate the AppsFlyer SDK that records first opens, consecutive sessions, and in-app events. For example, purchase events.
We recommend you use this sample app as a reference for integrating the AppsFlyer SDK into your Unity Epic game.

AppsflyerEpicModule - Interface

AppsflyerEpicModule.cs, included in the scenes folder, contains the required code and logic to connect to AppsFlyer servers and report events.

AppsflyerEpicModule

This method receives your API key, app ID, the parent MonoBehaviour and a sandbox mode flag (optional, false by default) and initializes the AppsFlyer Module.

Signature de la méthode

AppsflyerEpicModule(string appid, string devkey, MonoBehaviour mono, bool isSandbox = false)

Usage:

// for regular init
AppsflyerEpicModule afm = new AppsflyerEpicModule(<< DEV_KEY >>, << EPIC_APP_ID >>, this);

// for init in sandbox mode (reports the events to the sandbox endpoint)
AppsflyerEpicModule afm = new AppsflyerEpicModule(<< DEV_KEY >>, << EPIC_APP_ID >>, this, true);

Arguments:

DEV_KEY: Get from the marketer or AppsFlyer HQ.
EPIC_APP_ID: Found in the Epic store link
MonoBehaviour mono:
bool isSandbox: Whether to activate sandbox mode. False by default.

Start

This method sends first open/session requests to AppsFlyer.

Signature de la méthode

void Start(bool skipFirst = false)

Usage:

// without the flag
afm.Start();

// with the flag
bool skipFirst = [SOME_CONDITION];
afm.Start(skipFirst);

Stop

Once this method is invoked, our SDK no longer communicates with our servers and stops functioning.
Useful when implementing user opt-in/opt-out.

Signature de la méthode

void Stop()

Usage:

// Starting the SDK
afm.Start();
// ...
// Stopping the SDK, preventing further communication with AppsFlyer
afm.Stop();

LogEvent

This method receives an event name and JSON object and sends an in-app event to AppsFlyer.

Signature de la méthode

void LogEvent(string event_name, Dictionary<string, object> event_parameters)

Usage:

// set event name
string event_name = "af_purchase";
// set event values
Dictionary<string, object> event_parameters = new Dictionary<string, object>();
event_parameters.Add("af_currency", "USD");
event_parameters.Add("af_price", 6.66);
event_parameters.Add("af_revenue", 12.12);
// send logEvent request
afm.LogEvent(event_name, event_parameters);

IsInstallOlderThanDate

This method receives a date string and returns true if the game folder creation date is older than the date string. The date string format is: "2023-03-13T10:00:00+00:00"

Signature de la méthode

bool IsInstallOlderThanDate(string datestring)

Usage:

// the creation date in this example is "2023-03-23T08:30:00+00:00"
bool newerDate = afm.IsInstallOlderThanDate("2023-06-13T10:00:00+00:00");
bool olderDate = afm.IsInstallOlderThanDate("2023-02-11T10:00:00+00:00");

// will return true
Debug.Log("newerDate:" + (newerDate ? "true" : "false"));
// will return false
Debug.Log("olderDate:" + (olderDate ? "true" : "false"));

// example usage with skipFirst -
// skipping if the install date is NOT older than the given date
bool IsInstallOlderThanDate = afm.IsInstallOlderThanDate("2023-02-11T10:00:00+00:00");
afm.Start(!IsInstallOlderThanDate);

GetAppsFlyerUID

Pour obtenir l'ID d'appareil unique AppsFlyer. Le SDK génère un ID d'appareil unique AppsFlyer lorsque l'application est installée. Lorsque le SDK se lance, cet ID est enregistré comme étant l'ID de la première installation

Signature de la méthode

void GetAppsFlyerUID()

Usage:

AppsflyerEpicModule afm = new AppsflyerEpicModule(<< DEV_KEY >>, << EPIC_APP_ID >>, this);
afm.Start();
string af_uid = afm.GetAppsFlyerUID();

SetCustomerUserId

Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and other devices’ IDs.
This ID is available in raw-data reports and in the Postback APIs for cross-referencing with your internal IDs.
Can be used only before calling Start().

Signature de la méthode

void SetCustomerUserId(string cuid)

Usage:

AppsflyerEpicModule afm = new AppsflyerEpicModule(DEV_KEY, STEAM_APP_ID, this);
afm.SetCustomerUserId("15667737-366d-4994-ac8b-653fe6b2be4a");
afm.Start();

Running the sample app

Open Unity hub and open the project.
Use the sample code in AppsflyerEpicScript.cs and update it with your DEV_KEY and APP_ID (in the gaming object).
Add the AppsflyerEpicScript to an empty game object (or use the one in the scenes folder):
Launch the sample app via the Unity editor and check that your debug log shows the following message:
After 24 hours, the AppsFlyer dashboard updates and shows organic and non-organic installs and in-app events.

Implementing AppsFlyer in your Epic game

Setup

Add EOS to your Unity project. Follow the Epic Online Services Unity plugin instructions and add it through your package manager.
Add EOSManager.cs to a game object.
Add the script from Assets/Scenes/AppsflyerEpicModule.cs to your app.
Use the sample code in Assets/Scenes/AppsflyerEpicScript.cs and update it with your DEV_KEY and APP_ID.
Initialize the SDK.

AppsflyerEpicModule afm = new AppsflyerEpicModule(<< DEV_KEY >>, << EPIC_APP_ID >>, this);

Start the AppsFlyer integration.
Report in-app events.

Resetting the attribution

Delete the PlayerPrefs data the registry/preferences folder, or use PlayerPrefs.DeleteAll() when testing the attribution in the UnityEditor.