# FAnalyticsProviderTreasureData

## 概要


```cpp
class FAnalyticsProviderTreasureData;
```

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

## パブリック型

### enum FAnalyticsRegion

| 列挙子 | 値 | 説明 |
|  --- | --- | --- |
| US01 |  | USA - us01.records.in.treasuredata.com |
| AP01 |  | Japan - ap01.records.in.treasuredata.com |
| AP02 |  | Korea - ap02.records.in.treasuredata.com |
| EU01 |  | Europe - eu01.records.in.treasuredata.com |


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

## パブリック関数

### Create


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

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

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


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

### Destroy


```cpp
static inline void Destroy()
```

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

### StartSession


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

セッションを開始します

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


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

### EndSession


```cpp
virtual void EndSession() override
```

セッションを終了します

### SetUserID


```cpp
virtual void SetUserID(
    const FString & InUserID
) override
```

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

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


### GetUserID


```cpp
virtual FString GetUserID() const override
```

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

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

### GetSessionID


```cpp
virtual FString GetSessionID() const override
```

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

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

### SetSessionID


```cpp
virtual bool SetSessionID(
    const FString & InSessionID
) override
```

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

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


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

### RecordEvent


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

イベントを記録します

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


### RecordItemPurchase


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

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

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


### RecordCurrencyPurchase


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

通貨の購入を記録します

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


### RecordCurrencyGiven


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

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

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


### SetBuildInfo


```cpp
virtual void SetBuildInfo(
    const FString & InBuildInfo
) override
```

ビルド情報を設定します

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


### SetGender


```cpp
virtual void SetGender(
    const FString & InGender
) override
```

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

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


### SetLocation


```cpp
virtual void SetLocation(
    const FString & InLocation
) override
```

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

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


### SetAge


```cpp
virtual void SetAge(
    const int32 InAge
) override
```

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

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


### RecordItemPurchase


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

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

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


### RecordCurrencyPurchase


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

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

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


### RecordCurrencyGiven


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

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

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


### RecordError


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

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

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


### RecordProgress


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

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

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


### AddEventAttribute


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

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

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


### ClearEventAttributes


```cpp
void ClearEventAttributes()
```

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

### GetRegion


```cpp
inline FAnalyticsRegion GetRegion()
```

オブジェクトインスタンスに現在設定されている [AnalyticsRegion](#enum-fanalyticsregion) を返します。

### GetAPIURL


```cpp
inline FString GetAPIURL()
```

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

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