Native PC Unreal

Link to repository
GitHub

AppsFlyer Native PC Unreal SDK integration

AppsFlyer empowers gaming marketers to make better decisions by providing powerful tools to perform cross-platform attribution.

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

This method receives your API key and app ID and initializes the AppsFlyer Module.

Chữ ký phương thức

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

Usage:

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

Arguments:

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

Start

This method sends first open/session requests to AppsFlyer.

Chữ ký phương thức

void Start(bool skipFirst = false)

Usage:

// 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.

Chữ ký phương thức

void Stop()

Usage:

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

LogEvent

This method receives an event name and JSON object and sends in-app events to AppsFlyer.

Chữ ký phương thức

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

Usage:

//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

Nhận ID thiết bị duy nhất của AppsFlyer. SDK sẽ tạo ra một ID thiết bị duy nhất của AppsFlyer khi cài đặt ứng dụng. Khi SDK khởi động, ID này sẽ được ghi nhận là ID của lượt cài đặt ứng dụng đầu tiên.

Chữ ký phương thức

std::string GetAppsFlyerUID()

Usage:

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

Chữ ký phương thức

void SetCustomerUserId(std::string cuid)

Usage:

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

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"

Chữ ký phương thức

bool IsInstallOlderThanDate(std::string datestring)

Usage:

// 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);

Running the sample app

Open the UE4 engine.
Choose New Project > Games > First Person.
Choose C++ (instead of Blueprints).
Name the project AppsFlyerSample and click Create project.
Follow the instructions to implement AppsFlyer in your game.
Launch the sample app from the UE4 engine editor.
After 24 hours, the dashboard updates and shows organic and non-organic installs and in-app events.

Implementing AppsFlyer in your Unreal game

Setup

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");

In your Unreal Project files, under the Source/[YOUR-APP-NAME] directory, create a new directory named AppsflyerPCModule.
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
Generate project files in order to add OpenSSL. Learn more
Trong mục GameMode.h file, add the StartPlay() function:

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

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

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;

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