设置全局属性

文件

设置全局属性

Singular SDK 允许你定义额外的自定义属性,以便与应用程序发送的每个会话和事件一起发送到 Singular 服务器。这些属性可以代表有关用户、应用程序模式或状态或其他任何信息。一旦设置了这些属性,它们就可以作为报告中的维度,您可以用它们来细分数据。

例如,如果您有一个游戏应用程序,您可以定义一个名为 "级别 "的属性,并将其初始设置为 "0"。应用程序发送的任何会话和事件都将带有 "Level":"0".一旦用户等级提升,您就可以将该属性重置为 "1",以此类推。然后,您就可以获得按用户等级分列的报告,包括会话、事件计数和收入数据。

  • 最多可以定义5 个全局属性
  • 它们会在应用程序运行期间持续存在(使用您给定的最新值),直到您取消设置或用户卸载应用程序。
  • 每个属性的名称和值最长可包含200 个字符。如果您传递的属性名称或值较长,将被截断为 200 个字符。
  • 全局属性可在用户级导出回传中访问和使用。将来还会增加汇总报告支持。如果有任何疑问,或对全局属性支持的更新感兴趣,请联系 Singular 客户成功经理!

通过 SingularConfig 设置全局属性

在初始化 SDK 之前,你可以使用withGlobalProperty方法通过SingularConfig设置全局属性。

请注意,由于全局属性及其值会在应用程序运行期间持续存在,因此您要设置的属性可能已被设置为不同的值。使用overrideExisting参数可告诉 SDK 是否用新值覆盖现有属性。

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