Native PC C++
Link para o repositório
GitHub
AppsFlyer Native PC C++ SDK integration
A AppsFlyer capacita os profissionais de marketing de jogos a tomar melhores decisões, fornecendo ferramentas poderosas que resolvem problemas reais, incluindo atribuição de plataforma cruzada, análise mobile e da web, deep links, detecção de fraude, gerenciamento e preservação de privacidade e muito mais.
Game attribution requires the game to communicate with AppsFlyer APIs over HTTPS and report user activities like 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 code that reports user activities in your C++.
Note: The sample code that follows is currently only supported in a Windows environment.
Prerequisites
vcpkg openssl & nlohmann-json packages:
vcpkg install curl:x86-windows
vcpkg install nlohmann-json:x86-windows
vcpkg install openssl:x86-windows
AppsflyerLauncherModule - Interface
AppsflyerLauncherModule.h
, incluído na pasta appsflyer-module
, contém o código e a lógica necessários para se conectar aos servidores da AppsFlyer e relatar eventos.
Init
Este método recebe sua chave de API e ID do aplicativo e inicializa o módulo da AppsFlyer.
Assinatura do método
void Init(const char* devkey, const char* appID)
Usage:
AppsflyerLauncherModule()->Init(<< DEV_KEY >>, << APP_ID >>);
Arguments:
APP_ID
: Your app id (excluding thenativepc-
).DEV_KEY
: obtenha do profissional de marketing ou do QG da AppsFlyer.
Start
Este método envia as primeiras solicitações de abertura/sessão para a AppsFlyer.
Assinatura do 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
AppsflyerLauncherModule()->Start();
// with the flag
bool skipFirst = [SOME_CONDITION];
AppsflyerLauncherModule()->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.
Assinatura do método
void Stop()
Usage:
// Starting the SDK
AppsflyerLauncherModule()->Start();
// ...
// Stopping the SDK, preventing further communication with AppsFlyer
AppsflyerLauncherModule()->Stop();
LogEvent
Esse método recebe um nome de evento e um objeto JSON e envia eventos in-app para a AppsFlyer.
Assinatura do método
void LogEvent(std::string event_name, json event_values, json custom_event_values = {})
Argumentos
std::string event_name
-json event_parameters
: dictionary object which contains the predefined event parameters.json 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 values json and event name
std::string event_name = "af_purchase";
json event_parameters = { {"af_currency", "USD"}, {"af_revenue", 24.12} };
// Send LogEvent request
AppsflyerLauncherModule()->LogEvent(event_name, event_parameters);
// Send LogEvent request with custom event params and UTF8 encoding (for non-English characters)
std::wstring ws = L"車B1234 こんにちは";
std::wstring ws2 = L"新人邀约购物日";
json custom_event_parameters = {
{"goodsName", AppsflyerLauncherModule()->to_utf8(ws)},
{"goodsName2", AppsflyerLauncherModule()->to_utf8(ws2)}
};
AppsflyerLauncherModule()->LogEvent(event_name, event_parameters, custom_event_parameters);
Observação: para usar o JSON, certifique-se de usar as seguintes importações:
#include <nlohmann/json.hpp>
using json = nlohmann::json;
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.
Assinatura do método
void SetCustomerUserId(std::string cuid)
Arguments:
std::string cuid
: Custom user id.
Usage:
AppsflyerLauncherModule()->Init(DEV_KEY, APP_ID);
AppsflyerLauncherModule()->SetCustomerUserId("Test-18-9-23");
AppsflyerLauncherModule()->Start();
OnCallbackSuccess, OnCallbackFailure
Os métodos acima são placeholders para as ações desejadas em caso de sucesso/falha.
É possível lidar com diferentes tipos de eventos com o switch case do contexto dentro de cada função (“FIRST_OPEN_REQUEST”, ”SESSION_REQUEST”, ”INAPP_EVENT_REQUEST”).
Assinatura do método
void OnCallbackSuccess(long responseCode, uint64 context)
void OnCallbackFailure(long responseCode, uint64 context)
GetAppsFlyerUID
Obter o ID do dispositivo exclusivo da AppsFlyer. O SDK gera um ID de dispositivo exclusivo da AppsFlyer na instalação do aplicativo. Quando o SDK é iniciado, esse ID é registrado como o ID da primeira instalação do aplicativo.
Assinatura do método
std::string GetAppsFlyerUID()
Usage:
AppsflyerLauncherModule()->GetAppsFlyerUID();
To_utf8
This method receives a reference of a std::wstring
and returns UTF-8 encoded std::string
Assinatura do método
std::string to_utf8(std::wstring& wide_string);
Usage:
std::wstring ws = L"車B1234 こんにちは";
std::wstring ws2 = L"新人邀约购物日";
custom_event_parameters = {
{"goodsName", AppsflyerLauncherModule()->to_utf8(ws)},
{"goodsName2", AppsflyerLauncherModule()->to_utf8(ws2)}
};
IsInstallOlderThanDate
This method receives a date string and returns true if the game exe modification date is older than the date string. The date string format is: "2023-January-01 23:12:34"
Assinatura do 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 = AppsflyerLauncherModule()->IsInstallOlderThanDate("2023-January-01 23:12:34");
// will return true
bool dateAfter = AppsflyerLauncherModule()->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 = AppsflyerLauncherModule()->IsInstallOlderThanDate("2023-January-10 23:12:34");
AppsflyerLauncherModule()->Start(!isInstallOlderThanDate);
Executando o aplicativo de exemplo
- Instale o Visual Studio.
- Abra a solução.
- Abra a pasta
AppsflyerSampleApp.cpp
file. - On line 110, replace
DEV_KEY
andAPP_ID
com as informações do seu aplicativo. - Execute o aplicativo clicando em Reproduzir na barra de ferramentas superior (Depurador local do Windows). Certifique-se de que o modo esteja definido como Debug.
- Após 24 horas, o painel é atualizado e mostra instalações orgânicas e não orgânicas e eventos in-app.
Implementando a AppsFlyer em seu aplicativo C++
Setup
- Copie os arquivos da pasta
appsflyer-module
pasta em seu projeto C++ em Arquivos de cabeçalho > AppsFlyer. - Importe o módulo:
#include "AppsflyerLauncherModule.h"
- Importar
nlohmann-json
:
#include <nlohmann/json.hpp>
using json = nlohmann::json;
- Inicialize e inicie a integração da AppsFlyer.
- Reporte os eventos in-app.
Resetting the attribution
Remove the registry data from SOFTWARE\Microsoft\Windows\CurrentVersion\Run
. The Registry keys are AF_counter_[APPID]
and AF_uuid_[APPID]
.
Deleting AppsFlyer data on uninstall
When uninstalling your app, please make sure to remove the registry data from SOFTWARE\Microsoft\Windows\CurrentVersion\Run
. The Registry keys are AF_counter_[APPID]
and AF_uuid_[APPID]
.
Atualizado 4 meses atrás