Meta Quest 2 Unreal

GitHubレポジトリへのリンク

AppsFlyer Meta Quest 2 Unreal 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 Unreal game. Note: The sample code that follows is currently only supported in a Windows environment.

Prerequisites

• Unreal Engine 4.2x.
• Follow the Quest Integration guide for Quest 2 and Unreal Engine.
• Follow the Quest 2 & Unreal 4.27 integration guide.

AppsflyerQuest2Module - Interface

AppsflyerQuest2Module.h, included in the appsflyer-meta-quest2-unreal-sample-app/Quest2_Sample/AppsflyerQuest2Module 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)

例：

AppsflyerQuest2Module()->Init(<< DEV_KEY >>, << QUEST_APP_ID >>);

Arguments:

• DEV_KEY: Get from the marketer or AppsFlyer HQ.
• QUEST_APP_ID: Your Quest Store app ID (For Quest 2, it's the number in the store URL - for example: https://www.oculus.com/experiences/quest/XXXXXXXXXXXXXXXX/).

Start

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

メソッドのシグネチャ

void Start(bool skipFirst = false)

例：

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

// with the flag
bool skipFirst = [SOME_CONDITION];
AppsflyerQuest2Module()->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}";
AppsflyerQuest2Module()->LogEvent(event_name, event_parameters);

GetAppsFlyerUID

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

メソッドのシグネチャ

std::string GetAppsFlyerUID()

例：

AppsflyerQuest2Module()->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(std::string cuid)

例：

AppsflyerQuest2Module()->Init(DEV_KEY, APP_ID);
AppsflyerQuest2Module()->SetCustomerUserId("Test-18-9-23");
AppsflyerQuest2Module()->Start();

IsInstallOlderThanDate

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

メソッドのシグネチャ

bool IsInstallOlderThanDate(std::string datestring)

例：

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

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

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

// example usage with skipFirst:
bool isInstallOlderThanDate = AppsflyerLauncherModule()->IsInstallOlderThanDate("2023-April-10 23:12:34");
AppsflyerLauncherModule()->Start(isInstallOlderThanDate);

サンプルアプリの実行

1. UE4エンジンを開きます。
2. Choose New Project > Games > Virtual Reality.
3. Name the project Quest2_Sample and click Create project.
4. Follow the instructions to implement AppsFlyer in your game.
5. UE4エンジンエディターからサンプルアプリを起動します。
6. 24時間後にダッシュボードが更新され、オーガニックとノンオーガニックのインストールとアプリ内イベントが表示されます。

Implementing AppsFlyer in your Unreal game

Setup

1. Open the project in your preferred C++ editor and in the [YOUR-APP-NAME].Build.cs file, add OpenSSL to your dependencies and HTTP as a private dependency:
   (example can be found in /Quest2_Sample/Quest2_Sample.Build)

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

2. In your Unreal Project files, under the Source/[YOUR-APP-NAME] directory, create a new directory named AppsflyerQuest2Module.

3. Copy the following files from appsflyer-meta-quest2-unreal-sample-app/AppsflyerQuest2Module to the new folder:

   • AppsflyerQuest2Module.cpp
   • AppsflyerQuest2Module.cpp
   • AppsflyerQuest2Module.h
   • DeviceID.h
   • RequestData.h

4. OpenSSLを追加するためのプロジェクトファイルを生成します。詳細はこちら

5. In the GameMode.h file, add the StartPlay() function:

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

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

6. Create a C++ Actor Component, attach it to a object of your choice, and add the following lines:
   (Alternatively you may use the example component: Quest2_Sample/Private/AF_ActorComponent.cpp)

#include "../AppsflyerQuest2Module/AppsflyerQuest2Module.h"

7. Add the following function, making sure to replace DEV_KEY and QUEST_APP_ID in the init function with your app details, and report in-app events

void UAF_ActorComponent::BeginPlay()
{
	Super::BeginPlay();
	AppsflyerQuest2Module()->Init(<< DEV_KEY >>, << QUEST_APP_ID >>);
	// af send firstopen/session
	AppsflyerQuest2Module()->Start();
	//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}";
	// af send inapp event
	AppsflyerQuest2Module()->LogEvent(event_name, event_parameters);
	// ...	
}

Resetting the attribtion

Delete the APK from your Oculus Device and then Re-deploy (a new AppsFlyerUID will be created).