Skip to content
Tools
/
SDKs and Tools
/
/
Unreal Engine SDK API Ref...
Last updated

FAnalyticsProviderTreasureData

概要

class FAnalyticsProviderTreasureData;

Treasure Data の Unreal Engine Analytics Provider プラグイン。このSDKはイベントを追加すると同時にアップロードします。ローカルバッファは使用しません。

パブリック型

enum FAnalyticsRegion

列挙子値説明
US01USA - us01.records.in.treasuredata.com
AP01Japan - ap01.records.in.treasuredata.com
AP02Korea - ap02.records.in.treasuredata.com
EU01Europe - eu01.records.in.treasuredata.com

正しい選択を確認するために、組織の設定を確認してください。

パブリック関数

Create

static inline TSharedPtr< IAnalyticsProvider > Create(
    const FString Key,
    const FString DBName,
    FAnalyticsRegion Region
)

Treasure Data インスタンスを作成します。すべてのイベントは Sessions と Events の2つのテーブルに記録されます。

パラメータ説明
Key書き込み専用 API キー
DBNameデータのログ先データベース名。最大120文字
RegionTD アカウントリージョン

戻り値: TD Analytics Provider インスタンス

Destroy

static inline void Destroy()

Treasure Data インスタンスからすべての設定データを削除します。

StartSession

virtual bool StartSession(
    const TArray< FAnalyticsEventAttribute > & Attributes
) override

セッションを開始します

パラメータ説明
Attributes追加のイベント属性

戻り値: bool セッションが正常に開始された場合は true

EndSession

virtual void EndSession() override

セッションを終了します

SetUserID

virtual void SetUserID(
    const FString & InUserID
) override

ユーザーの ID を設定します

パラメータ説明
InUserIDユーザー ID を表す文字列。できるだけ一意であることが望ましいです

GetUserID

virtual FString GetUserID() const override

ユーザーの ID を取得します

戻り値: FString ユーザー ID を表す文字列

GetSessionID

virtual FString GetSessionID() const override

現在のセッション ID を取得します

戻り値: FString 現在のセッション ID を表す文字列

SetSessionID

virtual bool SetSessionID(
    const FString & InSessionID
) override

ユーザーのセッション ID を設定します

パラメータ説明
InSessionID文字列としてのセッション ID

戻り値: bool セッション ID が正常に設定された場合は true

RecordEvent

virtual void RecordEvent(
    const FString & EventName,
    const TArray< FAnalyticsEventAttribute > & Attributes
) override

イベントを記録します

パラメータ説明
EventNameイベント名
Attributes配列としての属性

RecordItemPurchase

virtual void RecordItemPurchase(
    const FString & ItemId,
    const FString & Currency,
    int PerItemCost,
    int ItemQuantity
) override

アイテムの購入を記録します

パラメータ説明
ItemIdアイテムの ID を表す文字列
Currency通貨の ID を表す文字列
PerItemCostアイテムのコスト（整数）
ItemQuantityアイテムの数

RecordCurrencyPurchase

virtual void RecordCurrencyPurchase(
    const FString & GameCurrencyType,
    int GameCurrencyAmount,
    const FString & RealCurrencyType,
    float RealMoneyCost,
    const FString & PaymentProvider
) override

通貨の購入を記録します

パラメータ説明
GameCurrencyType文字列としての通貨タイプ
GameCurrencyAmount整数としての通貨量
RealCurrencyType文字列としての通貨タイプ
RealMoneyCostfloat としての実際の費用（ドル）
PaymentProvider文字列としての決済プロバイダー

RecordCurrencyGiven

virtual void RecordCurrencyGiven(
    const FString & GameCurrencyType,
    int GameCurrencyAmount
) override

ユーザーに付与された通貨を記録します

パラメータ説明
GameCurrencyType文字列としてのゲーム内通貨タイプ
GameCurrencyAmount整数としてのゲーム内通貨量

SetBuildInfo

virtual void SetBuildInfo(
    const FString & InBuildInfo
) override

ビルド情報を設定します

パラメータ説明
InBuildInfo文字列としてのビルド情報

SetGender

virtual void SetGender(
    const FString & InGender
) override

ユーザーの性別を設定します

パラメータ説明
InGender性別を表す文字列

SetLocation

virtual void SetLocation(
    const FString & InLocation
) override

ユーザーの場所を設定します

パラメータ説明
InLocationユーザーの場所を表す文字列

SetAge

virtual void SetAge(
    const int32 InAge
) override

ユーザーの年齢を設定します

パラメータ説明
InAgeユーザーの年齢を表す整数

RecordItemPurchase

virtual void RecordItemPurchase(
    const FString & ItemId,
    int ItemQuantity,
    const TArray< FAnalyticsEventAttribute > & EventAttrs
) override

ゲーム内アイテムの購入を記録します

パラメータ説明
ItemId文字列としてのアイテム ID
ItemQuantity整数としてのアイテム数
EventAttrs追加のイベント属性

RecordCurrencyPurchase

virtual void RecordCurrencyPurchase(
    const FString & GameCurrencyType,
    int GameCurrencyAmount,
    const TArray< FAnalyticsEventAttribute > & EventAttrs
) override

ゲーム内通貨の購入を記録します

パラメータ説明
GameCurrencyType文字列としてのゲーム内通貨タイプ
GameCurrencyAmount整数としての通貨量
EventAttrs追加のイベント属性

RecordCurrencyGiven

virtual void RecordCurrencyGiven(
    const FString & GameCurrencyType,
    int GameCurrencyAmount,
    const TArray< FAnalyticsEventAttribute > & EventAttrs
) override

ゲーム内でユーザーに付与された通貨を記録します

パラメータ説明
GameCurrencyType通貨タイプ
GameCurrencyAmount通貨量
EventAttrs追加のイベント属性

RecordError

virtual void RecordError(
    const FString & Error,
    const TArray< FAnalyticsEventAttribute > & EventAttrs
) override

問題が発生した際にエラーを記録します

パラメータ説明
Errorエラーイベント名
EventAttrsエラーイベント属性

RecordProgress

virtual void RecordProgress(
    const FString & ProgressType,
    const FString & ProgressHierarchy,
    const TArray< FAnalyticsEventAttribute > & EventAttrs
) override

ユーザーの進行状況を記録します

パラメータ説明
ProgressType文字列としての進行タイプ
ProgressHierarchy文字列としての進行階層
EventAttrs追加のイベント属性

AddEventAttribute

void AddEventAttribute(
    const FString & EventName,
    const FString & EventValue
)

値を持つ基本イベントを追加します

パラメータ説明
EventNameイベント名
EventValueイベントの値

ClearEventAttributes

void ClearEventAttributes()

イベント属性をクリアします

GetRegion

inline FAnalyticsRegion GetRegion()

オブジェクトインスタンスに現在設定されている AnalyticsRegion を返します。

GetAPIURL

inline FString GetAPIURL()

API エンドポイントの列挙子を Postback API アドレス文字列に変換するユーティリティ関数です。

戻り値: Postback API エンドポイントを含む文字列

Previous page
Next page