npm.io
1.3.1 • Published 4 years ago

golcer-mina-analysis

Licence
UNLICENSED
Version
1.3.1
Deps
0
Size
65 kB
Vulns
0
Weekly
0

高灯数据分析

高灯数据分析(Golden Data Analysis)小程序 SDK

集成准备

  1. 通过申请获取 AppID

    并非小程序的 APPID,向高策相关人员申请

  2. 下载 SDK

    npm install golcer-mina-analysis --save

快速集成

工程配置

在小程序开发设置中,将 https://pluto.golcer.com 添加为 request 合法域名

嵌入代码
  1. 在应用入口 app.js 引入 SDK 并初始化

    import GDA from 'golcer-mina-analysis';
    GDA.init({
      appId: '123456789', // 申请得到的 appid
      isProduction: true, // 仅在值为真时才会上报数据,避免数据被污染
      autoTrack: true, // 是否开启自动上报
      logger: false, // 是否开启 console 日志输出
      stayTime: true // 自动上报页面停留时长
    });
WePY

编辑项目入口文件 src/app.wpy,在 <script> 标签最顶部加入:

<script>
import GDA from 'golcer-mina-analysis';
GDA.init({
  appId: '123456789', // 申请得到的 appid
  isProduction: true, // 仅在值为真时才会上报数据,避免数据被污染
  autoTrack: true, // 是否开启自动上报
  logger: false, // 是否开启 console 日志输出
  stayTime: true // 自动上报页面停留时长
});

// ... wepy 代码
import wepy from '@wepy/core';
wepy.app({
  // 选项
});
</script>

API说明

GDA.init(Object object)

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

参数
Object object
属性 类型 默认值 必填 说明
appId string 通过高策后台申请获取,并非小程序的 AppID
isProduction boolean false 仅在值为真时才会上报数据,避免数据被污染
autoTrack boolean true 是否开启自动上报
logger boolean false 是否开启 console 日志输出
stayTime boolean true 是否开启自动上报页面停留时长数据

object.autoTrack 自动上报内容:

  • App:onLaunchonShowonHide
  • Page:onLoadonShowonHideonUnload,以及用户主动触发的时间,如 bind:tapbind:longtap 等,但不包含输入事件,如 bind:input

GDA.init() 全局只能调用一次且不可更改

GDA.stat(String eventname, Any data)

手动上报数据

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

参数
属性 类型 默认值 必填 说明
eventname string 上传的事件名。如果需要对 data 内容进行统计, 需要现在后台新建自定义事件, 在 init 的时候传入 eventid; 否则只会保留上传数据, 不会对数据进行后续的分析统计
data any 自定义上传的数据内容
Object option
属性 类型 默认值 必填 说明
url string 高策 API 地址 上传的地址
header object wx.request header
method string GET 上传方式。当上传的 url 为高策平台时不可修改
GDA.openid(String opnid)

用于手动上传用户的标识信息, 从而生成用户画像

GDA.setUserID(String userID)

用于手动上传用户的标识信息, 从而生成用户画像

参数
属性 类型 默认值 必填 说明
openid string 用户的微信 openid
GDA.getGdaInfo()

用于小程序内嵌 H5 统一数据采集。

将获取的会话信息作为参数拼接到 web-view 的 url 后

// js
import GDA from 'golcer-mina-analysis';
Page({
  data: {
    webUrl: `https://example.com/?${GDA.getGdaInfo()}`
  }
});
<!-- wxml -->
<web-view url="{{webUrl}}" />

FAQ

Keywords