适配的小程序
本文档中的预置事件和属性对下列小程序通用：
支付宝、字节/抖音、百度、京东、快手、小红书、淘宝、QQ
注意版本和项目的差异
- SDK 是在这个项目下的 https://github.com/sensorsdata/sa-sdk-mini/tree/master/dist 小程序
- 版本要求 >= v0.12.0
预置事件
| 事件英文 | 事件显示 | 属性英文变量名 | 事件属性显示名 | 属性值类型 | 事件说明 | 属性说明 |
|---|---|---|---|---|---|---|
| $MPLaunch | 小程序启动 | $预置属性 |
对应 App.onLaunc 小程序初始化完成时，全局只触发一次。 触发时机：小程序进程被杀死，重新打开。 |
|||
| $scene | 启动场景 | 字符串 | ||||
| $url | 页面地址 | 字符串 | 这个值只作为参考，不保证绝对准确，因为系统没有提供 url 值，是 SDK 根据 url_path 和 url_query 拼接的 | |||
| $url_query | 页面参数 | 字符串 | ||||
| $url_path | 页面路径 | 字符串 | ||||
| $is_first_time | 是否首次 | 布尔值 | ||||
| $utm_source | 广告系列来源 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_medium | 广告系列媒介 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_term | 广告系列字词 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_content | 广告系列内容 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_campaign | 广告系列名称 | 字符串 | 启动参数有 utm 值才会有 | |||
| $MPShow | 小程序显示 | $预置属性 |
对应 App.onShow 启动小程序时。 触发时机：小程序启动，或从后台进入前台显示。 |
|||
| $scene | 启动场景 | 字符串 | ||||
| $url_path | 页面路径 | 字符串 | ||||
| $url | 页面地址 | 字符串 | 这个值只作为参考，不保证绝对准确，因为系统没有提供 url 值，是 SDK 根据 url_path 和 url_query 拼接的 | |||
| $url_query | 页面参数 | 字符串 | ||||
| $utm_source | 广告系列来源 | 字符串 | ||||
| $utm_medium | 广告系列媒介 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_term | 广告系列字词 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_content | 广告系列内容 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_campaign | 广告系列名称 | 字符串 | 启动参数有 utm 值才会有 | |||
| $MPHide | 小程序进入后台 | $预置属性 |
对应 App.onHide 小程序从前台进入后台。 触发时机：点击小程序右上角退出按钮、相关 App 进入后台、进入小程序关于页面、手机锁屏、小程序进程被杀死。 |
|||
| $event_duration | 停留时长 | 数值 | ||||
| $url_path | 页面路径 | 字符串 | ||||
| $MPViewScreen |
小程序页面浏览 |
$预置属性 |
打开一个小程序页面时触发。 |
|||
| $url_query | 页面参数 | 字符串 | ||||
| $url | 页面地址 | 字符串 | 这个值只作为参考，不保证绝对准确，因为系统没有提供 url 值，是 SDK 根据 url_path 和 url_query 拼接的 | |||
| $url_path | 页面路径 | 字符串 | ||||
| $referrer | 前向地址 | 字符串 | 这个值只作为参考，不保证绝对准确，因为系统没有提供 referrer 值，是 SDK 取的上一个保存的 url 值 | |||
| $utm_source | 广告系列来源 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_medium | 广告系列媒介 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_term | 广告系列字词 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_content | 广告系列内容 | 字符串 | 启动参数有 utm 值才会有 | |||
| $utm_campaign | 广告系列名称 | 字符串 | 启动参数有 utm 值才会有 | |||
| $MPClick |
小程序元素点击 |
$预置属性 |
当 Page 中定义的事件处理函数被触发时采集。目前只支持 tap/ longtap / longpress 三类事件。 |
|||
| $element_id | 元素 ID | 字符串 | 需要在组件上设置 id 属性才可以采集到，未设置采集不到该属性。 | |||
| $element_content | 元素内容 | 字符串 | 需要在组件上设置 data-content 属性才可以采集到，未设置采集不到该属性。如：<view bindtap="test" data-content="testContent">测试</view> | |||
| $element_name | 元素名称 | 字符串 | 需要在组件上设置 data-name 属性才可以采集到，未设置采集不到该属性。如：<view bindtap="test" data-name="testName">测试</view> | |||
| $element_type | 元素类型 | 字符串 | 需要在组件上设置 data-type 属性才可以采集到，未设置采集不到该属性。如：<view bindtap="test" data-type="testType">测试</view> | |||
| $url_path | 页面路径 | 字符串 | ||||
| $MPPageLeave |
小程序页面离开 |
$预置属性 |
小程序页面 onHide 或 onUnload 生命周期触发时采集。 需要在初始化 init 配置 autoTrack: {pageLeave: true}。 |
|||
| $event_duration | 页面浏览时长 | 数值 | SDK 里可能没有带 $ 符号，但最终入库后都会带 | |||
| $url_query | 页面参数 | 字符串 | ||||
| $url_path | 页面路径 | 字符串 | ||||
| $url | 页面地址 | 字符串 | 这个值只作为参考，不保证绝对准确，因为系统没有提供 url 值，是 SDK 根据 url_path 和 url_query 拼接的 |
所有事件都有的预置属性
| 字段名称 | 类型 | 说明 | 备注 |
|---|---|---|---|
| $lib | 字符串 | SDK 类型 | |
| $data_ingestion_source | 字符串 | SDK 类型 | 跟 lib 类似，不需要关注。部分小程序有这个值。 |
| $lib_version | 字符串 | SDK 版本 | |
| $app_id | 字符串 | 小程序 AppID | 会尝试获取，有可能取不到 |
| $mp_client_app_version | 字符串 | 小程序客户端应用版本号 | 会尝试获取，有可能取不到 |
| $mp_client_basic_library_version | 字符串 | 小程序客户端基础库版本号 | 会尝试获取，有可能取不到 |
| $screen_height | 数值 | 屏幕高度 | |
| $screen_width | 数值 | 屏幕宽度 | |
| $brand | 字符串 | 设备品牌 | |
| $model | 字符串 | 设备型号 | |
| $manufacturer | 字符串 | 设备制造商 | |
| $os | 字符串 | 操作系统 | |
| $os_version | 字符串 | 操作系统版本 | |
| $is_first_day | 布尔值 | 是否首日访问（从新用户第一次访问到当天的凌晨十二点之间的值都为真，之后为假，标识存在 storage 中） | |
| $is_login_id | 布尔值 | 是否是登录 ID (数据入库时判断添加) | |
| $ip | 字符串 | SDK 发送数据请求时携带的属性 | 默认 nginx 解析，也可以自己传 |
| $timezone_offset | 数值 | 时区偏移量 | |
| $country | 字符串 | 由 IP 解析得到 | nginx 解析 |
| $province | 字符串 | 由 IP 解析得到 | nginx 解析 |
| $city | 字符串 | 由 IP 解析得到 | nginx 解析 |
| $network_type | 字符串 | 网络类型 | |
| $browser | 字符串 | 浏览器名称，由 UA 解析得到 | 可能取不到。看小程序厂商给 nginx 发的数据请求会不会自动带 UA |
| $browser_version | 字符串 | 浏览器版本，由 UA 解析得到 | 可能取不到。看小程序厂商给 nginx 发的数据数据请求会不会自动带 UA |
| $latest_utm_source | 字符串 | 最近一次付费广告系列来源 | 启动参数有 utm 值才会有 |
| $latest_utm_medium | 字符串 | 最近一次付费广告系列媒介 | 启动参数有 utm 值才会有 |
| $latest_utm_term | 字符串 | 最近一次付费广告系列字词 | 启动参数有 utm 值才会有 |
| $latest_utm_content | 字符串 | 最近一次付费广告系列内容 | 启动参数有 utm 值才会有 |
| $latest_utm_campaign | 字符串 | 最近一次付费广告系列名称 | 启动参数有 utm 值才会有 |
| $latest_scene | 字符串 | 最近一次启动场景值 |