app_launch

有
在初始化SDK时，可通过auto_report来设置其中app_launch事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onShow

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

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

由事件开关控制，无单独的属性开关

scene

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

int

系统 API

是

由事件开关控制，无单独的属性开关

path

启动小程序的路径

string

系统 API

是

由事件开关控制，无单独的属性开关

query_from_uid

分享来源用户

string

自动生成

是

由事件开关控制，无单独的属性开关

query_from_title

分享标题

string

系统 API

是

由事件开关控制，无单独的属性开关

query_code_id

二维码 ID

int

DataFinder服务端生成

是

由事件开关控制，无单独的属性开关

query_code_group_id

二维码组ID

int

DataFinder服务端生成

是

由事件开关控制，无单独的属性开关

app_terminate

有
在初始化SDK时，可通过auto_report来设置其中app_terminate事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onHide

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

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独的属性开关

scene

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

int

系统 API

是

无单独的属性开关

exit_page

退出时小程序所在页面的路径，通过getCurrentPages()获取到当前页面的path

string

系统 API

是

无单独的属性开关

session_duration

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

int

自动生成

是

无单独的属性开关

session_depth

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

int

自动生成

是

无单独的属性开关

session_duration_range

会话时长区间

string

DataFinder服务端生成

是

无单独的属性开关

session_depth_range

会话深度区间

string

DataFinder服务端生成

是

无单独的属性开关

predefine_pageview

有
在初始化SDK时，可通过auto_report中的pageShow字段来设置predefine_pageview事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onShow

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

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独的属性开关

scene

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

int

系统 API

是

无单独的属性开关

path

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

string

系统 API

是

无单独的属性开关

$is_first_time

是否首次访问，每个用户的第一次访问页面会添加该属性值为true，其他场景下该属性取值为false。
【注意】该属性当前默认为“隐藏”状态（早期的历史项目可能还是“启动”状态），您无法直接使用此属性，如果需要使用时，建议使用事件公共属性“$is_first_day”作为事件是否首日触发的属性

string

DataFinder服务端生成

是

无单独的属性开关

$url_query

小程序的 URL 查询参数

string

DataFinder服务端生成

是

无单独的属性开关

predefine_pageview_hide

有
在初始化SDK时，可通过auto_report中的pageHide字段来设置predefine_pageview_hide事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onHide

页面隐藏

session_id

同predefine_pageview事件中同名的属性，这几个都是predefine_pageview时上报的属性，在predefine_pageview_hide时重复带上，仅1.4.0+版本支持。

string

自动生成

是

无单独的属性开关

scene

int

系统 API

是

无单独的属性开关

path

string

系统 API

是

无单独的属性开关

duration

停留时长，毫秒，在predefine_pageview时记录一个时间，然后在predefine_pageview_hide时计算出时间差

int

自动生成

是

无单独的属性开关

refer_path

上一页面path，仅1.5.4+版本支持，该字段不一定有，取决于是否能获取到页面

string

系统 API

是

无单独的属性开关

refer_query

上一页面的query参数，仅1.5.4+版本支持，该字段不一定有，取决于是否能获取到页面

string

系统 API

是

无单独的属性开关

page_duration

页面时长

int

DataFinder服务端生成

是

无单独的属性开关

$is_first_time

是否首次访问，每个用户的第一次访问页面会添加该属性值为true，其他场景下该属性取值为false。
【注意】该属性当前默认为“隐藏”状态（早期的历史项目可能还是“启动”状态），您无法直接使用此属性，如果需要使用时，建议使用事件公共属性“$is_first_day”作为事件是否首日触发的属性

string

DataFinder服务端生成

是

无单独的属性开关

$url_query

小程序的 URL 查询参数

string

DataFinder服务端生成

是

无单独的属性开关

on_error

有
在初始化SDK时，可通过auto_report中的appError字段来设置on_error事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onError

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

session_id

当前页面的路径，通过getCurrentPages()获取到当前页面的path，仅1.13.0+版本支持

string

自动生成

是

无单独属性开关

on_error

错误信息

string

系统 API

是

无单独属性开关

on_share

有
在初始化SDK时，可通过auto_report中的pageShare字段来设置on_share事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onShareAppMessage

转发

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独属性开关

path

转发时业务所定义的路径，并且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=测试分享的标题"

string

系统 API

是

无单独属性开关

title

转发时业务所定义的标题

string

系统 API

是

无单独属性开关

page_path

path去掉query后的路径，举例：
path: "/page/index?a=1&b=2"
page_path: "/page/index"

string

系统 API

是

无单独属性开关

query_from_uid

当前ssid，ssid是由数据流下发的

string

自动生成

是

无单独属性开关

query_share_depth

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

int

自动生成

是

无单独属性开关

on_addtofavorites

