@alipay-inc/mpaas-miniapp-analytics v1.1.1-alpha.17

mPaaS小程序统计

能力概述

mPaaS小程序统计平台，面向开发者提供微信、支付宝、字节、头条、百度、QQ、天猫精灵小程序数据统计能力。集成后可在mPaaS管理后台查看您的小程序数据

使用方法

• 在mPaaS控制台开通小程序统计，并获取统计代码

原生小程序

import Maa from '@alipay-inc/mpaas-miniapp-analytics';

Maa.init({ 
  appId: '<appId>',
  workspaceId: '<workspaceId>',
  id: '<id>',
  reportUrl: 'url',    // 接受埋点的服务地址。
  getUserInfo: () => ({					// 查询用户信息的方法，支持异步
      "user_id" : "" // 用户ID
      "operators_var" : "", // 赋值运营商名称（移动、联通、电信）。
      "prov_var" : "", // 赋值省份名称。
      "city_var" : "" // 赋值地市名称。
  })
});

• 在小程序源码中的app.js中，顶部插入以上代码即可

uniapp小程序

uniapp小程序，需要在 main.js 中初始化并且用条件编译区分开不同端的ID

import Vue from 'vue'
import App from './App'
import Maa from "@alipay-inc/mpaas-miniapp-analytics";

 //#ifdef  MP-WEIXIN
  Maa.init({ 
    appId: 'xxxxx',                // mPaaS控制台上App 唯一标识
    workspaceId: 'test',           // mPaaS控制台上环境标识
    id: '203233454387956273',      // 在mPaaS注册的微信小程序ID
    reportUrl: '',    // 接受埋点的服务地址。
    getUserInfo: () => ({					// 查询用户信息的方法，支持异步
        "user_id" : " // 用户ID
        "operators_var" : "", // 赋值运营商名称（移动、联通、电信）。
        "prov_var" : "", // 赋值省份名称。
        "city_var" : "" // 赋值地市名称。
    })
  });
  //#endif

  //#ifdef  MP-ALIPAY
  Maa.init({ 
    appId: 'xxxxx',                // mPaaS控制台上App 唯一标识
    workspaceId: 'test',           // mPaaS控制台上环境标识
    id: '203233454387956273',      // 在mPaaS注册的支付宝小程序ID
    reportUrl: '',    // 接受埋点的服务地址。
    getUserInfo: () => ({					// 查询用户信息的方法，支持异步
        "user_id" : "" // 用户ID
        "operators_var" : "", // 赋值运营商名称（移动、联通、电信）。
        "prov_var" : "", // 赋值省份名称。
        "city_var" : "" // 赋值地市名称。
    })
  });
  //#endif

// 使用Maa插件 同时将 Maa 暴露到全局，在使用手动埋点时可直接this.$Maa.tracker({})
Vue.use(Maa);

Vue.config.productionTip = false
App.mpType = 'app'
const app = new Vue({
  ...App
})
app.$mount()

uniapp 分享埋点

在需要分享自定义path的页面里的 onShareAppMessage 手动添加埋点，否则不会自动上报。

 onShareAppMessage(res) {
      const params = {
        title: '自定义分享标题1',
        path:"/pages/test/test?id=123"
      }
      // 调用Maa分享埋点上报
      this.$Maa.onPageShareMessage(params);
      if (res.from === 'button') {// 来自页面内分享按钮
        return params
      }
      return params
    }

setUserInfo 设置用户信息\更新用户信息

新增 setUserInfo 接口，用以更新传入的用户信息。

当前必填值为 user_id ，其余为缺省值。

原生小程序使用方式:

Maa.setUserInfo({ 
    "user_id" : " // 用户ID
    "operators_var" : "", // 赋值运营商名称（移动、联通、电信）。
    "prov_var" : "", // 赋值省份名称。
    "city_var" : "" // 赋值地市名称。
});

uniapp 可使用方式:

this.$Maa.setUserInfo({ 
    "user_id" : " // 用户ID
    "operators_var" : "", // 赋值运营商名称（移动、联通、电信）。
    "prov_var" : "", // 赋值省份名称。
    "city_var" : "" // 赋值地市名称。
});

手动埋点 Maa.tracker

mPaaS提供自定义统计小程序业务数据的 tracker 接口

  Maa.tracker({ 
    eventName: '<string>', // 事件名
    eventData: '<Object>', // 事件数据
  });

页面访问发生时采集

若您需要在页面访问发生时采集其他信息，可使用如下代码示例：

  Maa.tracker({ 
    eventName: 'minpPageView', // 事件名
    eventData: {
        "seed":"xxxx", // 事件ID
        "referpageName_var" : "首页", // 页面访问时上一个页面名称。
        "pageName_var" : "我的", // 页面访问时当前页面名称。
        "iop_tacticsId_var" : "xxxx", // 页面访问时当前页面对应的IOP策略ID号。（物品模型）
        "referFlowId_var" : "xxxx", // 页面访问时来源入口位置ID。（物品模型<url参数解析>）
        }, // 事件数据
    });

事件码

若您需要在事件发生时采集，可使用如下代码示例：

  Maa.tracker({ 
    eventName: 'eventClick', // 事件名
    eventData: {
      "seed":"xxxx", // 事件ID
      "pageName_var" : "首页", // 事件发生时所在页面。
      "flowArea_var" : "轮播", // 事件发生时所在区域。
      "position_var" : "1", // 坑位、运营位位置。
      "flowName_var" : "xxxx" // 事件发生时当前流量位内容或按钮名称等。
      "flow_goodsId_var" : "xxx" // 事件发生时当前流量位的商品ID等。（物品模型）
      "flow_contentId_var" : "xxx" // 事件发生时当前流量位的内容ID等。（物品模型）
      "iop_tacticsId_var" : "xxxxx", // 页面访问时当前页面对应的IOP策略ID号。（物品模型）
      "flowId_var" : "xxxx", // 页面访问时当前页面运营位位置ID。（物品模型）
      }, // 事件数据
    });

业务流程码（业务办理前端流程）

若您需要在业务办理时采集，可使用如下代码示例：

  Maa.tracker({ 
    eventName: 'bussinessProcessing', // 事件名
    eventData: {
      "seed":"xxxx", // 事件ID
      "goodsId_var" : "xxx", // 业务办理时所属的商品ID。
      "goodsName_var" : "xxxxx", //业务办理时商品名称。
      "skuId_var" : "xxxx", // 业务办理时所属的skuID。
      "skuName_var" : "5xxxxx", //业务办理时sku名称。
      "goodsType_var" : "套餐", //业务办理时商品类型。
      "processType_var" : "提交订单",  // 业务办理时的每个办理步骤。（页面浏览、立即办理、二次确认-确认、身份认证、二次确认-取消、提交订单、提交订单成功、提交订单失败、办理成功、办理失败、支付成功、支付失败）
      "errorMessage_var" : "xxxx",  // 业务办理失败时的失败原因明细。（网络问题、业务互斥……）
      "payType_var" : "xxxx", // 业务办理支付时的支付方式名称。（支付宝、微信……）
      "orderNumber_var" : "xxx", // 业务办理支付完成时所属订单号。
      "ordertype_var" : "xxx" // 业务办理支付完成时所属订单类型名称。
      "iop_tacticsId_var" : "xxx", // 页面访问时当前页面对应的IOP策略ID号。（物品模型）
      "referFlowId_var" : "xxxx", // 页面访问时当前页面运营位位置ID。（物品模型）
      }, // 事件数据
    });