全部产品
Search
文档中心

移动开发平台mPaaS:配置通用埋点

更新时间:Aug 21, 2023

PC 端和移动端 H5 页面可以使用统一的 H5 埋点方案。通过配置埋点,您可以实现统一的 H5 埋点。

关于此任务

基于不同的业务场景,使用不同的 H5 通用埋点类型。要了解具体的业务场景及对应的埋点类型,查看 通用埋点类型

操作步骤

  1. 引入 CDN 版本的 mtracker。引入 mtracker 后,会在全局 window 中注入 Tracker 对象。

    针对下载的 mtracker 埋点 JS 文件中文出现乱码的情况,正常使用该 JS 文件即可,不会影响埋点配置。该中文乱码问题应该是因文件编码格式与浏览器解释的编码格式不同所导致。

  2. 初始化配置。根据不同场景,在 H5 埋点 JS 文件中注入相应的信息。

    • mPaaS 容器内,即 App 集成了 mPaaS H5 容器。

      代码示例:

      <script>
      window._to = {
        bizScenario: 'alipay',   // 选填,渠道来源,默认为空
        mtrDebug: true,         // 选填,默认为 false
      };
      </script>

      参数

      描述

      bizScenario

      渠道来源,默认为空,选填。

      mtrDebug

      是否开启 mtracker 的 debug 模式,在 debug 模式下会打印上报的日志,默认为 false 不开启。

    • mPaaS 容器外,即 App 未集成 mPaaS H5 容器或浏览器端。

      代码示例:

      <script>
      window._to = {
        server: 'https://cn-hangzhou-mas-log.cloud.alipay.com/loggw/webLog.do', // 必填,接受埋点的服务地址
        appId: 'xxxxxxxxxx', // 必填,App 唯一标识
        workspaceId: 'default', // 必填,环境标识
        h5version: '1.0.0',    // 必填,客户端 App/H5 页面版本
        userId: '1234567890',      // 选填, 默认为空
        bizScenario: 'alipay',   // 选填,渠道来源,默认为空
        mtrDebug: true,         // 选填,默认为 false
        extendParams: { test: 111 } // 选填,全局扩展参数,默认为空,mtracker 1.2.0 版本以上支持
      };
      </script>

      参数

      描述

      server

      接受埋点的服务地址。

      appId

      App 唯一标识。

      workspaceId

      环境标识。

      h5version

      客户端 App 版本或 H5 页面版本。

      userId

      用户 ID,选填

      bizScenario

      渠道来源,默认为空,选填。

      mtrDebug

      是否开启 mtracker 的 debug 模式,在 debug 模式下会打印上报的日志,默认为 false 不开启。

      extendParams

      全局扩展参数,默认为空,mtracker 1.2.0 及以上版本支持。

  3. 初始化 mtracker 对象。

    默认情况下,mtracker 在引入 JS 文件后会自动初始化并注入到 window 对象中。如某些场景中需要手动初始化,需按照下列步骤进行:

    1. 在引入 JS 文件的位置前加入如下代码,禁止自动初始化。

      window.notInitTrackerOnStart = true;
    2. 添加初始化代码。

      window.initTracker();
说明

mtracker 1.2.0 版本起支持修改全局扩展参数,如需使用该功能,请先进行版本升级。

可根据需要修改全局扩展参数。通过在 window._to 中设置 extendParams 参数,可实现在之后的埋点上报中一直添加设置的扩展参数。若在 clickexpo 方法中设置的 ext 值中,有重复属性名,传递的值以 clickexpo 方法中的为准。

可调用以下代码改变已设置的 extendParams,新设置的对象将覆盖以往设置的 extendParams 所有值。

window.changeTrackerExtendParams({ newValue: 11111 });

后续操作

登录移动分析控制台,通过自定义分析页面,分析 mtracker 上报的 H5 通用埋点。具体操作步骤,请参见 分析通用埋点