安装
每次安装后首次打开自动报送该事件。
安装事件的 _event_name 为 _appInstall
启动
每次打开或进入后台超过30s再进入前台时,自动报送该事件。
启动事件的 _event_name 为 _appStart
退出
退出或进入后台超过30s再进入前台时,自动报送该事件。
退出事件的 _event_name 为 _appEnd
为预置事件添加自定义属性
支持开发者对启动、安装、退出三个预置事件设置自定义属性,通过这些自定义属性,开发者可以更方便的统计和分析数据。
方法示例
public static setPresetEventProperties(presetEventType: SEPresetEventType, customProperties: Record<string, Object>)
参数说明
参数名称 | 参数含义 | 参数类型 | 是否必传 |
presetEventType | 预置事件枚举,具体如下:AppInstall(安装事件)、AppStart(启动事件)、AppEnd(退出事件)、All(安装、启动、退出事件) | PresetEventType | 是 |
customProperties | 开发者传入的自定义属性 | Record<string,Object> | 否 |
注:
- 设置预置事件自定义属性的方法可以在热力引擎 SDK 初始化前调用,这样设置的属性会适用于所有后续SDK产生的预置事件,如果在初始化后再设置,在此之前产生的预置事件将不包含这些自定义属性。
- 预置事件设置的自定义属性不会被缓存,每次设置都会覆盖前一次的设置。
- 如果设置了 PresetEventType 的枚举为 PresetEventType.All,那么会覆盖通过PresetEventType.AppInstall、PresetEventType.AppStart、PresetEventType.AppEnd 这三种枚举设置的自定义属性,多次设置只有最后一次生效。
- 预置事件设置的自定义属性支持清空,可以调用对应的枚举清空,例如:SolarEngineManager.setPresetEventProperties(SEPresetEventType.AppStart, {}),此方法可以用来清空启动事件的自定义属性,安装与退出事件只需更改对应的枚举值即可。
- 支持全局清除预置事件的自定义属性,例如:SolarEngineManager.setPresetEventProperties(SEPresetEventType.All, {}),此方法可以清空所有预置事件的自定义属性,即通过 PresetEventType.AppInstall、PresetEventType.AppStart、PresetEventType.AppEnd 这三种枚举设置的自定义属性都会被一并清空。
- 预置事件设置的自定义属性不支持开发者传入"_"下划线开头的 key 值,SDK 会默认丢弃该条属性。
调用示例
import { SolarEngineManager, SEPresetEventType } from 'solarenginecore';
let customerProperties: Record<string, Object> = {}
customerProperties['key1'] = "value1"
customerProperties['key2'] = "value2"
SolarEngineManager.setPresetEventProperties(SEPresetEventType.AppInstall, customerProperties);