Native PC Unreal

Enlace al repositorio de
GitHub

AppsFlyer Native PC Unreal SDK integration

AppsFlyer permite a los marketers de gaming tomar mejores decisiones al proporcionarles potentes herramientas para realizar atribuciones multiplataforma.

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, incluido en appsflyer-native-pc-unreal-sample-app/AppsflyerPCModule , contiene el código y la lógica necesarios para conectarse a los servidores de AppsFlyer y reportar eventos.

Init

Este método recibe tu clave API e ID de aplicación e inicializa el módulo AppsFlyer.

Firma de método

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

Arguments:

DEV_KEY: puedes obtenerlo del marketer o en AppsFlyer HQ.
APP_ID: Your Appsflyer app id (excluding the nativepc- ).

Usage:

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

Start

Este método envía las solicitudes de primeros inicios/sesiones a AppsFlyer.

Firma de método

void Start(bool skipFirst = false)

Argumentos

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.

Firma de método

void Stop()

Usage:

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

LogEvent

Este método recibe un nombre de evento y un objeto json y envía eventos in-app a AppsFlyer.

Firma de método

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

Argumentos

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

Obtén el ID de dispositivo único de AppsFlyer. El SDK genera un ID de dispositivo único de AppsFlyer tras la instalación de la aplicación. Cuando se inicia el SDK, este ID se registra como el ID de la primera instalación de la aplicación.

Firma de método

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.

Firma de método

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

Firma de método

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

Este método recibe una cadena de fecha y devuelve true si la fecha de modificación de la carpeta del juego es más antigua que la cadena de fecha. El formato de cadena de fecha es: "2023-January-01 23:12:34".

Firma de método

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

Ejecución de la aplicación de muestra

Abre el motor de UE4.
Elige New Project (Nuevo proyecto) > Games (Juegos) > First Person (Primera persona).
Selecciona C++ (en lugar de Blueprints).
Nombra el proyecto AppsFlyerSample y haz clic en Create project (Crear proyecto).
Follow the instructions to implement AppsFlyer in your game.
Inicia la aplicación de muestra desde el editor del motor de UE4.
Después de 24 horas, el panel de control se actualiza y muestra las instalaciones orgánicas y no orgánicas y los eventos in-app.

Implementing AppsFlyer in your Unreal game

Setup

Abre el proyecto en tu editor de C++ preferido y en el archivo [YOUR-APP-NAME].Build.cs , y agrega OpenSSL a tus dependencias y HTTP como dependencia privada:

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.
Copia los siguientes archivos desde appsflyer-native-pc-unreal-sample-app/AppsflyerPCModule a la nueva carpeta:
- AppsflyerPCModule.cpp
- AppsflyerPCModule.cpp
- AppsflyerPCModule.h
- DeviceID.h
- RequestData.h
Genera archivos de proyecto con el fin de agregar OpenSSL. Aprender más
En el GameMode.h , agrega la StartPlay() :

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

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

Abre la carpeta Source/[YOUR-APP-NAME]/AppsFlyerSampleGameMode.cpp y agrega el siguiente include a tu archivo GameMode.cpp.

#include "AppsflyerPCModule/AppsflyerPCModule.h"
using Super = AGameModeBase;

Agrega la siguiente función, asegurándote de reemplazar el 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