公共事件属性指的就是每个事件都会带有的属性,对于一些重要的属性,譬如用户的来源渠道、转化而来的广告 ID 等,这些属性需要设置在每个事件中,SDK 需支持这些属性被设置为公共事件属性的设置。
设置公共事件属性
调用 setSuperProperties 来设置公共事件属性
注:
- 公共事件属性将会被保存到缓存中,无需每次启动 App 时调用。
- 如果调用 setSuperProperties 上传了先前已设置过的公共事件属性,则会覆盖之前的属性。
- 如果公共事件属性和事件上报上传的某个属性的 key 重复,则该事件的属性会覆盖公共事件属性。
- 此方法设置公共事件属性最好放在SDK初始化方法initSeSdk之前设置,避免造成某些上报事件中不存在公共事件属性的问题。
- 开发者传入属性 key 不能为"_"下划线开头,"_"下划线开头为SDK保留字段,开发者设置则直接报错丢弃
方法示例
export function setSuperProperties(superProperties:Object);
参数说明
参数名称 | 参数含义 | 参数类型 | 是否必传 |
superProperties
|
开发者自定义公共事件属性字典 |
Object
|
是 |
调用示例
let superProperties:Object = { ... };
SolarEngine.setSuperProperties(superProperties);
清空指定的公共事件属性
调用 unsetSuperProperty 方法可清除指定key值的一个公共事件属性
方法示例
export function unsetSuperProperty(key:string);
参数说明
参数名称 | 参数含义 | 参数类型 | 是否必传 |
key | 需要清除的公共事件属性key值 | string | 是 |
调用示例
let key:string = "your_key";
SolarEngine.unsetSuperProperty(key);
清空所有公共事件属性
调用 clearSuperProperties 方法可清空所有公共事件属性
方法示例
export function clearSuperProperties();
调用示例
SolarEngine.clearSuperProperties();