Meta Quest 2 Unreal

리포지토리에 연결
GitHub

AppsFlyer Meta Quest 2 Unreal SDK integration

Integrate your Meta Quest Unreal app or game with AppsFlyer to measure the performance of campaigns marketing these apps.

Game attribution and user measurement require the game to integrate an AppsFlyer SDK that records first opens, sessions, and in-app events. For example, purchase events.

Note: The sample code that follows is currently only supported in a Windows environment.

Prerequisites

• Unreal 엔진 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는 appsflyer-meta-quest2-unreal-sample-app/Quest2_Sample/AppsflyerQuest2Module 폴더에 있으며 앱스플라이어 서버에 연결하고 이벤트를 리포트하는 데 필요한 코드 및 논리가 포함되어 있습니다.

Init

이 메서드는 API 키와 앱 ID를 수신하고 앱스플라이어 모듈을 초기화합니다.

Method signature

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

Usage:

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

Arguments:

• DEV_KEY: 마케터 또는 앱스플라이어 본사에서 얻을 수 있습니다.
• 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 요청을 보냅니다.

Method signature

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
AppsflyerQuest2Module()->Start();

// with the flag
bool skipFirst = [SOME_CONDITION];
AppsflyerQuest2Module()->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.

Method signature

void Stop()

Usage:

// Starting the SDK
AppsflyerQuest2Module()->Start();
// ...
// Stopping the SDK, preventing further communication with AppsFlyer
AppsflyerQuest2Module()->Stop();

LogEvent

이 메서드는 이벤트 이름과 JSON 객체를 수신하고 앱스플라이어에 인앱이벤트를 보냅니다.

Method signature

void LogEvent(std::string event_name, std::string event_values, std::string custom_event_values = "")

인수

• std::string event_name: The name of the event.
• std::string event_parameters: String which contains the predefined event parameters.
• std::string event_custom_parameters [Optional]: String which contains the any custom event parameters. For non-English values, please use UTF-8 encoding.

Usage:

// Setting the event parameters json string and event name
std::string event_name = "af_purchase";
std::string event_parameters = "{\"af_currency\":\"USD\",\"af_revenue\":24.12}";
// Send the InApp event request
AppsflyerQuest2Module()->LogEvent(event_name, event_parameters);

// Set non-English values for testing UTF-8 support
std::wstring ws = L"車B1234 こんにちは";
std::wstring ws2 = L"新人邀约购物日";
std::string event_custom_parameters = "{\"goodsName\":\"" + AppsflyerQuest2Module()->to_utf8(ws) + "\",\"goodsName2\":\"" + AppsflyerQuest2Module()->to_utf8(ws2) + "\"}";
// Send inapp event with custom params
AppsflyerQuest2Module()->LogEvent(event_name, event_parameters, event_custom_parameters);

GetAppsFlyerUID

Get the AppsFlyer unique device ID. The SDK generates an AppsFlyer unique device ID upon app installation. When the SDK is started, this ID is recorded as the ID of the first app install.

Method signature

std::string GetAppsFlyerUID()

Usage:

AppsflyerQuest2Module()->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.

Method signature

void SetCustomerUserId(std::string cuid)

Arguments:

• std::string cuid: Custom user id.

Usage:

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

To_utf8

This method receives a reference of a std::wstring and returns UTF-8 encoded std::string

Method signature

std::string to_utf8(std::wstring& wide_string);

Usage:

// Set non-English values for testing UTF-8 support
std::wstring ws = L"車B1234 こんにちは";
std::wstring ws2 = L"新人邀约购物日";
std::string event_custom_parameters = "{\"goodsName\":\"" + AppsflyerQuest2Module()->to_utf8(ws) + "\",\"goodsName2\":\"" + AppsflyerQuest2Module()->to_utf8(ws2) + "\"}";

IsInstallOlderThanDate

This method receives a date string and returns true if the game folder modification date is older than the date string. The date string format is: "2023-January-01 23:12:34".

Method signature

bool IsInstallOlderThanDate(std::string datestring)

Arguments:

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

Usage:

// 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. 프로젝트 이름을 Quest2_Sample 로 지정하고 프로젝트 생성을 클릭합니다.
4. Follow the instructions to implement AppsFlyer in your game.
5. UE4 엔진 에디터에서 샘플 앱을 실행합니다.
6. 24시간 후 대시보드가 업데이트되고 오가닉 및 논오가닉 인스톨과 인앱이벤트가 표시됩니다.

Implementing AppsFlyer in your Unreal game

Setup

1. 선호하는 C ++ 편집기에서 프로젝트를 연 다음 [YOUR-APP-NAME].Build.cs 파일에 OpenSSL 사용자의 의존성 및 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. 여기서 appsflyer-meta-quest2-unreal-sample-app/AppsflyerQuest2Module 의 다음 파일을 새 폴더로 복사합니다:

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

4. OpenSSL을 추가할 프로젝트 파일을 생성합니다. 더 알아보기

5. 다음 GameMode.h 파일에서 다음 함수를 엽니다: StartPlay() 함수:

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. 다음 함수를 추가하고 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();
	// af module init
	AppsflyerQuest2Module()->Init(<< DEV_KEY >> , << PACKAGE_NAME >> );


	// 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_revenue\":24.12}";
	// af send inapp event
	AppsflyerQuest2Module()->LogEvent(event_name, event_parameters);

	// set non-English values for testing UTF-8 support
	std::wstring ws = L"車B1234 こんにちは";
	std::wstring ws2 = L"新人邀约购物日";
	std::string event_custom_parameters = "{\"goodsName\":\"" + AppsflyerQuest2Module()->to_utf8(ws) + "\",\"goodsName2\":\"" + AppsflyerQuest2Module()->to_utf8(ws2) + "\"}";
	// af send inapp event with custom params
	AppsflyerQuest2Module()->LogEvent(event_name, event_parameters, event_custom_parameters);

	// stop the SDK
	AppsflyerQuest2Module()->Stop();
}

Resetting the attribtion

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