Golcer-mina-analysis NPM

微信小程序分析接入

集成准备

通过申请获取appId;
注: 并非小程序的APPID, 向高策相关人员申请
在项目中下载SDK
1. JS脚本文件;import Gsa from 'path/to/golcer-mina-analysis'
2. npm方式下载:npm install golcer-mina-analysis --save

快速集成

工程配置

在小程序项目中, 将https://pluto.golcer.com添加为request合法域名

嵌入代码

将SDK引入代码, 并在应用入口(app.js)完成init调用;

import Gsa from 'golcer-mina-analysis';
Gsa.init({
  appId: 1, // 申请所得的appid
  isProduction: CONFIG.APP.$ENV !== 'development', // 只有在isProduction为真的时候,才会上报数据, 避免数据被污染
  autoTrack: true, // 开启自动上报
  logger: false, // 自动上报控制台输出
  stayTime: true // 自动上报页面停留时长
});
// app.js
App(
  Gsa.App({})
);

使用方法
1. 统计App的内容,App(Gsa.App({})) // app.js
2. 统计Page的内容,Page(Gsa.Page({})) // page1.js
3. 当使用Component构造器, 构建页面时候,Component({behaviors: [Gsa.GsaBehavior]}); // page2.js

API说明

Gsa.init(Object object)

初始化, 需要传入相关配置

参数

appId: {String} 必填通过高策后台申请获取, 并非小程序的appId
isProduction: {Boolean} 非必填默认值为false, 只有为真的时候才会上报数据
autoTrack: {Boolean} 非必填默认值为true, 是否开启自动上报功能, 如果关闭, 则不会主动上报
logger: {Boolean} 非必填默认值为false, 当数据上报的时候, 是否在控制台输出上报内容
stayTime: {Boolean} 非必填默认值为true, 是否开启自动上报页面停留时长数据, 如果关闭, 则不会主动上报
autoTrack: 上报内容包括App: onLaunch/onShow/onHide; Page: onLoad/onShow/onHide/onUnload, 以及用户的主动触发的事件, 如tap, longtap等, 但不包含输入事件, 如onChange; Gsa.Page/Gsa.App 必须要先Gsa.init后才能调用 Gsa.init全局只能调用一次, 且不监听改变

Gsa.App(Object object)

当App页面需要上报数据的时候, 将app option传入该方法后, 再传入App构造器中

// app.js
import Gsa from 'golcer-mina-analysis';
// 必须先完成初始化
Gsa.init({
  appId: 'test123456', // appId, 通过高策后台申请获取, !!!并非小程序的appid!!!
  eventId: 'test456123', // 在后台编辑自定义事件时, 自动生成
  env: 'production', // 环境变量, 只有当环境变量为'production', 才会上报埋点数据, 默认为development
  autoTrack: true, // 是否开启自动上报, 默认为true
  logger: true, // 是否在上报的时候, 在控制台输出, 默认为false
  stayTime: true, // 是否开启自动上报页面停留时长, 默认为true
});
App(Gsa.App({}));

Gsa.Page(Object object)

当页面需要上报数据的时候, 将page option传入该方法后, 再传入Page构造器中

// index.js
import Gsa from 'golcer-mina-analysis';
// 必须App.js中完成初始化;
Page(Gsa.Page({}));

Gsa.GsaBehavior

当使用Compoent构造器构造页面的时候, 使用behavior注入;

// index.js
import Gsa from 'golcer-mina-analysis';
// 必须App.js中完成初始化
Component({
  behaviors: [Gsa.GsaBehavior],
});

Gsa.stat(eventname, data, option)

用于手动上报数据

如果需要上报内置的事件, 需要参考附件1中的内置事件名和数据结构
参数

eventname: 上传的事件名, 如果需要对data内容进行统计, 需要现在后台新建自定义事件, 在init的时候传入eventid; 否则只会保留上传数据, 不会对数据进行后续的分析统计;
data: 自定义上传的数据内容
option
- url: 上传的地址, 默认为高策Api地址;
- header: wx.request header
- method: 上传方式, 默认为'GET', 如果上传的url为高策平台; 则不可以修改;