ガイド

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)

Arguments:

  • DEV_KEY: Get from the marketer or AppsFlyer HQ.
  • APP_ID: Your Appsflyer app id (excluding the nativepc- prefix).

例：

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

Start

このメソッドは、first open / session（初回起動 / セッション）リクエストを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
AppsflyerPCModule()->Start();

// with the flag
bool skipFirst = [SOME_CONDITION];
AppsflyerPCModule()->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
AppsflyerPCModule()->Start();
// ...
// Stopping the SDK, preventing further communication with AppsFlyer
AppsflyerPCModule()->Stop();

LogEvent

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

メソッドのシグネチャ

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

引数

  • std::string event_name-
  • std::string event_parameters: dictionary object which contains the predefined event parameters.
  • std::string event_custom_parameters (non-mandatory): dictionary object which contains the any custom event parameters. For non-English values, please use UTF-8 encoding.

例：

// 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
AppsflyerPCModule()->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\":\"" + AppsflyerPCModule()->to_utf8(ws) + "\",\"goodsName2\":\"" + AppsflyerPCModule()->to_utf8(ws2) + "\"}";
// Send inapp event with custom params
AppsflyerPCModule()->LogEvent(event_name, event_parameters, event_custom_parameters);

GetAppsFlyerUID

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

メソッドのシグネチャ

std::string GetAppsFlyerUID()

例：

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

Arguments:

  • std::string cuid: Custom user id.

例：

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

To_utf8

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

メソッドのシグネチャ

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

例：

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

IsInstallOlderThanDate

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

メソッドのシグネチャ

bool IsInstallOlderThanDate(std::string datestring)

Arguments:

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

例：

// 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(<< DevKey >>, << AppID >>);

   // 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_revenue\":24.12}";
   // af send inapp event
   AppsflyerPCModule()->LogEvent(event_name, event_parameters);
   if (AppsflyerPCModule()->IsInstallOlderThanDate("2025-January-01 23:12:34")) {
      UE_LOG(LogTemp, Warning, TEXT("2025-January-01 23:12:34: true"));
   }
   else {
      UE_LOG(LogTemp, Warning, TEXT("2025-January-01 23:12:34: false"));
   }
   if (AppsflyerPCModule()->IsInstallOlderThanDate("2023-January-01 23:12:34")) {
      UE_LOG(LogTemp, Warning, TEXT("2023-January-01 23:12:34: true"));
   }
   else {
      UE_LOG(LogTemp, Warning, TEXT("2023-January-01 23:12:34: false"));
   }

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

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

Resetting the attribtion

Delete the appsflyer_info file:

Delete the

更新済 8か月前