Unreal Steam

GitHubレポジトリへのリンク

AppsFlyer Unreal Steam SDK integration

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

ゲームのアトリビューションには、初回開封、連続セッション、アプリ内イベントを記録するAppsFlyer SDKを統合することが必要です。（例：購入など）
AppsFlyer SDKをUnreal Steamゲームに組み込む際の参考として、このサンプルアプリを使用することをお勧めします。注：以下のサンプルコードは、現在、Windows環境でのみサポートされています。

Prerequisites

Unreal Engine 4.2x
Steamworks SDKが実装されたUE4（通常、UE4のサードパーティに含まれているため、ダウンロードする必要はありません）
Steamクライアントがアクティブなユーザーでインストールされている

AppsflyerSteamModule - Interface

AppsflyerSteamModule.h, included in the appsflyer-unreal-steam-sample-app/AppsflyerSteamIntegrationFiles/AppsflyerSteamModule folder, contains the required code and logic to connect to AppsFlyer servers and report events.

Init

このメソッドは、お客様のAPIキーとアプリIDを受け取り、AppsFlyer Moduleを初期化します。

メソッドのシグネチャ

void Init(const char* devkey, const char* appID)

例：

AppsflyerSteamModule()->Init(<< DEV_KEY >>, << STEAM_APP_ID>>);

Arguments:

STEAM_APP_IDSteamDBから取得できます。
DEV_KEY: Get from the marketer or AppsFlyer HQ.

Start

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

メソッドのシグネチャ

void Start(bool skipFirst = false)

例：

// without the flag
AppsflyerSteamModule()->Start();

// with the flag
bool skipFirst = [SOME_CONDITION];
AppsflyerSteamModule()->Start(skipFirst);

LogEvent

このメソッドは、イベント名とJSONオブジェクトを受け取り、アプリ内イベントをAppsFlyerに送信します。

メソッドのシグネチャ

void LogEvent(std::string event_name, json event_parameters)

例：

//set event name
std::string event_name = "af_purchase";
//set json string
std::string event_parameters = "{\"af_currency\":\"USD\",\"af_price\":6.66,\"af_revenue\":24.12}";
AppsflyerSteamModule()->LogEvent(event_name, event_parameters);

GetAppsFlyerUID

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

メソッドのシグネチャ

std::string GetAppsFlyerUID()

例：

AppsflyerSteamModule()->GetAppsFlyerUID();

IsInstallOlderThanDate

このメソッドは日付文字列を受け取り、ゲームフォルダの修正日が日付文字列より古い場合に true を返します。日付の文字列形式： "2023-January-01 23:12:34"

メソッドのシグネチャ

bool IsInstallOlderThanDate(std::string datestring)

例：

// the modification date in this example is "2023-January-23 08:30:00"

// will return false
bool dateBefore = AppsflyerSteamModule()->IsInstallOlderThanDate("2023-January-01 23:12:34");

// will return true
bool dateAfter = AppsflyerSteamModule()->IsInstallOlderThanDate("2023-April-10 23:12:34");

// example usage with skipFirst -
// skipping if the install date is NOT older than the given date
bool isInstallOlderThanDate = AppsflyerSteamModule()->IsInstallOlderThanDate("2023-January-10 23:12:34");
AppsflyerSteamModule()->Start(!isInstallOlderThanDate);

サンプルアプリの実行

UE4エンジンを開きます。
New Project -> Games -> First Person を選択します。
（Blueprintsの代わりに）C++を選択します。
Name the project AppsFlyerSample and click Create project.
Follow the instructions to implement AppsFlyer in your Steam game.
UE4エンジンエディターからサンプルアプリを起動します。
24時間後にダッシュボードが更新され、オーガニックとノンオーガニックのインストールとアプリ内イベントが表示されます。

SteamゲームにAppsFlyerを実装する

Setup

UE4のサードパーティにSteamが含まれていることを確認します。詳細はこちら
Add the following definitions to Config/DefaultEngine.ini. For reference, see the appsflyer-unreal-steam-sample-app/AppsflyerSteamIntegrationFiles/DefaultEngine.ini file.

+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="OnlineSubsystemSteam.SteamNetDriver",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")

DefaultPlatformService=Steam

bEnabled=true
SteamDevAppId=480 //replace "480" with your steam app id.

NetConnectionClassName="OnlineSubsystemSteam.SteamNetConnection"

Unreal editorでPluginsを開き、Online Subsystem Steamを有効にしてから、エディターを再起動します。
Open the project in your preferred C++ editor and in [YOUR-APP-NAME].Build.cs file, add OpenSSL, OnlineSubsystem, and OnlineSubsystemSteam to your dependencies and HTTP as a private dependency:

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "HeadMountedDisplay", "OpenSSL", "OnlineSubsystem", "OnlineSubsystemSteam" });
PrivateDependencyModuleNames.Add("HTTP");

Unreal Projectファイルの Sourceディレクトリの下に、AppsflyerSteamModule という名前の新しいディレクトリを作成します。
Copy the following files from appsflyer-unreal-steam-sample-app/AppsflyerSteamIntegrationFiles/AppsflyerSteamModule to the new folder:

AppsflyerModule.cpp
AppsflyerSteamModule.cpp
AppsflyerSteamModule.h
DeviceID.h
RequestData.h

プロジェクトファイルを生成し、SSLを開きます。詳細はこちら
In the GameMode.h file, add the StartPlay() function:

UCLASS(minimalapi)
class AAppsFlyerSampleGameMode : public AGameModeBase
{
 GENERATED_BODY()

public:
 AAppsFlyerSampleGameMode();
 virtual void StartPlay() override;
};

Open the Source/AppsFlyerSample/AppsFlyerSampleGameMode.cpp file and add the following include to your GameMode.cpp file:

#include "AppsflyerSteamModule/AppsflyerSteamModule.cpp"

Add the following function, making sure to replace DEV_KEY and STEAM_APP_ID in the init function with your app details:

void AAppsFlyerSampleGameMode::StartPlay()
{
 Super::StartPlay();
 if (SteamAPI_Init()) {
  // init the AF module
  AppsflyerSteamModule()->Init(<< DEV_KEY >>, << STEAM_APP_ID>>)

  // check whether the install date was not older than 2023-January-02 23:12:34
  bool isInstallOlderThanDate = AppsflyerSteamModule()->IsInstallOlderThanDate("2023-January-02 23:12:34");

  // send the firstOpen/session event (if the install date is not older than the given date, the AF module will skip the first-open event)
  AppsflyerSteamModule()->Start(!isInstallOlderThanDate);

  // Use the following code to send in-app event
  // set event name
  std::string event_name = "af_purchase";
  // set json string
  std::string event_parameters = "{\"af_currency\":\"USD\",\"af_price\":6.66,\"af_revenue\":24.12}";
  AppsflyerSteamModule()->LogEvent(event_name, event_parameters);
 }
}

AppsFlyer連携をInitialize（初期化）しstart（開始）します。
Report in-app events.

Adding SteamVR Support

Please use the following guide in order to integrate your steam game with MetaXR

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

Steamクラウドを無効化
Delete the local files and the appsflyer_info file:

Delete the