Unity Steam

GitHubレポジトリへのリンク

AppsFlyer Unity Steam SDK連携

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

ゲームのアトリビューションには、初回起動、連続セッション、アプリ内イベントを記録するAppsFlyer SDKを連携することが必要です（例：購入イベントなど）。このサンプルアプリは、AppsFlyer SDKをUnity-Steamゲームに実装するためのリファレンスとして使用することをお勧めします。

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

Prerequisites

Unity Engine
Unityプロジェクト内に実装されたSteamworks SDK
アクティブユーザーでインストールされたSteamクライアント
注：テスト用に実行されている必要があります。

AppsflyerSteamModule - Interface

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

AppsflyerSteamModule

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

メソッドのシグネチャ

AppsflyerSteamModule(
   string DEV_KEY,
   string STEAM_APP_ID,
   MonoBehaviour mono,
   bool isSandbox = false,
   bool collectSteamUid = true
)

引数

string DEV_KEY: Get from the marketer or AppsFlyer HQ.
string STEAM_APP_IDSteamDBから取得できます。
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.
bool collectSteamUid: Whether to collect Steam UID or not. True by default.

例：

// for regular init
AppsflyerSteamModule afm = new AppsflyerSteamModule(DEV_KEY, STEAM_APP_ID, this);

// for init in sandbox mode (reports the events to the sandbox endpoint)
AppsflyerSteamModule afm = new AppsflyerSteamModule(DEV_KEY, STEAM_APP_ID, this, true);

// for init without reporting steam_uid
AppsflyerSteamModule afm = new AppsflyerSteamModule(DEV_KEY, STEAM_APP_ID, this, false, false);

Start

このメソッドは、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

例：

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

GetAppsFlyerUID

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

メソッドのシグネチャ

string GetAppsFlyerUID()

例：

AppsflyerSteamModule afm = new AppsflyerSteamModule(DEV_KEY, STEAM_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)

Arguments:

string cuid: Custom user id.

例：

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"};

例：

AppsflyerSteamModule afm = new AppsflyerSteamModule(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();

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)

Arguments:

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

例：

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

サンプルアプリの実行

Unity hubを開き、プロジェクトを開きます。
UnityのプロジェクトにSteamworksを追加します。Steamworks SDKの説明に従って、パッケージマネージャーから追加してください。
Use the sample code in SteamScript.cs and update it with your DEV_KEY and APP_ID.
Add the SteamManager and SteamScript to an empty game object (or use the one in the scenes folder).
Unityエディターでサンプルアプリを起動し、デバッグログに以下のメッセージが表示されることを確認します：
24時間後にダッシュボードが更新され、オーガニックとノンオーガニックのインストールとアプリ内イベントが表示されます。

SteamゲームにAppsFlyerを実装する

UnityのプロジェクトにSteamworksを追加します。Steamworks SDKの説明に従って、パッケージマネージャーから追加してください。
Add SteamManager.cs をゲームオブジェクトに追加します。
スクリプトの追加元 Assets/Scenes/AppsflyerSteamModule.cs をアプリに追加します。
Use the sample code in Assets/Scenes/SteamScript.cs and update it with your DEV_KEY and APP_ID.
SDKの初期化

AppsflyerSteamModule afm = new AppsflyerSteamModule(DEV_KEY, STEAM_APP_ID, this);

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

Steamのクラウドセーブを削除する（アトリビューションをリセットする）

Steamクラウドを無効化
ローカルファイルの削除
Delete the PlayerPrefs data the registry/preferences folder, or use PlayerPrefs.DeleteAll() when testing the attribution in the UnityEditor.