You need to enable JavaScript to run this app.
增长分析(私有化)

增长分析(私有化)

复制全文
支持的预置事件和属性
小程序预置事件及属性
复制全文
小程序预置事件及属性

背景信息
  • 事件/属性类型说明:当前为您介绍的是各个端支持的“预置事件”和“预置事件属性”,除此之外,DataFinder还支持预置事件公共属性、预置用户属性,各类型的属性介绍请参见预置属性总表
  • 上报机制:详情请参见数据上报&缓存策略

私有化

小程序启动事件(app_launch)

事件名

事件开关

监听时机

事件说明

事件属性名

属性描述

属性值类型

数据来源

是否自动上报

属性属性开关控制

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侧属性

Finder数据流处理后属性名

属性描述

属性值类型

数据来源

是否自动上报

属性开关控制

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)

事件名

事件开关

监听时机

事件说明

Finder数据流处理后属性名

属性描述

属性值类型

数据来源

是否自动上报

属性开关控制

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)

事件名

事件开关

监听时机

事件说明

Finder数据流处理后属性名

属性描述

属性值类型

数据来源

是否自动上报

属性开关控制

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

自动生成

无单独的属性开关

小程序错误(error)

事件名

事件开关

监听时机

事件说明

事件属性名

属性描述

属性值类型

数据来源

是否自动上报

开关控制

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

无单独属性开关

转发/收藏/tab切换事件

事件名

事件开关

监听时机

事件说明

事件属性名

属性描述

属性值类型

数据来源

是否自动上报

属性开关控制

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

自动生成

无单独属性开关

最近更新时间:2025.09.15 14:43:16
这个页面对您有帮助吗?
有用
有用
无用
无用