Native PC C++

Đề xuất Chỉnh sửa

Link to repository
GitHub

AppsFlyer Native PC C++ SDK integration

AppsFlyer empowers gaming marketers to make better decisions by providing powerful tools that solve real pain points, including cross-platform attribution, mobile and web analytics, deep linking, fraud detection, privacy management and preservation, and more.

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, included in the appsflyer-module folder, contains the required code and logic to connect to AppsFlyer servers and report events.

Init

This method receives your API key and app ID and initializes the AppsFlyer Module.

Chữ ký phương thức

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

Usage:

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

Arguments:

  • APP_ID: Your app id.
  • DEV_KEY: Get from the marketer or AppsFlyer HQ.

Start

This method sends first open/session requests to AppsFlyer.

Chữ ký phương thức

void Start(bool skipFirst = false)

Usage:

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

// with the flag
bool skipFirst = [SOME_CONDITION];
AppsflyerLauncherModule()->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.

Chữ ký phương thức

void Stop()

Usage:

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

LogEvent

This method receives an event name and JSON object and sends in-app events to AppsFlyer.

Chữ ký phương thức

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";
AppsflyerLauncherModule()->LogEvent(event_name, event_parameters);

Note: To use the JSON, make sure to use the following imports:

#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().

Chữ ký phương thức

void SetCustomerUserId(std::string cuid)

Usage:

AppsflyerLauncherModule()->Init(DEV_KEY, APP_ID);
AppsflyerLauncherModule()->SetCustomerUserId("Test-18-9-23");
AppsflyerLauncherModule()->Start();

OnCallbackSuccess, OnCallbackFailure

The above methods are placeholders for the desired actions upon success/failure.
It is possible to handle different types of events with the switch case of the context within each function (“FIRST_OPEN_REQUEST”, ”SESSION_REQUEST”, ”INAPP_EVENT_REQUEST”).

Chữ ký phương thức

void OnCallbackSuccess(long responseCode, uint64 context)
void OnCallbackFailure(long responseCode, uint64 context)

GetAppsFlyerUID

Nhận ID thiết bị duy nhất của AppsFlyer. SDK sẽ tạo ra một ID thiết bị duy nhất của AppsFlyer khi cài đặt ứng dụng. Khi SDK khởi động, ID này sẽ được ghi nhận là ID của lượt cài đặt ứng dụng đầu tiên.

Chữ ký phương thức

std::string GetAppsFlyerUID()

Usage:

AppsflyerLauncherModule()->GetAppsFlyerUID();

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"

Chữ ký phương thức

bool IsInstallOlderThanDate(std::string datestring)

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

Running the sample app

  1. Install Visual Studio.
  2. Open the solution.
  3. Open the AppsflyerSampleApp.cpp file.
  4. On line 110, replace DEV_KEY and APP_ID with your app details.
  5. Run the app by clicking Play on the top toolbar (Local Windows Debugger). Make sure that the mode is set to Debug.
  6. After 24 hours, the dashboard updates and shows organic and non-organic installs and in-app events.

Implementing AppsFlyer in your C++ app

Setup

  1. Copy the files from the appsflyer-module folder into your C++ project under Header Files > AppsFlyer.
  2. Import the Module:
#include "AppsflyerLauncherModule.h"
  1. Nhập nlohmann-json:
#include <nlohmann/json.hpp>
using json = nlohmann::json;
  1. Initialize and start the AppsFlyer integration.
  2. Report in-app events.

Resetting the attribution

Remove the registry data from SOFTWARE\Microsoft\Windows\CurrentVersion\Run. The Registry keys are AF_counter_[APPID] and AF_uuid_[APPID].

Đã cập nhật 6 ngày trước