运营上报 wxReport

该sdk结合运营平台一起使用。可以上报页面Pv/uv、按钮点击上报等

安装

gnpm install @govcloud/miniprogram-report

WxReport V2 使用(目前版本)

1、constant/config中加入配置

  // 运营平台上报配置
  reportConfig: {
  	mp_appid: '', // 填入小程序的appid(必填)
    appKey: '', // 填入你申请的运营平台的应用key(必填)
    reportUrl: 'http://www.qq.com', // 上报url（接口地址）(必填)
    autoReportPV: true, // 是否自动上报页面PV
    // getRemoteParamsUrl获取远程参数url，主要用于获取intervalTime、reportLogsNum和stopReport参数，
    // 返回格式{stopReport:true,intervalTime:3,reportLogsNum:5}
    getRemoteParamsUrl: '',
    stopReport: false, // 停止上报
    intervalTime: 3, // 间隔多久执行一次上报，默认3秒
    reportLogsNum: 5, // 每次合并上报记录条数，默认5次
  },

2、app.js中初始化sdk代码

// 头部初始化
const { WxReportV2 }   = require('miniprogram-report');
const wxReport = new WxReportV2(config.reportConfig);

//onLaunch 中加入
this.sdk.wxReport = wxReport

// 请在执行了Login以后在开启上报
this.sdk.wxReport.startReport()

3、进行上报

const sdk = getApp().sdk

/*页面pv上报，如果autoReportPV=true，则不需要手动进行上报了
 * pageId 页面标识id
 * exp 额外参数：region是区域码，如果不传的话，可以把区域码写入缓存中, wx.setStorageSync('reportRegion', 44001)
 * */
sdk.wxReport.pagePV('MP_ALLPAGES_ONSHOW',{region:44001})

/*点击流上报
 * eid 事件id
 * exp 额外参数：
 * region是区域码，如果不传的话，可以把区域码写入缓存中, wx.setStorageSync('reportRegion', 44001)
 * itemId:事项id
 * 事项状态:事项状态 entrance：进入 success：成功 fail：失败
 * */
sdk.wxReport.eventClick('MP_SHIXIANG',{itemId:11,itemStatus:'success',region:44001})

WxReport V1 使用

1、constant/config中加入配置

  // 运营平台上报配置
  reportConfig: {
    reportUrl: 'http://www.qq.com', // 上报url（接口地址）
    autoReportPV: false, // 是否自动上报页面PV
    commonPageEId: 'YSS_ALLPAGES_ONSHOW', // 统一的页面上报标志，autoReportPV为true才生效
    // getRemoteParamsUrl获取远程参数url，主要用于获取intervalTime、reportLogsNum和stopReport参数，
    // 返回格式{stopReport:true,intervalTime:3,reportLogsNum:5}
    getRemoteParamsUrl: '',
    stopReport: false, // 停止上报
    intervalTime: 3, // 间隔多久执行一次上报，默认3秒
    reportLogsNum: 5, // 每次合并上报记录条数，默认5次
  },

2、app.js中初始化sdk代码

// 头部初始化
const { WxReportV1 }   = require('miniprogram-report');
const wxReport = new WxReportV1(config.reportConfig);

//onLaunch 中加入
this.sdk.wxReport = wxReport

// 请在执行了Login以后在开启上报
this.sdk.wxReport.startReport()

3、进行上报

const sdk = getApp().sdk

/*页面pv上报
 * pageId 页面标识id
 * exp 额外参数：region是区域码，如果不传的话，可以把区域码写入缓存中, wx.setStorageSync('reportRegion', 44001)
 * */
sdk.wxReport.pagePV('YSS_ALLPAGES_ONSHOW',{region:44001})

/*点击流上报
 * eid 事件id
 * exp 额外参数：
 * region是区域码，如果不传的话，可以把区域码写入缓存中, wx.setStorageSync('reportRegion', 44001)
 * itemId:事项id
 * 事项状态:事项状态 entrance：进入 success：成功 fail：失败
 * */
sdk.wxReport.eventClick('YSS_SHIXIANG',{itemId:11,itemStatus:'success',region:44001})