WePY 小程序框架 SDK

优质

小牛编辑

138浏览

2023-12-01

WePY 小程序框架 SDK

接入WePY小程序框架需要「微信授权」和「集成SDK」。

微信小程序授权

注：微信小程序授权必须是企业号(已发布并审核通过)，个人号不能授权。

授权后，会自动采集小程序头像、小程序名称、AppID(小程序ID)等小程序信息；在已授权列表中，可查看小程序头像、小程序名称、AppID(小程序ID)。

如果有多个微信小程序，可授权多个小程序，点击「继续授权」继续授权。

集成SDK

集成SDK采集WePY微信标准或插件版小程序用户行为和用户信息。

1.登录「微信公众平台」，在「开发-开发设置-服务器域名」的「request合法域名」中,增加诸葛域名:

https://u.zhugeapi.net

https://ubak.zhugeio.com

2.下载并安装SDK文件：点击下载SDK(SDK文件目录:demo/zhuge.js)

3.在yourProject/src/app.wpy文件的script标签开始位置，引入SDK文件：

const App = require('zhuge-wx.min.js').App // 填写真实的SDK地址
var zgconfig = {
  debug: false, // 打开实时调试
  pv: false, // 是否启用页面访问统计功能
  click: false, // 是否采集tap事件 默认关闭
  forwardShare: false, // 是否启用转发分享数据采集开关，默认为false
  usePlugin: false ,// 选填，如果使用了插件版小程序，设为true
  countDuration: 3000 // countDuration配置是trackCount函数连续触发的动作停止之后等待的时间，
单位毫秒默认值为3000ms。超过等待时间会上传定义的事件和属性包含函数执行的次数和连续触发持续的时间.
}
App.zhuge.load('此处填写您在诸葛申请的APP KEY', zgconfig)

使用示例：

App.zhuge.load('AppKey', {
    pv: true
})

trackCount(eventName, props)

eventName 事件名称 props 事件属性


App.zhuge.trackCount('like', {
  '商品名称': '华为P30',
  '商品分类': '3C'
})

trackCount是用来记录事件触发的次数，适用于频繁触发事件的场景比如视频直播点赞。
函数连续触发时会记录执行的次数，当函数停止执行会等待集成sdk设置的countDuration时间，超时后会上传事件和事件属性，通过trackCount函数上传的事件会附带两个自定义属性count和countTime，分别代表执行的次数和连续触发持续的时间。
注意：函数执行的过程中如果事件名称和事件属性发生变化trackCount函数会立刻上传上次的事件和属性，然后重新开始计数。

4.在每个页面的wpy文件script代码段顶部，添加如下代码：

// eslint-disable-next-line
const Page = require('zhuge-wx.min.js').Page // 填写真实的SDK地址

5.在项目根目录的.eslintrc.js文件中添加如下配置：

module.exports = {
  "globals": {
    "App": true,
    "Page": true
  }
}

6.记录用户行为

在需要记录用户行为的部分，调用如下方法：

App.zhuge.track('购买手机', {
  '手机': '小米4',
  '价格': 1799, // 数值型属性不要带引号
  '运营商': '移动'
})

注意：在添加事件属性时，需注意事件属性类型。如果事件属性类型为「数值型属性」，需要在上传数据时修改数据类型为「数值型」，并且在诸葛io后台埋点管理中修改为「数值型」。

6.绑定用户信息

6.1自定义绑定用户信息

为了保持对用户的跟踪，你需要为他们记录一个识别码，可以使用手机号、email等唯一值来作为用户的识别码。另外，也可以在跟踪用户的时候，记录用户更多的属性信息，便于你更了解你的用户：

 App.zhuge.identify('user_id', {
  '属性名称': '属性值'
})

6.2快捷绑定微信用户信息

通过「微信授权」登录小程序，可使用快捷绑定微信用户信息方法，在「微信授权成功」后调用如下方法：

App.zhuge.weixinIdentify()

说明：内置绑定的信息内容如下

 {
  'user_id':unionid, // 用户唯一标识
  'name': userInfo.nickName, // 名称
  'avatar': userInfo.avatarUrl, // 头像
  '微信-昵称': userInfo.nickName,
  '微信-性别': gender, 
  '微信-城市': userInfo.city,
  '微信-省': userInfo.province,
  '微信-国家': userInfo.country
 }

注：

1.使用weixinIdentify()方法，需要提供「AppSecret」给诸葛io技术支持人员，用来获取unionid标识用户；登录「微信公众平台」，在「设置-开发者设置-开发者ID」中生成获取。

2.如可自行获取到unionID,可调用自定义identify方法，绑定微信用户信息。

7.记录转发分享

转发分享数据默认为不采集，如需采集，需要您在引入SDK初始化时，设置如下参数：

forwardShare: true // 转发分享采集开关，默认为false

开启转发分享数据采集后，SDK会将转发分享自动作为事件上传(页面title和path路径作为事件属性上传)。

注：需小程序页面具有「转发分享」功能并使用onShareAppMessage函数，才能采集转发分享数据。

8.记录收入数据采集

记录收入数据采集，需调用trackRevenue函数，自动记录收入事件以及事件属性；price(商品价格)、productID(商品ID)、productQuantity(商品数量)、revenueType(收入类型)为收入事件内置属性，必传项。

具体使用方法如下：

zhuge.trackRevenue({
   'price': 229,
   'productID':'小米NFC手环',
   'productQuantity':2,
   'revenueType':'手环'
});