コンテンツにスキップ

SDK 初期化

本ドキュメントでは、Unity SDK の初期化とランタイム機能に関する内容を説明します。

基本設定

FTUnityBridge.Install(new SDKConfig
{
    datakitUrl = "http://10.0.0.1:9529",
    env = "prod",
    debug = true,
});
フィールド 型 必須 説明
datakitUrl string はい ローカル環境（Datakit）にデータを送信するためのURLアドレス。例：http://10.0.0.1:9529、デフォルトポートは9529。SDKをインストールするデバイスからこのアドレスにアクセス可能である必要があります。注意：datakitUrl と datawayUrl はどちらか一方のみを設定してください
datawayUrl string はい パブリックネットワークのDataWayにデータを送信するためのURLアドレス。[RUM] アプリケーションから取得します。例：https://open.dataway.url。SDKをインストールするデバイスからこのアドレスにアクセス可能である必要があります。注意：datakitUrl と datawayUrl はどちらか一方のみを設定してください
clientToken string はい 認証トークン。datawayUrl と併用する必要があります
debug boolean いいえ Debugログの出力を許可するかどうかを設定します。デフォルトは false
env string いいえ 環境。デフォルトは prod。任意の文字列。1単語での指定を推奨します（例：test）
serviceName string いいえ 所属するビジネスまたはサービスの名前を設定します。デフォルト：df_rum_ios、df_rum_android
globalContext object いいえ カスタムタグを追加します。詳細なルールは カスタムタグの使用 を参照してください
autoSync boolean いいえ データ収集後、自動でサーバーに同期するかどうかを設定します。デフォルトは true。false の場合、flushSyncData() を使用してデータ同期を管理します
syncPageSize number いいえ 同期リクエストの項目数を設定します。範囲 [5,)。項目数が大きいほど、データ同期により多くの計算リソースを消費します。デフォルトは10
syncSleepTime number いいえ 同期のインターバル時間を設定します。範囲 [0,5000]。デフォルトでは設定なし
enableDataIntegerCompatible boolean いいえ Webデータと共存させる必要がある場合、有効にすることを推奨します。SDK 1.1.0以降ではデフォルトで有効
compressIntakeRequests boolean いいえ アップロードする同期データをdeflate圧縮します。デフォルトは無効。SDK 1.1.0以降でサポート
enableLimitWithDbSize boolean いいえ DBを使用してデータサイズを制限する機能を有効にします。デフォルトは100MB、単位はByte。有効にすると logCacheLimitCount と rumCacheLimitCount は無効になります
dbCacheLimit number いいえ DBキャッシュの制限サイズ。範囲 [30MB,)。デフォルトは100MB、単位はbyte
dbDiscardStrategy string いいえ データベース内のデータ破棄ルールを設定します。discard：新規データを破棄（デフォルト）、discardOldest：古いデータを破棄
dataModifier object いいえ 個別のフィールドを変更します。SDK 1.1.0以降でサポート。例は データ収集のマスキング を参照
lineDataModifier object いいえ 個別のデータ行を変更します。SDK 1.1.0以降でサポート。例は データ収集のマスキング を参照

ユーザー情報のバインドとバインド解除

使用方法

/// <summary>
/// RUM ユーザー情報をバインドします
/// </summary>
/// <param name="userId">ユーザー固有のID</param>
public static async Task BindUserData(string userId)

/// <summary>
/// RUM ユーザー情報をバインドします
/// </summary>
/// <param name="userData"></param>
public static async Task BindUserData(UserData userData)

public static async Task UnBindUserdata()
メソッド名 型 必須 説明
userId string はい ユーザーID
userName string いいえ ユーザー名
userEmail string いいえ ユーザーのメールアドレス
extra dictionary いいえ KV形式で値を設定します。追加ルールは アプリケーション接続 を参照してください

コード例

FTUnityBridge.BindUserData(new UserData
{
    userId = "userid",
    userName = "userName",
    userEmail = "someone@email.com",
    extra = new Dictionary<string, string>
    {
        {"custom_data", "custom data"}
    }
});

FTUnityBridge.UnBindUserdata();

ランタイム機能

SDK キャッシュデータのクリア

FTUnityBridge を使用して、未送信のキャッシュデータをクリアします。

FTUnityBridge.clearAllData();

データの手動同期

SDKConfig.autoSync を true に設定している場合、追加の操作は不要で、SDKが自動的に同期します。
SDKConfig.autoSync を false に設定している場合、データ同期メソッドを手動で呼び出す必要があります。

FTUnityBridge.flushSyncData();

SDK の停止

FTUnityBridge.DeInit();

関連トピック

  • RUM の初期化と収集機能については RUM 設定 を参照してください
  • Log の初期化とログ出力については Log 設定 を参照してください
  • Trace の初期化と分散型トレーシングについては Trace 設定 を参照してください
  • ネイティブプロジェクトと Unity のハイブリッド連携シナリオについては ネイティブと Unity のハイブリッド開発 を参照してください

フィードバック

このページは役に立ちましたか？