小程序预置事件及属性

os_name

操作系统

SaaS-云原生/私有化

String

系统 API

取值为ios/android/windows/mac

os_version

系统版本

SaaS-云原生/私有化

String

系统 API

device_model

设备型号

SaaS-云原生/私有化

String

系统 API

language

系统语言

SaaS-云原生/私有化

String

系统 API

platform

平台类型

SaaS-云原生/私有化

String

固定值

sdk_version

SDK版本

SaaS-云原生/私有化

String

SDK 生成

sdk_lib

SDK类型

SaaS-云原生/私有化

String

固定值

timezone

时区

私有化

String

系统 API

resolution

分辨率

SaaS-云原生/私有化

String

系统 API

screen_width

SaaS-字节云

Number

系统 API

screen_height

SaaS-字节云

Number

系统 API

device_brand

手机品牌

SaaS-云原生/私有化

String

系统 API

network_type

网络类型

SaaS-云原生/私有化（saas-字节云里是用户属性）

String

系统 API

app_version

软件版本

SaaS-云原生/私有化（saas-字节云里是用户属性）

• SaaS-云原生/私有化：String
• SaaS-字节云：version

系统 API

event_index

无

Saas

float

SDK 生成

仅 Web，

$current_path

当前页面path

Saas/私有化

String

系统 API

仅 小程序，当前页面的 path

$current_query

当前页面query

Saas/私有化

String

系统 API

仅 小程序，当前页面的 query

app_launch

App.onShow

小程序冷启动，以及从后台进入前台时上报，另外在设置user_unique_id时也会上报

session_id

会话ID

SaaS/私有化

string

session_id是由SDK随机生成的，每次App.onShow时都生成新的。

1.3.12+

举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

scene

场景值

SaaS/私有化

int

场景值

场景值 场景 appId含义
1020 公众号 profile 页相关小程序列表 来源公众号
1035 公众号自定义菜单 来源公众号
1036 App 分享消息卡片 来源App
1037 小程序打开小程序 来源小程序
1038 从另一个小程序返回 来源小程序
1043 公众号模板消息 来源公众号

path

启动路径

SaaS/私有化

string

启动小程序的路径

$is_first_time

是否首次访问

SaaS/私有化

string

是否首次访问

'true'或者'false'

query_${key}

无

SaaS/私有化

any

启动小程序的query对象中每一个query属性，每个属性会增加"query_"作为前缀。

举例：
原始query对象为
{
a: 'isa',
b: 'notb'
}
会产生
query_a: 'isa'
query_b: 'notb'
放入app_launch事件中作为事件属性

query_from_uid

无

SaaS/私有化

string

分享来源

query_from_title

无

saas-云原生/私有化

string

分享标题

app_terminate

App.onHide

小程序退出以及进入后台时上报，另外在设置user_unique_id的变更前也会上报

session_id

会话ID

SaaS/私有化

string

session_id是由SDK随机生成的，每次App.onShow时都生成新的。

1.3.12+

scene

场景值

SaaS/私有化

int

场景值

exit_page

退出页面

SaaS/私有化

string

退出时小程序所在页面的路径

通过getCurrentPages()获取到当前页面的path

session_duration

本次打开应用的会话时长

SaaS/私有化

int

session时长，秒

在app_launch时记录一个时间，然后在app_terminate时计算出时间差

session_depth

会话深度

SaaS/私有化

int

会话深度

在app_launch时开始时设置session_depth为0，之后每次页面切换时对session_depth进行加1，最后在app_terminate时获取带上

query_${key}

无

SaaS/私有化

any

当前页面的options对象中每一个option属性，每个属性会增加"query_"作为前缀。

通过getCurrentPages()获取到当前页面的options
处理方式同app_launch时的做法一致

predefine_pageview

Page.onShow

页面显示时上报，另外在后退操作时也会上报

session_id

会话ID

SaaS/私有化

string

session_id是由SDK随机生成的，每次App.onShow时都生成新的。

1.3.12+

scene

场景值

SaaS/私有化

int

场景值

path

启动路径

SaaS/私有化

string

当前页面的路径

通过getCurrentPages()获取到当前页面的path

query_${key}

无

SaaS/私有化

any

