Native PC Unreal

編集を提案する

GitHubレポジトリへのリンク

AppsFlyer Native PC 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.

AppsflyerPCModule - Interface

AppsflyerPCModule.h, included in the appsflyer-native-pc-unreal-sample-app/AppsflyerPCModule 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)

例：

AppsflyerPCModule()->Init(<< DEV_KEY >>, << APP_ID >>);

Arguments:

  • DEV_KEY: Get from the marketer or AppsFlyer HQ.
  • APP_ID: Your Appsflyer app id.

Start

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

メソッドのシグネチャ

void Start(bool skipFirst = false)

例：

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

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

Stop

Once this method is invoked, our SDK no longer communicates with our servers and stops functioning.
Useful when implementing user opt-in/opt-out.

メソッドのシグネチャ

void Stop()

例：

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

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}";
AppsflyerPCModule()->LogEvent(event_name, event_parameters);

GetAppsFlyerUID

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

メソッドのシグネチャ

std::string GetAppsFlyerUID()

例：

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

例：

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

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 = AppsflyerPCModule()->IsInstallOlderThanDate("2023-January-01 23:12:34");

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

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

サンプルアプリの実行

  1. UE4エンジンを開きます。
  2. New Project -> Games -> First Person を選択します。
  3. （Blueprintsの代わりに）C++を選択します。
  4. Name the project AppsFlyerSample and click Create project.
  5. Follow the instructions to implement AppsFlyer in your game.
  6. UE4エンジンエディターからサンプルアプリを起動します。
  7. 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:
PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "HeadMountedDisplay", "OpenSSL" });
PrivateDependencyModuleNames.Add("HTTP");

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

  2. Copy the following files from appsflyer-native-pc-unreal-sample-app/AppsflyerPCModule to the new folder:

    • AppsflyerPCModule.cpp
    • AppsflyerPCModule.cpp
    • AppsflyerPCModule.h
    • DeviceID.h
    • RequestData.h

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

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

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

public:
 AAppsFlyerSampleGameMode();
 virtual void StartPlay() override;
};
  1. Open the Source/[YOUR-APP-NAME]/AppsFlyerSampleGameMode.cpp file and add the following include to your GameMode.cpp file.
#include "AppsflyerPCModule/AppsflyerPCModule.h"
using Super = AGameModeBase;
  1. Add the following function, making sure to replace DEV_KEY and APP_ID in the init function with your app details, and report in-app events
void AAppsFlyerSampleGameMode::StartPlay()
{
 Super::StartPlay();
 // af module init
 AppsflyerPCModule()->Init(<< DEV_KEY >>, << APP_ID >>);
 // af send firstopen/session
 AppsflyerPCModule()->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
 AppsflyerPCModule()->LogEvent(event_name, event_parameters);
}

Resetting the attribtion

Delete the appsflyer_info file:

Delete the

更新済 6日前