有
在初始化SDK时，可通过auto_report中的pageFavorite字段来设置on_addtofavorites事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onAddToFavorites

收藏

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独属性开关

title

收藏时所定义的标题，仅1.11.0+版本支持

string

系统 API

是

无单独属性开关

url_path

path去掉query后的路径，举例：
path: "/page/index?a=1&b=2"
url_path: "/page/index"

string

系统 API

是

无单独属性开关

url_query

path中query部分，举例：
path: "/page/index?a=1&b=2"
url_query: "a=1&b=2"

string

系统 API

是

无单独属性开关

on_tabbartap

有
在初始化SDK时，可通过auto_report中的pageOnTabItemTap字段来设置on_tabbartap事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onTabItemTap

点击tab时触发

index

被点击 tabItem 的序号，从0开始。仅2.9.1+版本支持

string

系统 API

是

无单独属性开关

path

被点击 tabItem 的页面路径

string

系统 API

是

无单独属性开关

text

被点击 tabItem 的按钮文字

string

系统 API

是

无单独属性开关

app_launch

有
在初始化SDK时，可通过auto_report来设置其中app_launch事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onShow

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

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

由事件开关控制，无单独的属性开关

scene

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

int

系统 API

是

由事件开关控制，无单独的属性开关

path

启动小程序的路径

string

系统 API

是

由事件开关控制，无单独的属性开关

query_from_uid

分享来源用户

string

自动生成

是

由事件开关控制，无单独的属性开关

query_from_title

分享标题

string

系统 API

是

由事件开关控制，无单独的属性开关

app_terminate

有
在初始化SDK时，可通过auto_report来设置其中app_terminate事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onHide

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

session_id

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独的属性开关

scene

scene

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

int

系统 API

是

无单独的属性开关

exit_page

exit_page

退出时小程序所在页面的路径，通过getCurrentPages()获取到当前页面的path

string

系统 API

是

无单独的属性开关

session_duration

session_duration

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

int

自动生成

是

无单独的属性开关

session_depth

session_depth

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

int

自动生成

是

无单独的属性开关

predefine_pageview

有
在初始化SDK时，可通过auto_report中的pageShow字段来设置predefine_pageview事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onShow

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

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独的属性开关

scene

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

int

系统 API

是

无单独的属性开关

path

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

string

系统 API

是

无单独的属性开关

predefine_pageview_hide

有
在初始化SDK时，可通过auto_report中的pageHide字段来设置predefine_pageview_hide事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onHide

页面隐藏

session_id

同predefine_pageview事件中同名的属性，这几个都是predefine_pageview时上报的属性，在predefine_pageview_hide时重复带上，仅1.4.0+版本支持。

string

自动生成

是

无单独的属性开关

scene

int

系统 API

是

无单独的属性开关

path

string

系统 API

是

无单独的属性开关

duration

停留时长，毫秒，在predefine_pageview时记录一个时间，然后在predefine_pageview_hide时计算出时间差

int

自动生成

是

无单独的属性开关

refer_path

上一页面path，仅1.5.4+版本支持，该字段不一定有，取决于是否能获取到页面

string

系统 API

是

无单独的属性开关

refer_query

上一页面的query参数，仅1.5.4+版本支持，该字段不一定有，取决于是否能获取到页面

string

系统 API

是

无单独的属性开关

on_error

有
在初始化SDK时，可通过auto_report中的appError字段来设置on_error事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onError

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

session_id

当前页面的路径，通过getCurrentPages()获取到当前页面的path，仅1.13.0+版本支持

string

自动生成

是

无单独属性开关

on_error

错误信息

string

系统 API

是

无单独属性开关

on_share

有
在初始化SDK时，可通过auto_report中的pageShare字段来设置on_share事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onShareAppMessage

转发

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独属性开关

path

转发时业务所定义的路径，并且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=测试分享的标题"

string

系统 API

是

无单独属性开关

title

转发时业务所定义的标题

string

系统 API

是

无单独属性开关

page_path

path去掉query后的路径，举例：
path: "/page/index?a=1&b=2"
page_path: "/page/index"

string

系统 API

是

无单独属性开关

query_from_uid

当前ssid，ssid是由数据流下发的

string

自动生成

是

无单独属性开关

query_share_depth

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

int

自动生成

是

无单独属性开关

on_addtofavorites

有
在初始化SDK时，可通过auto_report中的pageFavorite字段来设置on_addtofavorites事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onAddToFavorites

收藏

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独属性开关

title

收藏时所定义的标题，仅1.11.0+版本支持

string

系统 API

是

无单独属性开关

url_path

path去掉query后的路径，举例：
path: "/page/index?a=1&b=2"
url_path: "/page/index"

string

系统 API

是

无单独属性开关

url_query

