1.0.1-0 • Published 3 years ago
gs_analysis_mina v1.0.1-0
微信小程序分析接入
集成准备
- 通过申请获取appId
- 在项目中下载SDK
- JS脚本文件下载:下载链接
- npm方式下载:
npm install gs_analysis_mina --save
快速集成
工程配置
在小程序项目中, 将https://analysis.gaoshu.com添加为request合法域名
嵌入代码
- 将SDK引入代码, 并在应用入口完成init调用;
import Gsa from 'gaoshu-mina-analysis';
export const gsaMina = Gsa.init({
appId: 'test123456', // 通过高策后台申请获取, !!!并非小程序的appid!!!
eventId: 'test456123', // 在后台编辑自定义事件时, 自动生成
env: 'production', // 环境变量, 只有当环境变量为'production', 才会上报埋点数据, 默认为development
autoTrack: true, // 是否开启自动上报, 默认为true
logger: true, // 是否在上报的时候, 在控制台输出, 默认为false
stayTime: true, // 是否开启自动上报页面停留时长, 默认为true
});
// app.js
App(
Gsa.App({})
);
- 使用方法
- 统计App的内容,
App(Gsa.App({})) // app.js
- 统计Page的内容,
Page(Gsa.Page({})) // page1.js
- 当使用Component构造器, 构建页面时候,
Component({behaviors: [Gsa.GsaBehavior()]}); // page2.js
- 统计App的内容,
API说明
Gsa.init(Object object)
初始化, 需要传入相关配置
参数
属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 |
---|---|---|---|---|---|
appId | String | 是 | 通过高策后台申请获取, !!!并非小程序的appid!!! | ||
eventId | String | 否 | 在后台添加自定义事件时候生成, 每次修改变更自定义事件都会更新需要替换; | ||
env | String | 'development' | 否 | 只有当环境变量等于'production'时候, 才会上报埋点数据, 避免开发测试环境的污染 | |
autoTrack | Boolean | true | 否 | 是否开启自动上报功能, 如果关闭, 则不会主动上报 | |
logger | Boolean | false | 否 | 当数据上报的时候, 是否在控制台输出上报内容 | |
stayTime | Boolean | true | 否 | 是否开启自动上报页面停留时长数据, 如果关闭, 则不会主动上报 |
autoTrack: 上报内容包括App: onLaunch/onShow/onHide; Page: onLoad/onShow/onHide/onUnload, 以及用户的主动触发的事件, 如tap, longtap等, 但不包含输入事件, 如onChange;
Gsa.App(Object object)
当App页面需要上报数据的时候, 将app option传入该方法后, 再传入App构造器中
// app.js
import Gsa from 'gaoshu-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 'gaoshu-mina-analysis';
// 必须App.js中完成初始化;
Page(Gsa.Page({}));
Gsa.GsaBehavior
当使用Compoent构造器构造页面的时候, 使用behavior注入;
组件不需要使用, 有且仅有通过Component构建页面时候才需要注入; 查看使用 Component 构造器构造页面文档地址
// index.js
import Gsa from 'gaoshu-mina-analysis';
// 必须App.js中完成初始化
Component({
behaviors: [Gsa.GsaBehavior()],
});
Gsa.stat(eventname, data, option)
用于手动上报数据
参数
- eventname: 上传的事件名, 如果需要对data内容进行统计, 需要现在后台新建自定义事件, 在init的时候传入eventid; 否则只会保留上传数据, 不会对数据进行后续的分析统计;
- data: 自定义上传的数据内容
- option
- url: 上传的地址, 默认为高策Api地址;
- header: wx.request header
- method: 上传方式, 默认为'POST', 如果上传的url为默认, 高策; 则不需要更改;
*Gsa.openid
用于手动上传用户的标识信息, 从而生成用户画像