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)
Arguments:
DEV_KEY
: Get from the marketer or AppsFlyer HQ.APP_ID
: Your Appsflyer app id (excluding thenativepc-
tiền tố).
Usage:
AppsflyerPCModule()->Init(<< DEV_KEY >>, << APP_ID >>);
Start
This method sends first open/session requests to AppsFlyer.
Chữ ký phương thức
void Start(bool skipFirst = false)
Đối số
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
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.
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, std::string event_values, std::string custom_event_values = "")
Đối số
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.
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
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
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
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.
Chữ ký phương thức
void SetCustomerUserId(std::string cuid)
Arguments:
std::string cuid
: Custom user id.
Usage:
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
Chữ ký phương thức
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\":\"" + AppsflyerPCModule()->to_utf8(ws) + "\",\"goodsName2\":\"" + AppsflyerPCModule()->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"
Chữ ký phương thức
bool IsInstallOlderThanDate(std::string datestring)
Arguments:
std::string datestring
: Date string inyyyy-mm-ddThh:mm:ss+hh:mm
format.
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, addOpenSSL
to your dependencies andHTTP
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 namedAppsflyerPCModule
. -
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 theStartPlay()
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
andAPP_ID
in theinit
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:
Đã cập nhật 10 tháng trước