Unreal Epic

Ссылка на репозиторий
GitHub

Интеграция SDK AppsFlyer в Unreal Epic

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 Epic game.

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

Prerequisites

Unreal Engine 4.2x.
Подсистема EOS, интегрированная в ваш UE4 (обычно включена в сторонние библиотеки UE4, скачивание не требуется).

AppsflyerEpicModule — интерфейс

AppsflyerEpicModule.h в папке appsflyer-unreal-epic-sample-app/AppsflyerEpicIntegrationFiles/AppsflyerEpicModule содержит необходимый код и логику для подключения к серверам AppsFlyer и передачи отчетов по событиям.

Init

Данный метод содержит ваш ключ API и идентификатор приложения и инициализирует модуль AppsFlyer.

Сигнатура метода

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

Arguments:

EPIC_APP_ID: Your Epic app id.
DEV_KEY: получите у маркетолога или AppsFlyer HQ.

Usage:

AppsflyerEpicModule()->Init(<< DEV_KEY >>, << EPIC_APP_ID >>);

Start

Данный метод передает запросы «first open/session» в AppsFlyer.

Сигнатура метода

void Start(bool skipFirst = false)

Arguments:

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

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

Usage:

// Starting the SDK
AppsflyerEpicModule()->Start();
// ...
// Stopping the SDK, preventing further communication with AppsFlyer
AppsflyerEpicModule()->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.

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

GetAppsFlyerUID

Получение от AppsFlyer уникального идентификатора устройства. SDK генерирует уникальный идентификатор устройства AppsFlyer при установке приложения. При запуске SDK этот идентификатор записывается как идентификатор первой установки приложения.

Сигнатура метода

std::string GetAppsFlyerUID()

Usage:

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

Usage:

AppsflyerEpicModule()->Init(DEV_KEY, APP_ID);
AppsflyerEpicModule()->SetCustomerUserId("Test-18-9-23");
AppsflyerEpicModule()->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);

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\":\"" + AppsflyerEpicModule()->to_utf8(ws) + "\",\"goodsName2\":\"" + AppsflyerEpicModule()->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.

Usage:

// the modification date in this example is "2023-January-23 08:30:00"

// will return false
bool dateBefore = AppsflyerEpicModule()->IsInstallOlderThanDate("2023-January-01 23:12:34");

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

// example usage with skipFirst -
// skipping if the install date is NOT older than the given date
bool isInstallOlderThanDate = AppsflyerEpicModule()->IsInstallOlderThanDate("2023-January-10 23:12:34");
AppsflyerEpicModule()->Start(!isInstallOlderThanDate);

Запуск примера приложения

Откройте UE4 Engine.
Выберите New Project (Новый проект) -> Games (Игры) -> First Person (Первый человек).
Выберите C++ (вместо Blueprints).
Дайте проекту имя AppsFlyerSample и нажмите Create project (Создать проект).
Следуйте инструкциям по внедрению AppsFlyer в вашу игру Epic.
Запустите пример приложения из редактора UE4 Engine.
Через 24 часа дэшборд обновляется и отображает органические и неорганические установки и внутренние события приложения.

Внедрение AppsFlyer в вашу игру Epic

Setup

Убедитесь, что Epic включен в сторонние библиотеки UE4. Узнать больше
Добавьте следующие определения в Config/DefaultEngine.ini при замене учетных данных confidential учетными данными EOS. См. appsflyer-unreal-Epic-sample-app/AppsflyerEpicIntegrationFiles/DefaultEngine.ini file.

[OnlineSubsystem]
DefaultPlatformService=EOSPlus

[OnlineSubsystemEOS]
bEnabled=true

[OnlineSubsystemEOSPlus]
bEnabled=true

[/Script/OnlineSubsystemEOS.NetDriverEOS]
bIsUsingP2PSockets=true
NetConnectionClassName="OnlineSubsystemEOS.NetConnectionEOS"

[/Script/OnlineSubsystemEOS.EOSSettings]
CacheDir=CacheDir
DefaultArtifactName=Confidential
TickBudgetInMilliseconds=0
bEnableOverlay=False
bEnableSocialOverlay=False
bShouldEnforceBeingLaunchedByEGS=False
TitleStorageReadChunkLength=0
+Artifacts=(ArtifactName="Confidential",ClientId="Confidential",ClientSecret="Confidential",ProductId="Confidential",SandboxId="Confidential",DeploymentId="Confidential",EncryptionKey="Confidential")
bUseEAS=False
bUseEOSConnect=True
bMirrorStatsToEOS=False
bMirrorAchievementsToEOS=False
bUseEOSSessions=True
bMirrorPresenceToEAS=False

