Unity Epic

Ссылка на репозиторий
GitHub

Интеграция SDK AppsFlyer в Unity Epic

AppsFlyer позволяет маркетологам игровых приложений принимать оптимальные решения, предоставляя высокоэффективные инструменты для кросс-платформенной атрибуции.

Для атрибуции игры в игру должен быть интегрирован SDK AppsFlyer, который записывает первое открытие, последовательные сессии и внутренние события приложения. Например, события покупки.
Мы рекомендуем использовать этот пример приложения в качестве справки по интеграции SDK AppsFlyer в свою игру Unity Epic.

AppsflyerEpicModule — интерфейс

AppsflyerEpicModule.cs в папке сцен содержит необходимый код и логику для подключения к серверам AppsFlyer и передачи отчетов по событиям.

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.

Сигнатура метода

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: получите у маркетолога или AppsFlyer HQ.
• EPIC_APP_ID: находится в ссылке магазина Epic
• MonoBehaviour mono:
• bool isSandbox: Whether to activate sandbox mode. False by default.

Start

Данный метод передает запросы «first open/session» в AppsFlyer.

Сигнатура метода

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.

Сигнатура метода

void Stop()

Usage:

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

LogEvent

Этот метод получает имя события и объект JSON и отправляет внутреннее событие приложения в AppsFlyer.

Сигнатура метода

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"

Сигнатура метода

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

Получение от AppsFlyer уникального идентификатора устройства. SDK генерирует уникальный идентификатор устройства AppsFlyer при установке приложения. При запуске SDK этот идентификатор записывается как идентификатор первой установки приложения.

Сигнатура метода

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().

Сигнатура метода

void SetCustomerUserId(string cuid)

Usage:

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

Запуск примера приложения

1. Откройте хаб Unity и откройте проект.
2. Используйте пример кода в AppsflyerEpicScript.cs and update it with your DEV_KEY and APP_ID (in the gaming object).
   
3. Добавьте AppsflyerEpicScript в пустой игровой объект (или воспользуйтесь объектом в папке сцен):
   
4. Запустите пример приложения посредством редактора Unity и убедитесь, что журнал отладки показывает следующее сообщение:
   
5. Через 24 часа дэшборд AppsFlyer обновляется и отображает органические и неорганические установки и внутренние события приложения.

Внедрение AppsFlyer в вашу игру Epic

Setup

1. Добавьте EOS в свой проект Unity. Следуйте инструкциям к плагину Epic Online Services Unity и добавьте его через менеджер пакетов.
2. Add EOSManager.cs в игровой объект.
3. Добавьте скрипт из Assets/Scenes/AppsflyerEpicModule.cs в ваше приложение.
4. Используйте пример кода в Assets/Scenes/AppsflyerEpicScript.cs и обновите его данными своих DEV_KEY and APP_ID.
5. Инициализируйте SDK.

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

6. Начните интеграцию AppsFlyer.
7. Подайте отчет о внутренних событиях приложения.

Resetting the attribution

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