HarmonyOS Analytics SDK 全埋点(简称:HarmonyOS 全埋点)依赖于代码埋点,支持自动采集元素点击($AppClick)、页面浏览($AppViewScreen)、应用启动($AppStart)、应用退出($AppEnd)四种类型事件。
- HarmonyOS 全埋点最低要求 HarmonyOS API 12,且仅支持 Stage 应用模型。关于鸿蒙应用模型的介绍,可以。
- HarmonyOS 操作系统要求:3.0.0.22 及以上,具体见「设置」->「关于手机」→「软件版本」
- DevStudio IDE 版本要求:5.0.3.300 及以上
HarmonyOS 全埋点采用插件化设计思路,在 初始化之前 调用 use 方法注册全埋点插件:
务必在初始化方法(init)之前集成注册 HarmonyOS 全埋点插件,否则不生效!
打开埋点日志开关 show_log 后,通过观察日志,快速验证是否集成成功。以 $AppClick 事件举例,在日志搜索栏输入 sa_sdk 后,在 App 上点击任意支持的组件,观察日志是否触发「$AppClick」事件。
元素点击事件的示例数据如下:
设置自定义属性
当元素被点击时,期望在全埋点 $AppClick 事件基础上追加/替换自定义参数,可以通过设置自定义属性满足该需求。
在组件上调用 customProperty API 传入 sensors_data_tag ,并将相应的属性传入。
sensors_data_tag 务必不要拼错,否则无法生效!customProperty 可以调用多次,具体用法可。
忽略元素点击
全埋点元素点击默认采集所有元素,可以通过如下方式忽略指定元素点击行为。
在组件上调用 customProperty API 传入 sensors_data_tag ,并将 'ignore': true 参数传入,示例代码如下:
添加配置后,点击该元素进行验证即可。
页面浏览事件数据如下:
设置自定义属性
针对鸿蒙页面浏览事件,可以通过以下两种方式,将自定义属性传入到页面浏览事件中。
Router
通过 Router 的 Push API 传递 sensors_data_tag ,并将自定义属性作为值传入。示例代码如下:
上述示例中 pages/NavigationTest 页面触发页面浏览事件时,则会额外添加自定义属性。
NavPathStack
NavPathStack 自定义传参,要求神策 HarmonyOS SDK v0.0.8 及以上版本
如 App 中通过 NavPathStack 实现路由,则可以通过 NavPathStack 的 Push 相关 API 将 params 传入。示例代码如下(以 ets 为例):
传入 sensors_data_tag
上述示例中目标页面打开时,则会添加自定义属性。
忽略页面浏览
在初始化全埋点插件时,通过配置页面名称,忽略指定页面的浏览事件,示例代码如下: