グローバル・プロパティの設定

ドキュメント

グローバルプロパティの設定

Singular SDKでは、アプリから送信されるセッションやイベントごとにSingularサーバーに送信するカスタムプロパティを定義することができます。これらのプロパティは、ユーザー、アプリのモードやステータスなど、必要な情報を表すことができます。これらのプロパティを設定すると、レポートのディメンションとして利用できるようになり、データを分解するために使用できます。

例えば、ゲームアプリがある場合、"Level "というプロパティを定義し、初期値として "0 "を設定することができます。アプリから送信されるすべてのセッションとイベントは、"Level":"0".ユーザがレベルアップしたら、プロパティを "1 "にリセットします。すると、セッション数、イベント数、収益データなどのレポートをユーザーレベル別に取得することができます。

  • グローバル・プロパティは5つまで定義できます。
  • これらのプロパティは、あなたが設定を解除するか、ユーザーがアプリをアンインストールするまで、アプリの実行間で(あなたが与えた最新の値で)持続します。
  • 各プロパティ名と値の長さは200文字までです。これより長いプロパティ名や値を渡すと、200文字に切り詰められます。
  • グローバル・プロパティにはアクセス可能で、ユーザレベルのエクスポートと ポストバックで使用できます。将来的には、集計レポートのサポートが追加される予定です。ご質問がある場合、またはグローバルプロパティサポートのアップデートに興味がある場合は、Singularカスタマーサクセスマネージャーにお知らせください!

SingularConfig によるグローバルプロパティの設定

SDKを初期化する前に、withGlobalPropertyメソッドを使用してSingularConfigを通してグローバルプロパティを設定することができます。

グローバルプロパティとその値はアプリの実行間で持続するため、設定しようとしているプロパティがすでに別の値に設定されている可能性があることに注意してください。既存のプロパティを新しい値で上書きするかどうかをSDKに指示するには、overrideExistingパラメータを使用します。

withGlobalProperty Method
説明 グローバルプロパティを設定します。
シグネチャ .withGlobalProperty(String key, String value, boolean overrideExisting)
使用例
// Set two global properties and override any existing values

SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET")
  .withGlobalProperty(“MyProperty”, “MyValue”, true)
  .withGlobalProperty(“AnotherProperty”, “AnotherValue”, true);

初期化後のグローバル・プロパティの設定

アプリの実行中にいつでもグローバル・プロパティを設定、解除、取得するには、以下のメソッドを使用します。

Singular.setGlobalProperty Method
説明

グローバル・プロパティを指定された値に設定する。

注意事項

  • プロパティがまだ存在せず、他のグローバル・プロパティが既に 5 つ存在する場合、プロパティは追加されません。
  • プロパティが既に設定されている場合、overrideExisting パラメータは、既存の値をオーバーライドするかどうかを決定します。
  • このメソッドは、プロパティが正常に設定された場合はtrue を返し、そうでない場合はfalse を返します。
シグニチャ public static bool setGlobalProperty(String key, String value, boolean overrideExisting)
使用例
boolean result = Singular.setGlobalProperty(“MyProperty”, “MyValue”, true);
Singular.getGlobalProperties Method
説明 すべてのグローバル・プロパティとその現在の値を Map として取得します。
シグニチャ public static Map<String, String> getGlobalProperties()
使用例
Map<String, String> map = Singular.getGlobalProperties();
Singular.unsetGlobalProperty Method
説明 グローバル・プロパティを削除します。
シグニチャ public static void unsetGlobalProperty(String key)
使用例
Singular.unsetGlobalProperty(“MyProperty”);
Singular.clearGlobalProperties メソッド
説明 すべてのグローバル・プロパティを削除します。
シグネチャ public static void clearGlobalProperties()
使用例
Singular.clearGlobalProperties();