Unreal Epic
Enlace al repositorio de
GitHub
Integración del SDK de AppsFlyer con Unreal Epic
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 Epic game.
Note: The sample code that follows is currently only supported in a Windows environment.
Prerequisites
- Unreal Engine 4.2x.
- Subsistema EOS integrado dentro de tu UE4 (generalmente está incluido en los recursos de terceros de UE4 y no es necesario descargarlo).
AppsflyerEpicModule - Interfaz
AppsflyerEpicModule.h
, incluido en appsflyer-unreal-epic-sample-app/AppsflyerEpicIntegrationFiles/AppsflyerEpicModule
, 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:
EPIC_APP_ID
: Your Epic app id.DEV_KEY
: puedes obtenerlo del marketer o en AppsFlyer HQ.
Usage:
AppsflyerEpicModule()->Init(<< DEV_KEY >>, << EPIC_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)
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.
Firma de método
void Stop()
Usage:
// Starting the SDK
AppsflyerEpicModule()->Start();
// ...
// Stopping the SDK, preventing further communication with AppsFlyer
AppsflyerEpicModule()->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
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
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:
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.
Firma de método
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
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\":\"" + AppsflyerEpicModule()->to_utf8(ws) + "\",\"goodsName2\":\"" + AppsflyerEpicModule()->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 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 = 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);
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). - Sigue las instrucciones para implementar AppsFlyer en tu juego de Epic.
- 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.
Implementación de AppsFlyer en tu juego de Epic
Setup
- Asegúrate de que Epic esté en tus recursos de terceros de UE4. Aprender más
- Agrega las siguientes definiciones a
Config/DefaultEngine.ini
cuando reemplaces las credencialesconfidential
con tus credenciales de EOS. . Como referencia, consulta el archivoappsflyer-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.
- Abre el proyecto en tu editor de C++ preferido y en el archivo
[YOUR-APP-NAME].Build.cs
, y agregaOpenSSL
,OnlineSubsystem
yOnlineSubsystemEOS
a tus dependencias yHTTP
como dependencia privada:
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.
-
Copia los siguientes archivos desde
appsflyer-unreal-epic-sample-app/AppsflyerEpicIntegrationFiles/AppsflyerEpicModule
a la nueva carpeta:- AppsflyerModule.cpp
- AppsflyerEpicModule.cpp
- AppsflyerEpicModule.h
- DeviceID.h
- RequestData.h
-
Genera archivos de proyecto con el fin de agregar OpenSSL. Aprender más
-
En el
GameMode.h
, agrega laStartPlay()
:
UCLASS(minimalapi)
class AAppsFlyerSampleGameMode : public AGameModeBase
{
GENERATED_BODY()
public:
AAppsFlyerSampleGameMode();
virtual void StartPlay() override;
};
- Abre la carpeta
Source/AppsFlyerSample/AppsFlyerSampleGameMode.cpp
y agrega el siguiente include a tu archivo GameMode.cpp.
#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;
- Agrega la siguiente función, asegurándote de reemplazar el
DEV_KEY
andEPIC_APP_ID
in the funcióninit
con los detalles de tu aplicación e inicializa el SDK de EOS con tus datos de 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;
}
}
- Reporta los eventos in-app.
Resetting the attribtion
Delete the appsflyer_info
file:
Actualizado hace 10 meses