path中query部分，举例：
path: "/page/index?a=1&b=2"
url_query: "a=1&b=2"

string

系统 API

是

无单独属性开关

on_tabbartap

有
在初始化SDK时，可通过auto_report中的pageOnTabItemTap字段来设置on_tabbartap事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onTabItemTap

点击tab时触发

index

被点击 tabItem 的序号，从0开始。仅2.9.1+版本支持

string

系统 API

是

无单独属性开关

path

被点击 tabItem 的页面路径

string

系统 API

是

无单独属性开关

text

被点击 tabItem 的按钮文字

string

系统 API

是

无单独属性开关

app_launch

有
在初始化SDK时，可通过auto_report来设置其中app_launch事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onShow

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

scene

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

int

系统 API

是

由事件开关控制，无单独的属性开关

path

启动小程序的路径

string

系统 API

是

由事件开关控制，无单独的属性开关

query_from_uid

分享来源用户

string

自动生成

是

由事件开关控制，无单独的属性开关

query_from_title

分享标题

string

系统 API

是

由事件开关控制，无单独的属性开关

app_terminate

有
在初始化SDK时，可通过auto_report来设置其中app_terminate事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onHide

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

scene

scene

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

int

系统 API

是

无单独的属性开关

exit_page

exit_page

退出时小程序所在页面的路径，通过getCurrentPages()获取到当前页面的path

string

系统 API

是

无单独的属性开关

session_duration

session_duration

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

int

自动生成

是

无单独的属性开关

session_depth

session_depth

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

int

自动生成

是

无单独的属性开关

predefine_pageview

有
在初始化SDK时，可通过auto_report中的pageShow字段来设置predefine_pageview事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onShow

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

scene

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

int

系统 API

是

无单独的属性开关

path

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

string

系统 API

是

无单独的属性开关

predefine_pageview_hide

有
在初始化SDK时，可通过auto_report中的pageHide字段来设置predefine_pageview_hide事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onHide

页面隐藏

scene

同predefine_pageview事件中同名的属性，这几个都是predefine_pageview时上报的属性，在predefine_pageview_hide时重复带上，仅1.4.0+版本支持。

int

系统 API

是

无单独的属性开关

path

string

系统 API

是

无单独的属性开关

duration

停留时长，毫秒，在predefine_pageview时记录一个时间，然后在predefine_pageview_hide时计算出时间差

int

自动生成

是

无单独的属性开关

on_error

有
在初始化SDK时，可通过auto_report中的appError字段来设置on_error事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onError

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

session_id

当前页面的路径，通过getCurrentPages()获取到当前页面的path，仅1.13.0+版本支持

string

自动生成

是

无单独属性开关

on_error

错误信息

string

系统 API

是

无单独属性开关

on_share

有
在初始化SDK时，可通过auto_report中的pageShare字段来设置on_share事件是否需要采集上报，auto_report默认为false，即不采集上报

Page.onShareAppMessage

转发

path

转发时业务所定义的路径，并且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=测试分享的标题"

string

系统 API

是

无单独属性开关

title

转发时业务所定义的标题

string

系统 API

是

无单独属性开关

page_path

path去掉query后的路径，举例：
path: "/page/index?a=1&b=2"
page_path: "/page/index"

string

系统 API

是

无单独属性开关

query_from_uid

当前ssid，ssid是由数据流下发的

string

自动生成

是

无单独属性开关

query_share_depth

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

int

自动生成

是

无单独属性开关

app_launch

有
在初始化SDK时，可通过auto_report来设置其中app_launch事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onShow

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

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

由事件开关控制，无单独的属性开关

scene

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

int

系统 API

是

由事件开关控制，无单独的属性开关

path

启动小程序的路径

string

系统 API

是

由事件开关控制，无单独的属性开关

query_from_uid

分享来源用户

string

自动生成

是

由事件开关控制，无单独的属性开关

query_from_title

分享标题

string

系统 API

是

由事件开关控制，无单独的属性开关

app_terminate

有
在初始化SDK时，可通过auto_report来设置其中app_terminate事件是否需要采集上报，auto_report默认为false，即不采集上报

App.onHide

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

session_id

session_id

session_id是由SDK随机生成的，每次App.onShow时都生成新的，仅1.3.12+版本支持此属性。数据取值举例：a829cc7f-c86c-462d-971e-0710e9ff66bd

string

自动生成

是

无单独的属性开关

scene

scene

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

int

系统 API

是

无单独的属性开关

exit_page

exit_page

退出时小程序所在页面的路径，通过getCurrentPages()获取到当前页面的path

string

系统 API

是

无单独的属性开关

session_duration

session_duration

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

int

自动生成

是

无单独的属性开关

session_depth

session_depth

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

int

自动生成

是

无单独的属性开关