GitHubレポジトリへのリンク

AppsFlyer Steam C++ SDK integration

AppsFlyerは、クロスプラットフォームアトリビューション、モバイルおよびウェブ分析、ディープリンク、不正検出、プライバシー管理と保全など、実際のペインポイントを解決する強力なツールを提供することで、ゲームマーケティング担当者がより良い意思決定を行えるように支援します。

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

  • あなたのプロジェクトに Steamworks SDKが実装されている
  • vcpkg openssl & nlohmann-jsonパッケージ:
vcpkg install curl:x86-windows
vcpkg install nlohmann-json:x86-windows
vcpkg install openssl:x86-windows

AppsflyerSteamModule - Interface

AppsflyerSteamModule.h”, included in the appsflyer-module folder, contains the required code and logic to connect to AppsFlyer servers and report events.

Init

このメソッドは、お客様のAPIキーとアプリIDを受け取り、AppsFlyer Moduleを初期化します。

メソッドのシグネチャ

void Init(const char* devkey, const char* appID, bool collectSteamUid = true)

Arguments:

  • string STEAM_APP_IDSteamDBから取得できます。
  • string DEV_KEY: Get from the marketer or AppsFlyer HQ.
  • bool collectSteamUid: Whether to collect Steam UID or not. True by default.

例:

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

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

Start

このメソッドは、AppsFlyerに first open / session(初回起動 / セッション)のリクエストを送信します。

メソッドのシグネチャ

void Start(bool skipFirst = false)

引数

  • 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

例:

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

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

メソッドのシグネチャ

void Stop()

例:

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

LogEvent

このメソッドは、イベント名とJSONオブジェクトを受け取り、アプリ内イベントをAppsFlyerに送信します。

メソッドのシグネチャ

void LogEvent(std::string event_name, json event_values, json custom_event_values = {})

引数

  • 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.

例:

// 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
AppsflyerSteamModule()->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", AppsflyerSteamModule()->to_utf8(ws)}, 
    {"goodsName2", AppsflyerSteamModule()->to_utf8(ws2)} 
};
AppsflyerSteamModule()->LogEvent(event_name, event_parameters, custom_event_parameters);

注意:JSONを使用するためには、必ず以下のインポートを使用してください:

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

メソッドのシグネチャ

void SetCustomerUserId(std::string cuid)

Arguments:

  • std::string cuid: Custom user id.

例:

AppsflyerSteamModule()->Init(DEV_KEY, STEAM_APP_ID);
AppsflyerSteamModule()->SetCustomerUserId("Test-18-9-23");
AppsflyerSteamModule()->Start();

OnCallbackSuccess, OnCallbackFailure

上記のメソッドは、成功/失敗時に必要なアクションのプレースホルダーです。
各機能内 (“FIRST_OPEN_REQUEST”, ”SESSION_REQUEST”, ”INAPP_EVENT_REQUEST”) のコンテキストのスイッチケースで、異なる種類のイベントを処理することが可能です。

メソッドのシグネチャ

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

GetAppsFlyerUID

AppsFlyerのユニークデバイスIDを取得します。SDKはアプリのインストール時にAppsFlyerのユニークなデバイスIDを生成します。SDKを起動すると、このIDが最初のアプリインストール時のIDとして記録されます。

メソッドのシグネチャ

std::string GetAppsFlyerUID()

例:

AppsflyerSteamModule()->GetAppsFlyerUID();

To_utf8

This method receives a reference of a std::wstring and returns UTF-8 encoded std::string

メソッドのシグネチャ

std::string to_utf8(std::wstring& wide_string);

例:

std::wstring ws = L"車B1234 こんにちは";
std::wstring ws2 = L"新人邀约购物日";
custom_event_parameters = { 
    {"goodsName", AppsflyerLauncherModule()->to_utf8(ws)}, 
    {"goodsName2", AppsflyerLauncherModule()->to_utf8(ws2)} 
};

IsInstallOlderThanDate

このメソッドは日付文字列を受け取り、ゲームフォルダの修正日が日付文字列より古い場合に true を返します。日付の文字列形式: "2023-January-01 23:12:34"

メソッドのシグネチャ

bool IsInstallOlderThanDate(std::string datestring)

Arguments:

  • std::string datestring: Date string in yyyy-mm-ddThh:mm:ss+hh:mm format.

例:

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

サンプルアプリの実行

  1. Visual Studioをインストールします。
  2. ソリューションを開く ../appsflyer-steam-sample-app/steam-sample-app/steamworksexample/SteamworksExample.sln.
  3. Open the Source Files/Main.cpp file.
  4. On line 244, replace DEV_KEY and STEAM_APP_ID with your app details.
  5. 上部のツールバー(Local Windows Debugger)のPlayをクリックして、アプリを実行します。モードがDebugに設定されていることを確認します。
    Visual Studio Toolbar Image
  6. 24時間後にダッシュボードが更新され、オーガニックとノンオーガニックのインストールとアプリ内イベントが表示されます。

SteamゲームにAppsFlyerを実装する

Setup

  1. Copy the files from the appsflyer-module folder into your C++ project under Header Files > AppsFlyer.
  2. モジュールをインポート:
#include "AppsflyerSteamModule.h"
  1. インポート nlohmann-json.
#include <nlohmann/json.hpp>
using json = nlohmann::json;
  1. Initialize the AppsFlyer integration and call start.
  2. Report in-app events.

Steamのクラウドセーブを削除する(アトリビューションをリセットする)

  1. Steamクラウドを無効化
  2. ローカルファイルの削除
  3. Remove the registry data from SOFTWARE\Microsoft\Windows\CurrentVersion\Run. The Registry keys are AF_counter_[APPID] and AF_uuid_[APPID].