公共事件属性指的是每个事件都会带有的属性,对于一些重要的属性,如用户的来源渠道、转化的广告 ID 等,这些属性需要设置在每个事件中,这些属性可以被设置为公共事件属性。
公共事件属性设置的方法最好放在SDK的初始化方法 initialize 之前,这样可以保证所有的上报事件中都能存在我们已经设置好的公共事件属性。
设置公共事件属性
设置公共事件属性方法中的 value 值包含了常用的基本数据类型,支持传入string 、 number 、 boolean 、 Record<string, string | number | boolean> 、Record<string, string | number | boolean>[] 类型的数据。
方法示例
public static setSuperProperties(context: Context, publicKey: string, publicValue: Object)
参数说明
参数名称 | 参数含义 | 参数类型 | 是否必传 |
context | 应用程序上下文对象 | Context | 是 |
publicKey | 需要设置的公共事件属性key值 | string | 是 |
publicValue | 需要设置的公共事件属性value值 | Object | 是 |
调用示例
import { SolarEngineManager} from '@solarengine/core'
SolarEngineManager.setSuperProperties(context"设置的公共事件属性key值","设置的公共事件属性的value值");
注:
- 公共事件属性将会被保存到缓存中,无需每次启动 App 时调用。
- 如果重复调用 setSuperProperties 设置公共事件属性,新属性值会覆盖旧属性值。
- 如果公共事件属性和事件上报上传的某个属性的 key 重复,则该事件的属性会覆盖公共事件属性。
- 设置公共事件属性不支持开发者传入"_"下划线开头的 key 值。
清空指定的公共事件属性
方法示例
public static unsetSuperProperty(context: Context, publicKey: string)
参数说明
参数名称 | 参数含义 | 参数类型 | 是否必传 |
context | 应用程序上下文对象 | Context | 是 |
publicKey | 需要清除的公共事件属性 key 值 | string | 是 |
调用示例
import { SolarEngineManager} from '@solarengine/core'
SolarEngineManager.unsetSuperProperty(context,"xxx需要清空的公共事件属性的key值xxx");
清空所有公共事件属性
方法示例
public static clearSuperProperties(context: Context)
参数说明
参数名称 | 参数含义 | 参数类型 | 是否必传 |
context | 应用程序上下文对象 | Context | 是 |
调用示例
import { SolarEngineManager} from '@solarengine/core'
SolarEngineManager.clearSuperProperties(context);