In your Unreal editor, go to Plugins, activate Online Subsystem EOS, and then restart the editor.
Откройте проект в предпочтительном редакторе C++, затем в файле [YOUR-APP-NAME].Build.cs добавьте OpenSSL, OnlineSubsystem и OnlineSubsystemEOS в свои зависимости и HTTP как частную зависимость:

PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "HeadMountedDisplay", "OpenSSL", "OnlineSubsystem", "OnlineSubsystemEOS" });
PrivateDependencyModuleNames.Add("HTTP");

In your Unreal Project files, under the Source directory, create a new directory named AppsflyerEpicModule.
Скопируйте следующие файлы из appsflyer-unreal-epic-sample-app/AppsflyerEpicIntegrationFiles/AppsflyerEpicModule в новую папку:
- AppsflyerModule.cpp
- AppsflyerEpicModule.cpp
- AppsflyerEpicModule.h
- DeviceID.h
- RequestData.h
Сгенерируйте файлы проекта и добавьте OpenSSL. Узнать больше
В GameMode.h добавьте StartPlay() :

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

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

Откройте папку Source/AppsFlyerSample/AppsFlyerSampleGameMode.cpp и добавьте в свой файл GameMode.cpp следующий оператор include:

#include "AppsflyerEpicModule/AppsflyerEpicModule.cpp"
#include <ThirdParty/EOSSDK/SDK/Include/eos_init.h>
#include <ThirdParty/EOSSDK/SDK/Include/eos_sdk.h>
#include <EOSSDK/SDK/Include/eos_userinfo.h>
using Super = AGameModeBase;

Добавьте следующую функцию, заменив DEV_KEY and EPIC_APP_ID in the функции init на данные своего приложения, и инициализируйте SDK EOS данными о вашем EOS.

void AEpicTestGameMode::StartPlay()
{
 Super::StartPlay();

 EOS_InitializeOptions SDKOptions;
 SDKOptions.ApiVersion = EOS_INITIALIZE_API_LATEST;
 SDKOptions.AllocateMemoryFunction = NULL;
 SDKOptions.ReallocateMemoryFunction = NULL;
 SDKOptions.ReleaseMemoryFunction = NULL;
 SDKOptions.ProductName = "PRODUCT_NAME";
 SDKOptions.ProductVersion = "1.0";
 SDKOptions.Reserved = NULL;
 SDKOptions.SystemInitializeOptions = NULL;
 EOS_EResult res = EOS_Initialize(&SDKOptions);

 if (res == EOS_EResult::EOS_Success || res == EOS_EResult::EOS_AlreadyConfigured) {
  EOS_Platform_Options PlatformOptions;
  PlatformOptions.ApiVersion = EOS_PLATFORM_OPTIONS_API_LATEST;
  PlatformOptions.Reserved = NULL;
  PlatformOptions.bIsServer = false;
  PlatformOptions.EncryptionKey = NULL;
  PlatformOptions.OverrideCountryCode = NULL;
  PlatformOptions.OverrideLocaleCode = NULL;
  PlatformOptions.ProductId = "PRODUCT_ID";
  EOS_Platform_ClientCredentials cCreds;
  cCreds.ClientId = "CLIENT_ID";
  cCreds.ClientSecret = "CLIENT_SECRET";
  PlatformOptions.ClientCredentials = cCreds;
  PlatformOptions.SandboxId = "SANDBOX_ID";
  PlatformOptions.DeploymentId = "DEPLOYMENT_ID";
  PlatformOptions.EncryptionKey = "ENCRYPTION_KEY";
  EOS_HPlatform platform = EOS_Platform_Create(&PlatformOptions);
   
	// af module init
	AppsflyerEpicModule()->Init(<< DevKey >>, << AppID >>);

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

   // stop the SDK
   AppsflyerEpicModule()->Stop();
 }
 else {
  UE_LOG(LogTemp, Warning, TEXT("EOS FAIL"));
  return;
 }
}

Передайте отчет о внутренних событиях приложения

Resetting the attribtion

Delete the appsflyer_info file:

Delete the