Native PC Unity

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

AppsFlyer Native PC Unity SDK integration

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

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 Native PC game.

Note: The sample code that follows is supported in a both Windows & Mac environment.

AppsflyerModule - Interface

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

AppsflyerModule

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.

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

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

Arguments:

DEV_KEY: получите у маркетолога или AppsFlyer HQ.
APP_ID: The app id on Appsflyer HQ (excluding the nativepc- ).
MonoBehaviour mono: the parent MonoBehaviour.
bool isSandbox: Whether to activate sandbox mode. False by default. This option is for debugging. With the sandbox mode, AppsFlyer dashboard does not show the data.

Usage:

// for regular init
AppsflyerModule afm = new AppsflyerModule(<< DEV_KEY >>, << APP_ID >>, this);

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

Start

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

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

void Start(bool skipFirst = false)

Аргументы

bool skipFirst: Determines whether or not to skip first open events and send session events. The value is false by default. If true , first open events are skipped and session events are sent. See example

Usage:

// without the flag
afm.Start();

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

Stop

This method stops the SDK from functioning and communicating with AppsFlyer servers. It's used 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,
      Dictionary<string, object> event_custom_parameters = null
   )

Arguments:

string event_name: the name of the event.
Dictionary<string, object> event_parameters: dictionary object which contains the predefined event parameters.
Dictionary<string, object> event_custom_parameters: (non-mandatory): dictionary object which contains the any custom 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_revenue", 12.12);
// send logEvent request
afm.LogEvent(event_name, event_parameters);

// send logEvent request with custom params
Dictionary<string, object> event_custom_parameters = new Dictionary<string, object>();
event_custom_parameters.Add("goodsName", "新人邀约购物日");
afm.LogEvent(event_name, event_parameters, event_custom_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-01T23:12:34+00:00"

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

bool IsInstallOlderThanDate(string datestring)

Arguments:

string datestring: Date string in yyyy-mm-ddThh:mm:ss+hh:mm format.

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);

SetCustomerUserId

This method sets a customer ID that enables you to cross-reference your unique ID with the AppsFlyer unique ID and other device IDs. Note: You can only use this method before calling Start().
The customer ID is available in raw data reports and in the postbacks sent via API.

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

void SetCustomerUserId(string cuid)

Arguments:

string cuid: Custom user id.

Usage:

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

SetSharingFilterForPartners

This method lets you configure which partners should the SDK exclude from data-sharing. Partners that are excluded with this method will not receive data through postbacks, APIs, raw data reports, or any other means.

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

public void SetSharingFilterForPartners(List<string> sharingFilter)

Arguments:

List<string> sharingFilter: a list of partners to filter. For example: new List<string>() {"partner1_int", "partner2_int"};

Usage:

AppsflyerModule afm = new AppsflyerModule(DEV_KEY, APP_ID, this);

// set the sharing filter
var sharingFilter = new List<string>() {"partner1_int", "partner2_int"};
afm.SetSharingFilterForPartners(sharingFilter);

// start the SDK (send firstopen/session request)
afm.Start();

GetAppsFlyerUID

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

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

void GetAppsFlyerUID()

Usage:

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

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

Откройте хаб Unity и откройте проект.
Use the sample code in AppsflyerScript.cs and update it with your DEV_KEY and APP_ID.
Add the AppsflyerScript to an empty game object (or use the one in the scenes folder):
Запустите пример приложения посредством редактора Unity и убедитесь, что журнал отладки показывает следующее сообщение:
Через 24 часа дэшборд AppsFlyer обновляется и отображает органические и неорганические установки и внутренние события приложения.

Implementing AppsFlyer in your Native PC game

Setup

Добавьте скрипт из Assets/AppsflyerModule.cs в ваше приложение.
Используйте пример кода в Assets/AppsflyerScript.cs и обновите его данными своих DEV_KEY and APP_ID.
Инициализируйте SDK.

AppsflyerModule afm = new AppsflyerModule(<< DEV_KEY >>, << APP_ID >>, this);

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

Resetting the attribution

Delete the PlayerPrefs data the registry/preferences folder, or use PlayerPrefs.DeleteAll() when testing the attribution in the UnityEditor.
AF guid & counter in the Windows Registry