预置事件

事件英文变量名事件显示名属性英文变量名事件属性显示名属性值类型属性值示例或说明触发时机备注
$MPLaunch小程序启动$scene启动场景字符串

1.0 版本以上。

描述小程序启动的场景,场景值详细说明可参考 微信小程序官方介绍

小程序初始化完成时触发或者小程序进入后台一定时间后被微信杀死进程后再次启动小程序时触发。

详情见微信官方文档小程序启动与小程序销毁时机部分

小程序 SDK 通用性采集,打开 autoTrack 接口后自动采集

参考小程序SDK:https://manual.sensorsdata.cn/sa/latest/page-1573892.html





UTM广告系列参数,用来渠道追踪,参考文档:
https://manual.sensorsdata.cn/sa/latest/page-7550920.html    
$url_query页面参数字符串

1.11.1 版本以上。

例:pages/index/index?props=a,$url_query 是 props=a

$url_path页面路径字符串例:pages/index/index?props=a,$url_path 是 pages/index/index
$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
$url_path页面路径字符串例如:pages/index/index?props=a,$url_path 是 pages/index/index
$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

小程序从前台进入后台
$url_path页面路径字符串1.5 版本及以上
$MPViewScreen小程序页面浏览$url_query页面参数字符串

1.11.1 版本以上。

例如:pages/index/index?props=a,$url_query 是 props=a

打开一个小程序页面时触发








$url_path页面路径字符串例如:pages/index/index?props=a,$url_path 是 pages/index/index
$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 参数就采集

$title页面标题字符串1.14.5 版本以上
$MPShare小程序分享$share_depth分享时的层级数值1.9 以上设置 Page.onShareAppMessage 这个函数后,点击小程序右上角三个点,然后点击”发送给朋友“触发上报暂时只能获取到用户触发分享,无法监听是否分享成功的反馈
$url_path页面路径字符串1.9 以上
$share_method分享时途径字符串1.13.27 及以上版本,枚举值:朋友圈分享、转发消息卡片
$MPClick小程序元素点击$element_content元素内容字符串
  • 1.13.18 及以上版本,需要在组件上设置 data-content 属性才可以采集到,未设置采集不到该属性。如:<view bindtap="test" data-content="testContent">测试</view>
  • Taro 框架 3.0 版本不支持

当 Page 中定义的事件处理函数被触发时采集。目前只支持 tap/ longtap / longpress 三类事件;

1.14.11 版本开始,支持采集 tab 的点击,此时,$element_type 值为 tabBar, $element_content 为 tab 上的按钮文字;





$element_id元素 ID字符串
  • 1.13.18 及以上版本,用来区分组件,需要在组件上设置 id 属性才可以采集到,未设置采集不到该属性。如:<view bindtap="test" id="testID">测试</view>
$element_name元素名称字符串
  • 1.13.18 及以上版本,用来区分组件,需要在组件上设置 data-name 属性才可以采集到,未设置采集不到该属性。如:<view bindtap="test" data-name="testName">测试</view>
  • Taro 框架 3.0 版本不支持
$element_type元素类型字符串
  • 1.13.18 及以上版本,需要在组件上设置 data-type 属性才可以采集到,未设置采集不到该属性。如:<view bindtap="test" data-type="testType">测试</view>
  • Taro 框架 3.0 版本不支持
$url_path页面路径字符串1.13.18 及以上版本
$MPAddFavorites小程序收藏$url_path页面路径字符串1.13.27 及以上版本
在微信中,仅 Android 手机有”收藏“功能,所以只有 Android 手机支持此事件
$MPPageLeave


小程序页面离开


event_duration页面浏览时长数值
  • 1.14.20 及以上版本,单位:秒
  • 采集的是页面生命周期 onShow 到 onHide 或 onUnload 触发时的间隔时长


小程序页面 onHide 或 onUnload 生命周期触发时采集注:入库后该属性英文名为 $event_duration
$title 页面标题字符串

$url_path页面路径字符串

$url_query页面参数字符串
  • 1.14.20 及以上版本。例如:pages/index/index?props=a,$url_query 是 props=a


所有事件都有的预置属性

属性名属性类型默认显示名说明备注
$lib字符串SDK 类型SDK 类型微信小程序 SDK 的值为 MiniProgram
$lib_version字符串SDK 版本SDK 版本
$lib_method字符串埋点方式埋点方式,目前值统一为 code
$app_id字符串应用唯一标识微信小程序的 APPID1.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字符串操作系统版本
$is_first_day布尔值是否首日访问从新用户第一次访问到当天的凌晨十二点之间的值都为真,之后都为假,标识存在 storage 缓存中,可参考文档 新增用户及首日首次标记
$is_login_id布尔值是否是登录 ID数据入库时判断添加
$longitude数值经度GPS 信息,经度*106,纬度*1061.13.31 及以上版本
$latitude数值纬度
$geo_coordinate_system字符串坐标系

根据配置 preset_properties.location 采集坐标信息;

值:'wgs84'  或  'gcj02'

小程序 SDK 1.14.10 版本开始支持;

$ip字符串IP后端通过解析 HTTP 请求而得到
$timezone_offset数值时区偏移量系统的时区1.13.24 及以上版本
$url_path字符串页面路径例:pages/index/index?props=a,$url_path 是 pages/index/index1.14.13 及以上版本
$referrer字符串前向地址前向页面路径0.9 版本以上是 $MPViewScreen 的预制属性,1.14.17 及以上版本变更为所有事件都有的预置属性
$referrer_title字符串前向页面标题页面 json 中配置的 title1.14.17 及以上版本
$country字符串国家

由 IP 解析得到


$province字符串省份
$city字符串城市
$network_type字符串网络类型

$browser字符串浏览器名称,由 UA 解析得到

$browser_version字符串浏览器版本,由 UA 解析得到

$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字符串首次广告系列名称