# 表格说明
应用信息
| 属性名 | 属性类型 | 描述 |
|---|---|---|
| app_id | string | 小程序 APPID |
| app_key_id | string | 微信平台来源 ID |
| app_version | string | 小程序版本 |
| sdk_type | string | SDK 类型 mini 代表小程序 |
| sdk_version | string | SDK 版本号 |
设备信息
| 属性名 | 属性类型 | 描述 |
|---|---|---|
| brand | string | 设备品牌 |
| device_id | string | 设备 ID |
| model | string | 设备型号 |
| os | string | 操作系统 |
| os_version | string | 操作系统版本 |
| screen_size | string | 屏幕宽度* 屏幕高度，单位 px |
网络信息
| 属性名 | 属性类型 | 描述 |
|---|---|---|
| ns | string | 网络连接状态 4g 或者 wifi |
| ip | string | ip 地址 |
用户属性
| 属性名 | 属性类型 | 描述 |
|---|---|---|
| user_id | string | 用户 ID |
| avatar | string | 用户头像 |
| name | string | 用户昵称 |
| gender | number | 用户性别 |
| country | string | 国家 |
| province | string | 省 |
| city | string | 市 |
| tid | string | 机构 ID |
| app_type | string | 用户类型 RETAIL 代表零售 STAFF 代表员工 |
应用打开
每次用户打开小程序的时候，默认 SDK 开启预置行为，自动上报。
在小程序生命周期回调 App.onLaunch 触发时上报。
# 数据规范
| 字段 | 说明 | 备注 |
|---|---|---|
| event_id | uuid | 每次随机生成 UUID |
| event_type | enter | 打开 |
| event_name | enter_app | 打开应用 |
| timestamp | 时间戳 | 毫秒 |
| params.scene | 场景值 | 参考 https://developers.weixin.qq.com/miniprogram/dev/reference/scene-list.html (opens new window) 小程序上传原始场景值 ID；例子：'1007' |
| params.path | 启动页 | 启动应用的路径 |
| params.query | 启动参数 | 启动应用的 query 参数（非必填） |
| params.share_ticket | shareTicket | 详见获取更多转发信息 (opens new window) |
| params.referrer_info | 来源信息 | 来源信息。从另一个小程序、公众号或 App 进入小程序时返回 |
| params.app_session_id | uuid | 应用访问期间的唯一会话 ID |
应用关闭
每次用户关闭小程序的时候，关闭动作包括退出小程序回到微信、退出微信，会发送一条应用关闭消息，默认 SDK 开启预置行为，自动上报。
在小程序生命周期回调 App.onHide 触发时上报。
# 数据规范
| 字段 | 说明 | 备注 |
|---|---|---|
| event_id | uuid | 每次随机生成 UUID |
| event_type | leave | 关闭 |
| event_name | leave_app | 关闭应用 |
| timestamp | 时间戳 | 毫秒 |
| params.scene | 场景值 | 参考 https://developers.weixin.qq.com/miniprogram/dev/reference/scene-list.html (opens new window) 小程序上传原始场景值 ID；例子：'1007' |
| params.path | 关闭页 | 关闭应用当前页面的路径 |
| params.query | 关闭参数 | 关闭应用当前页面的 query 参数 |
| params.duration | 应用停留时长 | 单位毫秒 |
| params.app_session_id | uuid | 应用访问期间的唯一会话 ID |
页面打开
每次用户打开小程序页面的时候，默认 SDK 开启预置行为，自动上报。
在小程序生命周期回调 Page.onLoad 触发时上报。
# 数据规范
| 字段 | 说明 | 备注 |
|---|---|---|
| event_id | uuid | 每次随机生成 UUID |
| event_type | enter | 打开 |
| event_name | enter_page | 打开页面 |
| timestamp | 时间戳 | 毫秒 |
| referrer | 前页 | 第一个页面传 直接打开 |
| params.path | 打开页 | 页面的路径 |
| params.query | 打开页参数 | 页面的 query 参数 |
| params.app_session_id | uuid | 应用访问期间的唯一会话 ID |
| params.page_session_id | uuid | 页面打开期间的唯一会话 ID |
页面关闭
每次用户关闭小程序页面的时候，默认 SDK 开启预置行为，自动上报。
在小程序生命周期回调 Page.pageHide 和 Page.onUnload 触发时上报。
# 数据规范
| 字段 | 说明 | 备注 |
|---|---|---|
| event_id | uuid | 每次随机生成 UUID |
| event_type | leave | 关闭 |
| event_name | leave_page | 关闭页面 |
| timestamp | 时间戳 | 毫秒 |
| referrer | 前页 | 第一个页面传 直接打开 |
| params.path | 关闭页 | 页面的路径 |
| params.query | 关闭页参数 | 页面的 query 参数 |
| params.duration | 页面停留时长 | 单位毫秒 |
| params.app_session_id | uuid | 应用访问期间的唯一会话 ID |
| params.page_session_id | uuid | 页面打开期间的唯一会话 ID |
页面分享
每次用户打开小程序页面的时候，默认 SDK 开启预置行为，自动上报。
在小程序生命周期回调 Page.onLoad 触发时上报。
# 数据规范
| 字段 | 说明 | 备注 |
|---|---|---|
| event_id | uuid | 每次随机生成 UUID |
| event_type | share | 分享 |
| event_name | 分享名称 | shareToFriend 分享好友 |
| timestamp | 时间戳 | 毫秒 |
| referrer | 前页 | 第一个页面传 直接打开 |
| params.path | 分享页 | 分享小程序路径 |
| params.query | 分享页参数 | 分享小程序页面的 query 参数 |
| params.title | 标题 | 分享标题 |
| params.app_session_id | uuid | 应用访问期间的唯一会话 ID |
| params.page_session_id | uuid | 页面打开期间的唯一会话 ID |
点击事件
通过配置表的方式，读取埋点配置 JOSN，触发时上报。
# 数据规范
| 字段 | 说明 | 备注 |
|---|---|---|
| event_id | uuid | 每次随机生成 UUID |
| event_type | click | 点击事件 |
| event_name | 事件名 | 根据业务进行定义 |
| timestamp | 时间戳 | 毫秒 |
| referrer | 前页 | 第一个页面传 直接打开 |
| params.path | 触发页 | 触发页路径 |
| params.app_session_id | uuid | 应用访问期间的唯一会话 ID |
| params.page_session_id | uuid | 页面打开期间的唯一会话 ID |
| params.event_name_chinese | 点击事件中文名称 | 根据业务进行定义中文名称 |
自定义事件
通过开发者自定义来进行上报。
# 数据规范
| 字段 | 说明 | 备注 |
|---|---|---|
| event_id | uuid | 每次随机生成 UUID |
| event_type | custom | 自定义事件 |
| event_name | 事件名 | 根据开发者进行自定义 |
| timestamp | 时间戳 | 毫秒 |
| referrer | 前页 | 第一个页面传 直接打开 |
| params.path | 触发页 | 触发页路径 |
| params.app_session_id | uuid | 应用访问期间的唯一会话 ID |
| params.page_session_id | uuid | 页面打开期间的唯一会话 ID |