5.7 微信小程序 SDK 接入说明

优质
小牛编辑
133浏览
2023-12-01

微信小程序 SDK 部署文档

1. 微信后台为小程序添加合法域名:

jice.fw4.me

2. 引入 JS

var jice = require('jice.weapp.js')

将下载的 SDK 文件放入 util 目录下,且在 app.js 中引入;

下载小程序SDK-原生版小程序 SDK-框架版

3. 初始化

在 app.js App 对象的 onLaunch 方法中调用 init 进行初始化

jice.init("小程序ID", "Jice_APP_ID", options)
jice.setVersion('小程序业务代码版本')
jice.openGetLocation()

// 小程序ID请更新为微信官方分配的ID  
// Jice_APP_ID,请更新为Jice系统分配应用ID
// options 传递onLaunch 的"options"参数

Jice_APP_ID 通过系统中创建应用后即可得到,如下图:

4. 设置 jice 全局变量

在 app.js App 对象中注册 jice 为全局对象

jice: jice

在每个组件中可以通过getApp().jice进行引用;

5.设置每个Page的名称

由于我们会自动获取每个页面的浏览信息,为了您在分析的时候更加直观,请为每个 Page 定义页面名称,在每个 page 增加以下代码,若不定义,则页面标题为空;

Page({
    jicePageTitle: "首页"
})

6. 注册用户信息 addUserIdentifier

当用户通过微信授权登录后,必须调用以下方法来回传用户信息;

this.getUserInfo(function(userInfo){
    jice.addUserIdentifier({
        openid: openid, // openidid
        unionid: unionid, // unionid
       nickname: userInfo.nickName,   //昵称
       wxgender: userInfo.gender,   //性别
       wxcity: userInfo.city,   //微信设置城市
       wxprovince: userInfo.province,   //微信设置省份
       wxcountry: userInfo.country,   //微信设置国家
       avatarurl: userInfo.avatarUrl    //头像url
   })
})

7.设置openid 为用户唯一识别id

在获取到用户的 openid 之后调用以下代码,即可设置用户的 openid 为唯一识别ID;

jice.setOpenId(openid)

8. 用户来源追踪

对于用户来源,在初始化过程中已经做了识别,自动会获取小程序路径参数来识别用户从哪里来(如扫描哪个二维码)。因此在生成二维码、推广、分享时按照如下规则生成页面路径:

参数名称内容格式样例
md标识来源第一层级md=valuemd=Qr_code(代表二维码)
pl标识来源第二层级pl=valuepl=mendian_a(代码门店a)
  • 按照如上规则,生成后页面路径样为:pages/index?md=Qr_code&pl=mendian_a
  • mdpl 参数可全部设置,也可只设置一个,也可全部都缺省;

9. 自定义事件跟踪

// eventKey: 要追踪的事件 key;
// eventAttrs: 事件属性,可以缺省;
// {    
//   eventLabel: /*value*/;
// }

jice.track(eventKey, eventAttrs)

场景示例:分享监测

Page({
  onShareAppMessage: function () {
      jice.track("onshare", {    
        title: "自定义分享标题", 
        path: "/page/user" + "md=share&pl=" + app.globalData.userInfo.nickName  
    })
  }
})

注:如果需要进行细化追踪分享者的影响效果,则可以在 path 后动态加上用户动作名称的昵称,这样就可以统计该分享者最终带来多少用户了。