Unity Epic

GitHubレポジトリへのリンク

AppsFlyer Unity Epic SDK連携

AppsFlyerは、クロスプラットフォームアトリビューションを実行するための強力なツールを提供することで、ゲームマーケティング担当者がより良い意思決定を行えるよう支援します。

ゲームのアトリビューションには、初回開封、連続セッション、アプリ内イベントを記録するAppsFlyer SDKを統合することが必要です。（例：購入など）
AppsFlyer SDKをUnity Epicゲームに組み込む際の参考として、このサンプルアプリをご利用いただくことをお勧めします。

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.

メソッドのシグネチャ

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

Arguments:

• DEV_KEY: Get from the marketer or AppsFlyer HQ.
• EPIC_APP_ID：Epicストアリンクから取得可能
• 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.

例：

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

Start

このメソッドは、first open / session（初回起動 / セッション）リクエストをAppsFlyerに送信します。

メソッドのシグネチャ

void Start(bool skipFirst = false)

例：

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

例：

// 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.

例：

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

// 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-13T10:00:00+00:00"

メソッドのシグネチャ

bool IsInstallOlderThanDate(string datestring)

例：

// 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のユニークデバイスIDを取得します。SDKはアプリのインストール時にAppsFlyerのユニークなデバイスIDを生成します。SDKを起動すると、このIDが最初のアプリインストール時のIDとして記録されます。

メソッドのシグネチャ

void GetAppsFlyerUID()

例：

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

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)

例：

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

サンプルアプリの実行

1. Unity hubを開き、プロジェクトを開きます。
2. Use the sample code in AppsflyerEpicScript.cs and update it with your DEV_KEY and APP_ID (in the gaming object).
   
3. AppsflyerEpicScriptを空のゲームオブジェクトに追加します（またはscenesフォルダにあるものを使用します）：
   
4. Unityエディターでサンプルアプリを起動し、デバッグログに以下のメッセージが表示されることを確認します：
   
5. 24時間後にダッシュボードが更新され、オーガニックとノンオーガニックのインストールとアプリ内イベントが表示されます。

EpicゲームにAppsFlyerを実装する

Setup

1. EOS を Unity プロジェクトに追加します。Epic Online Services Unity プラグインの指示 に従い、パッケージマネージャーから追加してください。
2. Add EOSManager.cs をゲームオブジェクトに追加します。
3. スクリプトの追加元 Assets/Scenes/AppsflyerEpicModule.cs をアプリに追加します。
4. Use the sample code in Assets/Scenes/AppsflyerEpicScript.cs and update it with your DEV_KEY and APP_ID.
5. SDKの初期化

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

6. AppsFlyerの実装を開始しましょう。
7. Report in-app events.

Resetting the attribution

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