Link para o repositório
GitHub

Integração do SDK Steam C++ da AppsFlyer

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.

A atribuição do jogo exige que o jogo se comunique com as APIs da AppsFlyer por HTTPS e relate as atividades do usuário, como primeiras aberturas, sessões consecutivas e eventos in-app. Por exemplo, eventos de compra.
Recomendamos que você use este aplicativo de exemplo como referência para integrar o código que relata as atividades do usuário em seu C++. Observação: o código de amostra a seguir é atualmente suportado apenas em um ambiente Windows.

Prerequisites

vcpkg install curl:x86-windows
vcpkg install nlohmann-json:x86-windows
vcpkg install openssl:x86-windows

AppsflyerSteamModule - Interface

AppsflyerSteamModule.h”, incluído no 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, bool collectSteamUid = true)

Usage:

// for regular init
AppsflyerSteamModule()->Init(<< DEV_KEY >>, << STEAM_APP_ID >>);

// for init without reporting steam_uid
AppsflyerSteamModule()->Init(<< DEV_KEY >>, << STEAM_APP_ID >>, false);

Arguments:

  • string STEAM_APP_ID: encontrado no SteamDB.
  • string DEV_KEY: obtenha do profissional de marketing ou do QG da AppsFlyer.
  • bool collectSteamUid: Whether to collect Steam UID or not. True by default.

Start

Este método envia as primeiras solicitações de abertura e /sessão para a AppsFlyer.

Assinatura do método

void Start(bool skipFirst = false)

Usage:

// without the flag
AppsflyerSteamModule()->Start();

// with the flag
bool skipFirst = [SOME_CONDITION];
AppsflyerSteamModule()->Start(skipFirst);

Stop

Once this method is invoked, our SDK no longer communicates with our servers and stops functioning.
Useful when implementing user opt-in/opt-out.

Assinatura do método

void Stop()

Usage:

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

Usage:

json event_parameters = { {"af_currency", "USD"}, {"af_price", 6.66}, {"af_revenue", 24.12} };
std::string event_name = "af_purchase";
AppsflyerSteamModule()->LogEvent(event_name, 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

Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and other devices’ IDs.
This ID is available in raw-data reports and in the Postback APIs for cross-referencing with your internal IDs.
Can be used only before calling Start().

Assinatura do método

void SetCustomerUserId(std::string cuid)

Usage:

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

AppsflyerSteamModule()->GetAppsFlyerUID();

IsInstallOlderThanDate

Este método recebe uma string de data e retorna true se a data de modificação da pasta do jogo for mais antiga que a string de data. O formato da string de data é: "2023-janeiro-01 23:12:34"

Assinatura do método

bool IsInstallOlderThanDate(std::string datestring)

Usage:

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

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

// will return true
bool dateAfter = AppsflyerSteamModule()->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 = AppsflyerSteamModule()->IsInstallOlderThanDate("2023-January-10 23:12:34");
AppsflyerSteamModule()->Start(!isInstallOlderThanDate);

Executando o aplicativo de exemplo

  1. Instale o Visual Studio.
  2. Abra a solução ../appsflyer-steam-sample-app/steam-sample-app/steamworksexample/SteamworksExample.sln.
  3. Abra a pasta Source Files/Main.cpp file.
  4. Na linha 244, substitua DEV_KEY and STEAM_APP_ID com as informações do seu aplicativo.
  5. 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.
    Visual Studio Toolbar Image
  6. 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 jogo Steam

Setup

  1. Copie os arquivos da pasta appsflyer-module pasta em seu projeto C++ em Arquivos de cabeçalho > AppsFlyer.
  2. Importe o módulo:
#include "AppsflyerSteamModule.h"
  1. Importar nlohmann-json.
#include <nlohmann/json.hpp>
using json = nlohmann::json;
  1. Initialize the AppsFlyer integration and call start.
  2. Reporte os eventos in-app.

Excluindo salvamentos na nuvem do Steam (redefinindo a atribuição)

  1. Desative a nuvem do Steam.
  2. Exclua os arquivos locais.
  3. Remove the registry data from SOFTWARE\Microsoft\Windows\CurrentVersion\Run. The Registry keys are AF_counter_[APPID] and AF_uuid_[APPID].