当前页面的options对象中每一个option属性，每个属性会增加"query_"作为前缀。

通过getCurrentPages()获取到当前页面的options
处理方式同app_launch时的做法一致

title

访问页面标题

SaaS/私有化

当前页面标题

1.5.4+

refer_path

SaaS/私有化

上一页面path

该字段不一定有，取决于是否有上一个页面

refer_query

SaaS/私有化

上一页面的query参数

该字段不一定有，取决于是否有上一个页面

bav2b_click

Page中定义的事件处理函数被触发时

目前只支持tap事件

path

启动路径

SaaS/私有化

string

当前页面的路径

1.13.0+

通过getCurrentPages()获取到当前页面的path

page_key

SaaS/私有化

string

目前等于path

query_${key}

SaaS/私有化

string

当前被触发节点所附加一些自定义数据（dataset）

举例：
组件上设置了data-xxx="这是xxx"，被采集作为query_xxx: "这是xxx"

predefine_pageview_hide

Page.onHide

页面隐藏

session_id

会话ID

SaaS/私有化

string

session_id是由SDK随机生成的，每次App.onShow时都生成新的。

1.4.0+

这几个都是predefine_pageview时的属性，在predefine_pageview_hide时重复带上

scene

场景值

SaaS/私有化

int

场景值

path

启动路径

SaaS/私有化

string

当前页面的路径

query_${key}

SaaS/私有化

any

当前页面的options对象中每一个option属性，每个属性会增加"query_"作为前缀。

duration

停留时长

SaaS/私有化

int

停留时长，毫秒

在predefine_pageview时记录一个时间，然后在predefine_pageview_hide时计算出时间差

title

访问页面标题

SaaS/私有化

string

当前页面标题

1.5.4+

该字段不一定有，取决于是否能获取到标题

on_error

App.onError

小程序发生脚本错误或 API 调用报错时触发

session_id

会话ID

SaaS

session_id是由SDK随机生成的，每次App.onShow时都生成新的。

string

1.3.12+

on_error

错误信息

SaaS

错误信息

string

on_share

Page.onShareAppMessage

转发

session_id

会话ID

SaaS/私有化

string

session_id是由SDK随机生成的，每次App.onShow时都生成新的。

1.3.12+

path

启动路径

SaaS/私有化

string

转发时业务所定义的路径，并且SDK会为path增加额外的4个参数：
from_uid
from_user_unique_id
share_depth
from_title

举例：
业务原本的path假设为"/page/index?a=1&b=2"，以及title为测试分享的标题，则处理后的path为"/page/index?a=1&b=2&from_uid=45c9b10b-7b66-406c-be40-6ecbb68c2d5e&from_user_unique_id=bytedance-test&share_depth=1&from_title=测试分享的标题"

title

访问页面标题

SaaS/私有化

string

转发时业务所定义的标题

page_path

页面路径

SaaS/私有化

string

path去掉query后的路径

举例：
path: "/page/index?a=1&b=2"
page_path: "/page/index"

query_from_uid

无

SaaS/私有化

string

当前ssid

ssid是由数据流下发的

query_share_depth

分享深度

SaaS/私有化

float

分享深度

在app_luanch的时候获取query中的share_depth并记录下来，在转发时，有则加1，没有则为1

on_addtofavorites

Page.onAddToFavorites

收藏

session_id

会话ID

SaaS/私有化

string

session_id是由SDK随机生成的，每次App.onShow时都生成新的。

同上

title

访问页面标题

SaaS/私有化

string

收藏时所定义的标题

1.11.0+

url_path

URL地址

SaaS/私有化

string

path去掉query后的路径

举例：
path: "/page/index?a=1&b=2"
url_path: "/page/index"

url_query

URL查询参数

SaaS

string

path中query部分

举例：
path: "/page/index?a=1&b=2"
url_query: "a=1&b=2"

on_tabbartap

Page.onTabItemTap

点击tab时触发

index

暂不支持

string

被点击 tabItem 的序号，从0开始

2.9.1+

path

启动路径

SaaS/私有化

string

被点击 tabItem 的页面路径

texts

元素文案

暂不支持

string

被点击 tabItem 的按钮文字

abtest_exposure

实验曝光

ab_url

SaaS/私有化

页面地址

string