预置事件
| 事件英文变量名 | 事件显示名 | 属性英文变量名 | 事件属性显示名 | 属性值类型 | 属性值示例或说明 | 触发时机 | 备注 |
|---|---|---|---|---|---|---|---|
| $MPLaunch | 小程序启动 | $scene | 启动场景 | 字符串 |
1.0 版本以上。 描述小程序启动的场景，场景值详细说明可参考 微信小程序官方介绍 |
小程序初始化完成时触发或者小程序进入后台一定时间后被微信杀死进程后再次启动小程序时触发。 |
小程序 SDK 通用性采集，打开 autoTrack 接口后自动采集 参考小程序SDK：https://manual.sensorsdata.cn/sa/latest/tech_sdk_client_mp_wx-1573892.html UTM广告系列参数，用来渠道追踪，参考文档： https://manual.sensorsdata.cn/sa/latest/pomote_wechatapplet-7550920.html |
| $url_query | 页面参数 | 字符串 |
1.11.1 版本以上。 例：pages/index/index?props=a，$url_query 是 props=a |
||||
| $utm_campaign | 广告系列名称 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_campaign 参数就采集 |
||||
| $utm_source | 广告系列来源 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_source 参数就采集 |
||||
| $utm_medium | 广告系列媒介 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_medium 参数就采集 |
||||
| $utm_term | 广告系列字词 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_term 参数就采集 |
||||
| $utm_content | 广告系列内容 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_content 参数就采集 |
||||
| $is_first_time | 是否首次 | 布尔值 | 1.8 版本以上 | ||||
| $share_depth | 分享时的层级 | 数值 | 1.9 版本以上 | ||||
| $share_distinct_id | 分享时的 distinct_id | 字符串 | 1.9 版本以上 | ||||
| $share_url_path | 分享时的页面路径 | 字符串 | 1.9 版本以上 | ||||
| $share_method | 分享时途径 | 字符串 | 1.13.27 及以上版本，枚举值：朋友圈分享、转发消息卡片 | ||||
| $MPShow | 小程序显示 | $scene | 启动场景 | 字符串 |
1.0 版本以上。 描述小程序启动的场景，场景值说明可参考 微信小程序官方介绍 |
小程序启动时触发或者从后台切换到前台时触发。 |
|
| $url_query | 页面参数 | 字符串 | 1.11.1 版本以上。例如：pages/index/index?props=a，$url_query 是 props=a | ||||
| $utm_campaign | 广告系列名称 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_campaign 参数就采集 |
||||
| $utm_source | 广告系列来源 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_source 参数就采集 |
||||
| $utm_medium | 广告系列媒介 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_medium 参数就采集 |
||||
| $utm_term | 广告系列字词 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_term 参数就采集 |
||||
| $utm_content | 广告系列内容 | 字符串 |
0.9 版本以上。 微信小程序启动参数中有 utm_content 参数就采集 |
||||
| $share_depth | 分享时的层级 | 数值 | 1.9 版本以上 | ||||
| $share_distinct_id | 分享时的 distinct_id | 字符串 | 1.9 版本以上 | ||||
| $share_url_path | 分享时的页面路径 | 字符串 | 1.9 版本以上 | ||||
| $share_method | 分享时途径 | 字符串 | 1.13.27 及以上版本，枚举值：朋友圈分享、转发消息卡片 | ||||
| $MPHide | 小程序进入后台 | event_duration | 停留时长 | 数值 |
从本次小程序显示( $MPShow) 到进入后台或者关闭( $MPHide) 的时间，单位：秒； 注：入库后该属性英文名为 $event_duration |
小程序从前台进入后台 | |
| $MPViewScreen | 小程序页面浏览 | $url_query | 页面参数 | 字符串 |
1.11.1 版本以上。 例如：pages/index/index?props=a，$url_query 是 props=a |
打开一个小程序页面时触发 | |
| $utm_campaign | 广告系列名称 | 字符串 |
0.9 版本以上 页面加载时，在 onLoad 的参数中有utm_campaign 参数就采集 |
||||
| $utm_source | 广告系列来源 | 字符串 |
0.9 版本以上 页面加载时，在 onLoad 的参数中有utm_source 参数就采集 |
||||
| $utm_medium | 广告系列媒介 | 字符串 |
0.9 版本以上 页面加载时，在 onLoad 的参数中有utm_medium 参数就采集 |
||||
| $utm_term | 广告系列字词 | 字符串 |
0.9 版本以上 页面加载时，在 onLoad 的参数中有 utm_term 参数就采集 |
||||
| $utm_content | 广告系列内容 | 字符串 |
0.9 版本以上 页面加载时，在 onLoad 的参数中有 utm_content 参数就采集 |
||||
| $MPShare | 小程序分享 | $share_depth | 分享时的层级 | 数值 | 1.9 以上 | 设置 Page.onShareAppMessage 这个函数后，点击小程序右上角三个点，然后点击”发送给朋友“触发上报 | 暂时只能获取到用户触发分享，无法监听是否分享成功的反馈 |
| $share_method | 分享时途径 | 字符串 | 1.13.27 及以上版本，枚举值：朋友圈分享、转发消息卡片 | ||||
| $MPClick | 小程序元素点击 | $element_content | 元素内容 | 字符串 |
|
当 Page 中定义的事件处理函数被触发时采集。目前只支持 tap/ longtap / longpress 三类事件; 1.14.11 版本开始，支持采集 tab 的点击，此时，$element_type 值为 tabBar, $element_content 为 tab 上的按钮文字；
|
|
| $element_id | 元素 ID | 字符串 |
|
||||
| $element_name | 元素名称 | 字符串 |
|
||||
| $element_type | 元素类型 | 字符串 |
|
||||
| $MPAddFavorites | 小程序收藏 | $url_path | 页面路径 | 字符串 | 1.13.27 及以上版本 | ||
| $MPPageLeave |
小程序页面离开 |
event_duration | 页面浏览时长 | 数值 |
|
小程序页面 onHide 或 onUnload 生命周期触发时采集 | |
| $url_query | 页面参数 | 字符串 |
|
所有事件都有的预置属性
| 属性名 | 属性类型 | 默认显示名 | 说明 | 备注 |
|---|---|---|---|---|
| $lib | 字符串 | SDK 类型 | SDK 类型 | 微信小程序 SDK 的值为 MiniProgram |
| $lib_version | 字符串 | SDK 版本 | SDK 版本 | |
| $lib_method | 字符串 | 埋点方式 | 埋点方式，目前值统一为 code | |
| $app_id | 字符串 | 应用唯一标识 | 微信小程序的 APPID | 1.13.24 及以上版本 |
| $screen_height | 数值 | 小程序屏幕高度 | 小程序屏幕高度 | 小程序 SDK 1.11.1 版本之前，此字段名称为”小程序窗口高度”，取的值是小程序可使用窗口高度 |
| $screen_width | 数值 | 小程序屏幕宽度 | 小程序屏幕宽度 | 小程序 SDK 1.11.1 版本之前，字段名称为‘小程序窗口宽度’,取的值是小程序可使用窗口宽度 |
| $model | 字符串 | 设备型号 |
不从 UA 解析，直接获取对应设备的值 |
|
| $manufacturer | 字符串 | 设备制造商 | 小程序 SDK 1.11.1 版本支持 | |
| $brand | 字符串 | 设备品牌 | 小程序 SDK 1.14.10 版本开始支持 | |
| $os | 字符串 | 操作系统 | ||
| $os_version | 字符串 | 操作系统版本 | ||
| $mp_client_app_version | 字符串 | 小程序客户端应用版本号 | 1.14.29 及以上版本 | |
| $mp_client_basic_library_version | 字符串 | 小程序客户端基础库版本号 | 1.14.29 及以上版本 | |
| $is_first_day | 布尔值 | 是否首日访问 | 从新用户第一次访问到当天的凌晨十二点之间的值都为真，之后都为假，标识存在 storage 缓存中，可参考文档 新增用户及首日首次标记 | |
| $is_login_id | 布尔值 | 是否是登录 ID | 数据入库时判断添加 | |
| $longitude | 数值 | 经度 | GPS 信息，经度*106，纬度*106 | 1.13.31 及以上版本 |
| $latitude | 数值 | 纬度 | ||
| $geo_coordinate_system | 字符串 | 坐标系 |
根据配置 preset_properties.location 采集坐标信息; 值：'wgs84' 或 'gcj02' |
小程序 SDK 1.14.10 版本开始支持； |
| $ip | 字符串 | IP | 后端通过解析 HTTP 请求而得到 | |
| $timezone_offset | 数值 | 时区偏移量 | 系统的时区 | 1.13.24 及以上版本 |
| $title | 字符串 | 页面标题 |
1.14.5 及以上版本只有 $MPViewScreen 事件采集， 1.14.20 及以上版本增加 $MPPageLeave 事件采集， 1.14.29 及以上版本变更为所有事件都有的预置属性 |
|
| $url | 字符串 | 页面地址 | 例如：pages/index/index?props=a | 1.14.29 及以上版本 |
| $url_path | 字符串 | 页面路径 | 例：pages/index/index?props=a，$url_path 是 pages/index/index | 1.14.13 及以上版本 |
| $referrer | 字符串 | 前向地址 | 前向页面路径 | 0.9 版本以上是 $MPViewScreen 的预制属性，1.14.17 及以上版本变更为所有事件都有的预置属性 |
| $referrer_title | 字符串 | 前向页面标题 | 页面 json 中配置的 title | 1.14.17 及以上版本 |
| $country | 字符串 | 国家 |
由 IP 解析得到 |
|
| $province | 字符串 | 省份 | ||
| $city | 字符串 | 城市 | ||
| $network_type | 字符串 | 网络类型 | ||
| $browser | 字符串 | 浏览器名称，由 UA 解析得到 | ||
| $browser_version | 字符串 | 浏览器版本，由 UA 解析得到 | ||
| $app_version | 字符串 | 小程序版本 | 获取当前帐号信息，仅支持在正式版小程序中获取，开发版和体验版中无法获取 | 1.14.29 及以上版本 |
| $latest_utm_source | 字符串 | 最近一次广告系列来源 |
微信小程序启动参数中有 utm_source 参数就采集 |
小程序 SDK 1.3 版本支持 |
| $latest_utm_medium | 字符串 | 最近一次广告系列媒介 | 微信小程序启动参数中有 utm_medium 参数就采集 | |
| $latest_utm_term | 字符串 | 最近一次广告系列字词 | 微信小程序启动参数中有 utm_term 参数就采集 | |
| $latest_utm_content | 字符串 | 最近一次广告系列内容 | 微信小程序启动参数中有 utm_content 参数就采集 | |
| $latest_utm_campaign | 字符串 | 最近一次广告系列名称 | 微信小程序启动参数中有 utm_campaign 参数就采集 | |
| $latest_scene | 字符串 | 最近一次启动场景 | 描述最近一次小程序启动的场景，场景值说明可参考 微信小程序官方介绍 | 小程序 SDK 1.9 版本支持 |
| $latest_share_distinct_id | 字符串 | 最近一次分享者 | 小程序 SDK 1.13.21 版本支持 | |
| $latest_share_depth | 数值 | 最近一次分享层次 | 小程序 SDK 1.13.21 版本支持 | |
| $latest_share_url_path | 字符串 | 最近一次分享路径 | 小程序 SDK 1.13.21 版本支持 | |
| $latest_share_method | 字符串 | 最近一次分享时途径 | 小程序 SDK 1.13.27 及以上版本支持 | |
| $bot_name | 字符串 | 爬虫名称 | 从 UA 解析 |
预置用户属性
| 属性名 | 属性类型 | 默认显示名 | 说明 | 备注 |
|---|---|---|---|---|
| $first_visit_time | 时间 | 首次访问时间 | 新用户首次访问小程序时， 会给此属性赋值 | 因为这些属性的设置时机是新用户首次访问小程序时，才会设置这些属性，新用户一般时以匿名 ID 标记用户行为，如果登录 ID 和匿名 ID 关联失败，则登录 ID 不会由这些属性值。 |
| $utm_source | 字符串 | 首次广告系列来源 |
使用小程序渠道追踪，且新用户首次访问时，通过带有 utm 参数的渠道访问时，才会采集这些用户属性。如果时老用户，即使通过渠道访问小程序，也不会给这些设置 utm 用户属性。新老用户的标记可以参考此文档：新增用户及首日首次标记 |
|
| $utm_medium | 字符串 | 首次广告系列媒介 | ||
| $utm_term | 字符串 | 首次广告系列字词 | ||
| $utm_content | 字符串 | 首次广告系列内容 | ||
| $utm_campaign | 字符串 | 首次广告系列名称 |
弹窗的预置事件和预置属性
| 事件英文变量名 | 事件显示名 | 属性英文变量名 | 事件属性显示名 | 属性值类型 | 属性值示例或说明 | 触发时机 | 备注 |
|---|---|---|---|---|---|---|---|
| $PlanPopupDisplay | 弹窗展示 | $sf_msg_title | 弹窗标题 | 字符串 | |||
| $sf_msg_content | 弹窗内容 | 字符串 | |||||
| $sf_msg_image_url | 图片链接 | 字符串 | 图片链接（图片 CDN 存储地址） | 只要有图片的模板都有值 | |||
| $sf_fail_reason | 失败原因 | 字符串 | 记录弹窗失败原因，如果弹窗成功不采集这个属性 | ||||
| $sf_succeed | 弹窗成功 | 布尔值 | |||||
| $sf_lib_version | 弹窗 SDK 版本 | 字符串 | |||||
| $sf_channel_category | 消息通道类型 | 字符串 | POPUP 常量。采集的值是 POPUP | ||||
| $sf_channel_service_name | 服务商名称 | 字符串 |
SENSORS_FOCUS 常量，弹窗功能由神策智能运营提供。采集的值是 SENSORS_FOCUS |
||||
| $sf_msg_id | 消息 ID | 字符串 | |||||
| $sf_plan_id | 计划 ID | 字符串 | |||||
| $sf_platform_tag | 端类型标签 | 字符串 | 小程序弹窗的值是 MINIPROGRAM | ||||
| $sf_plan_strategy_id | 实验组 ID | 字符串 |
|
||||
| $sf_audience_id | 受众 ID | 字符串 | 由服务端返回，受众为全部用户时，SDK 不上报 | ||||
| $sf_plan_type | 计划类型 | 字符串 | 运营计划 | ||||
| $PlanPopupClick | 点击行为 | $sf_plan_id | 计划 ID | 字符串 | |||
| $sf_plan_type | 计划类型 | 字符串 | 运营计划 | ||||
| $sf_channel_service_name | 服务商名称 | 字符串 | SENSORS_FOCUS 常量，弹窗功能由神策智能运营提供。采集的值是 SENSORS_FOCUS | ||||
| $sf_channel_category | 消息通道类型 | 字符串 | POPUP 常量。采集的值是 POPUP | ||||
| $sf_audience_id | 受众 ID | 字符串 | 由服务端返回，受众为全部用户时，SDK 不上报 | ||||
| $sf_plan_strategy_id | 实验组 ID | 字符串 |
|
||||
| $sf_msg_title | 推送标题 | 字符串 | |||||
| $sf_msg_content | 推送内容 | 字符串 | |||||
| $sf_msg_element_type | 弹窗按钮类型 | 字符串 | 弹窗元素类型：普通按钮、文字链接、图片链接、关闭 icon、蒙层 | ||||
| $sf_msg_element_content | 弹窗按钮文案 | 字符串 | 弹窗按钮文案 | 按钮独有 | |||
| $sf_msg_element_action | 弹窗按钮行为 | 字符串 | |||||
| $sf_msg_image_url | 图片链接 | 字符串 | 图片链接（图片 CDN 存储地址） | ||||
| $sf_msg_action_id | 点击行为 ID | 字符串 | |||||
| $sf_platform_tag | 端类型标签 | 字符串 | 小程序弹窗的值是 MINIPROGRAM | ||||
| $sf_msg_id | 推送消息 ID | 字符串 | |||||
| $sf_close_type | 关闭按钮类型 | 字符串 | 只有关闭行为有：关闭蒙层、弹窗右上关闭 icon 、弹窗下部关闭 icon 、底部按钮（设置为关闭弹窗的按钮） | ||||
| $sf_lib_version | 弹窗 SDK 版本 | 字符串 |
A/B 测试的预置事件和预置属性
| 事件英文变量名 | 事件显示名 | 属性英文变量名 | 事件属性显示名 | 属性值类型 | 属性值示例或说明 | 触发时机 | 备注 |
|---|---|---|---|---|---|---|---|
| $ABTestTrigger | A/B 测试 | $abtest_experiment_group_id | 实验分组 ID | 字符串 | 命中实验，会采集该事件以及事件属性 | ||
| $abtest_experiment_id | 实验 ID | 字符串 |