跳到主要内容

自动采集

最近更新 2026/10/03

在 1.2.0 版本后，我们提供了自动采集功能，只需在创建实例的 config 中开启您需要自动采集的事件，SDK 将会自动采集小程序的一些行为，现在主要有以下几种事件支持自动采集：

现在支持的自动化收集数据有：

  1. 小程序初始化，用户一次使用只会触发一次
  2. 小程序启动，包括启动与后台调回前台
  3. 小程序调入后台，并记录本次访问（启动至调入后台）的时间
  4. 小程序页面显示或切入前台，自动记录页面的路径以及前向路径
  5. 小程序进行转发分享，自动记录转发时的页面
  6. 小程序页面卸载，自动记录页面卸载时触发（3.2.0及以上版本支持）
  7. 小程序页面收藏，自动记录页面被收藏时触发（3.2.0及以上版本支持）
  8. 小程序页面元素点击，自动记录页面元素被点击时触发（3.2.0及以上版本支持）

接下来将会详细介绍每种数据的采集方法

一、 开启自动采集事件​

在 config 中，参数autoTrack中的元素表示每个自动采集事件的开关，设置为true为开启自动采集：

var config = {
  appid: "YOU-APP-ID",
  server_url: "https://youserverurl.com",
  autoTrack: {
    appLaunch: true, // 自动采集 ta_mp_launch
    appShow: true, // 自动采集 ta_mp_show
    appHide: true, // 自动采集 ta_mp_hide
    pageShow: true, // 自动采集 ta_mp_view
    pageShare: true, // 自动采集 ta_mp_share
    pageLeave: true,// 自动采集 ta_page_leave
    mpFavorite: true,// 自动采集 ta_add_favorite
    mpClick: true,// 自动采集 ta_mp_click
    properties: { // 自动采集自定义属性
        staticKey: 'staticValue'
    },
    callback: (eventType:any) => { // 自动采集回调
        if (eventType === 'appShow') {
            return { appShowKey: 'appShowValue' };
        } else if (eventType === 'appHide') {
            return { appHideKey: 'appHideValue' };
        } else {
            return {};
        }
    }
  }
};
  • appLaunch：自动采集小程序初始化
  • appShow：自动采集小程序启动，或从后台进入前台
  • appHide：自动采集小程序从前台进入后台
  • pageShow：自动采集小程序页面显示或切入前台
  • pageShare：自动采集小程序进行转发分享
  • pageLeave：自动采集小程序页面卸载
  • mpFavorite：自动采集页面收藏
  • mpClick：自动采集页面元素点击
  • properties：自动采集自定义属性（支持appShow/appHide）
  • callback：自动采集回调（支持appShow/appHide）

不同平台由于运行环境以及结构原因，支持不同的自动采集事件，支持列表如下：

平台appLaunchappShowappHidepageShowpageSharepageLeavempFavoritempClick
小程序√√√√√√√√
小游戏√√√

二、 自动采集事件详解​

2.1 小程序初始化​

小程序初始化将会在小程序被首次打开时，或用户杀死进程再重新开启时触发，在进程的生命周期内只会触发一次，详细的事件介绍如下：

  • 事件名：ta_mp_launch

  • 自动采集属性：

    • #scene：场景值，取自微信提供的场景值
    • #start_reason：应用启动来源，内容为JSON字符串，是从getLaunchOptionsSync接口获取的参数

通过小程序初始化事件，您可以计算每天的用户使用次数、人均使用次数，包括以场景值做分组，查看不同场景值的用户的使用情况。

2.2 小程序启动​

小程序启动将会在小程序被启动、或小程序被从后台调回前台时触发，详细的事件介绍如下：

  • 事件名：ta_mp_show

  • 自动采集属性：

    • #scene，场景值，取自微信提供的场景值
    • #url_path，页面路径，小程序启动被展示页面的路径
    • #start_reason：应用启动来源，内容为JSON字符串，是从getLaunchOptionsSync接口获取的参数

小程序启动由于会受到调出前后台的影响（条数较多），因此不太适合直接进行分析，但是可以在行为路径中标识用户的一次使用，可以作为用户行为路径的初始行为

2.3 小程序隐藏​

小程序隐藏将会在小程序被调入后台时触发，并记录本次使用的时长，详细的事件介绍如下：

  • 事件名：ta_mp_hide

  • 自动采集属性：

    • #scene，场景值，取自微信提供的场景值
    • #duration，数值型，表示本次启动（ta_mp_show）到隐藏的持续时长

小程序隐藏事件会记录使用时长（单位为秒），因此可以直接计算用户使用总时长以及人均时长，也可以除以初始化次数计算单次使用时长。

2.4 小程序页面浏览​

小程序页面浏览将会在小程序的页面被打开时，或小程序从后台调回前台的页面展示时触发，会记录页面的路径以及访问的前向路径，详细的事件介绍如下：

  • 事件名：ta_mp_view

  • 自动采集属性：

    • #scene，场景值，取自微信提供的场景值
    • #url_path，页面路径，也就是被展示页面的路径
    • #referrer，前向路径，被展示页面之前页面的路径，也就是跳转前路径，如果是启动小程序时展示的首页，则取值为“直接打开”

通过小程序页面浏览事件，您可以计算每个页面的 pv、uv，以及用户访问小程序的使用路径。

2.5 小程序页面转发分享​

小程序页面转发分享将会在转发按钮被点击时触发（包括右上角导航栏的转发按钮，以及页面中的转发按钮），详细的事件介绍如下：

  • 事件名：ta_mp_share

  • 自动采集属性：

    • #scene，场景值，取自微信提供的场景值
    • #url_path，页面路径，也就是转发时所在的页面路径

小程序页面转发分享事件，适合对页面的分享率进行分析，可以帮助您优化页面转发。

2.6 小程序页面卸载​

小程序页面卸载时触发（例如到其他页面时），详细的事件介绍如下：

  • 事件名：ta_page_leave

  • 自动采集属性：

    • #duration，页面停留时长
    • #url_path，页面路径，也就是页面卸载时的路径

2.7 小程序页面收藏​

小程序页面被收藏时触发，详细的事件介绍如下：

  • 事件名：ta_add_favorite
  • 自动采集属性：
    • #url_path，页面路径，也就是页面卸载时的路径

2.8 小程序页面元素点击​

小程序页面元素被点击时触发，详细的事件介绍如下：

  • 事件名：ta_mp_click

  • 自动采集属性：

    • #element_id，元素 ID
    • #element_type，元素类型
    • #element_content，元素内容
    • #element_name，元素名称
这篇文档对你有帮助吗？
本页内容