Руководства

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 в папке appsflyer-native-pc-unreal-sample-app/AppsflyerPCModule содержит необходимый код и логику для подключения к серверам AppsFlyer и передачи отчетов по событиям.

Init

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

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

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

Arguments:

  • DEV_KEY: получите у маркетолога или AppsFlyer HQ.
  • APP_ID: Your Appsflyer app id (excluding the nativepc- ).

Usage:

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

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.

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

void Stop()

Usage:

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

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

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

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

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.

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

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

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

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

Этот метод получает строку даты и возвращает 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 = 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 Engine.
  2. Выберите New Project (Новый проект) -> Games (Игры) -> First Person (Первый человек).
  3. Выберите C++ (вместо Blueprints).
  4. Дайте проекту имя AppsFlyerSample и нажмите Create project (Создать проект).
  5. Follow the instructions to implement AppsFlyer in your game.
  6. Запустите пример приложения из редактора UE4 Engine.
  7. Через 24 часа дэшборд обновляется и отображает органические и неорганические установки и внутренние события приложения.

Implementing AppsFlyer in your Unreal game

Setup

  1. Откройте проект в предпочтительном редакторе C++, затем в файле [YOUR-APP-NAME].Build.cs добавьте OpenSSL в свои зависимости и HTTP как частную зависимость:
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. Скопируйте следующие файлы из appsflyer-native-pc-unreal-sample-app/AppsflyerPCModule в новую папку:

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

  3. Сгенерируйте файлы проекта и добавьте OpenSSL. Узнать больше

  4. В GameMode.h добавьте StartPlay() :

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

public:
 AAppsFlyerSampleGameMode();
 virtual void StartPlay() override;
};
  1. Откройте папку Source/[YOUR-APP-NAME]/AppsFlyerSampleGameMode.cpp и добавьте в свой файл GameMode.cpp следующий оператор include:
#include "AppsflyerPCModule/AppsflyerPCModule.h"
using Super = AGameModeBase;
  1. Добавьте следующую функцию, заменив 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

Изменения сохранены 7 месяцев назад