该文档适用于友盟+微信小程序统计SDK 2.3.2 及以上版本。
登录友盟+官网(www.umeng.com),按照引导注册友盟+账号

特别提醒:我们建议开发者在注册账号时使用企业邮箱,避免使用个人邮箱注册,防止由于个人离职带来的问题,建议使用的账号形式 :umeng@企业域名、apps@企业域名、dev@企业域名
npm install umtrack-wx --save
注:在微信小程序内使用npm请参考https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html
在app.js文件内,添加如下代码,即可进行基础指标的统计:**
import 'umtrack-wx';
App({
umengConfig: {
appKey: 'YOUR_UMENG_APPKEY', //由友盟分配的APP_KEY
useOpenid: false, // 是否使用openid进行统计,此项为false时将使用友盟+随机ID进行用户统计。使用openid来统计微信小程序的用户,会使统计的指标更为准确,对系统准确性要求高的应用推荐使用OpenID。
autoGetOpenid: false, // 是否需要通过友盟后台获取openid,如若需要,请到友盟后台设置appId及secret
debug: true, //是否打开调试模式
uploadUserInfo: true // 自动上传用户信息,设为false取消上传,默认为false
}
});
注意:切记一定要正确设置umengConfig,不要拼写错误
当useOpenid: true时
**方法一:**开发者需要额外添加代码上传openid,否则数据不会上报
// 开启后必须额外添加代码上传OpenID,否则数据不会上报
wx.uma.setOpenid(openid)
参数:
返回值:
**方法二:**开启autoGetOpenid: true并在友盟后台设置有效appId及secret信息
App({
umengConfig: {
appKey: 'YOUR_UMENG_APPKEY', //由友盟分配的APP_KEY
useOpenid: true,
// 授权友盟+通过后台自动获取openid,可防止数据统计过程中因未采集到OpenID而造成
// 数据丢失的情况。开启后请到友盟+小程序应用设置中添加appId及secret信息
autoGetOpenid: true
}
在微信开发者后台添加request合法域名:umini.shujupie.com
操作步骤:登录微信公众平台,进入小程序的 设置->开发->开发设置->服务器域名,把 umini.shujupie.com 加入 request合法域名,如图:

服务商在获取小程序APPID、订单号、授权码后,服务商可通过OpenAPI的方式,申请友盟+APPkey,并返还到SDK中。
API测试工具,请点击下载:UMiniOpenApi-1.0.10-java.zip
UmengUminiCreateMiniAppParam param = new UmengUminiCreateMiniAppParam();
param.setName("应用名称");
param.setType("mini");
param.setPlatform("平台");
param.setLanguage("CN");
param.setFirstLevel("一级分类");
param.setSecondLevel("二级分类");
param.setDescription("描述……");
param.setMiniAppId("");
param.setMiniAppSecret("");
param.setMiniPublicKey("");
param.setMiniPrivateKey("");
try {
UmengUminiCreateMiniAppResult result = apiExecutor.execute(param);
System.out.println("1、" + JSONObject.toJSONString(result));
} catch (OceanException e) {
System.out.println("1、errorCode=" + e.getErrorCode() + ", errorMessage=" + e.getErrorMessage());
}
特别说明:
OpenAPI具体说明请参考:
https://developer.umeng.com/open-api/docs/com.umeng.umini/umeng.umini.createMiniApp/1
行业分类请参考:https://developer.umeng.com/docs/147615/detail/169442
若创建应用数超过300,请联系在线客服
具体集成方式可参考demo:https://github.com/umeng/mp-demos
如需使用其他API,需要添加如下代码:
import uma from 'umtrack-wx';
App({
umengConfig: {
appKey: 'test5d886faf4ca357bfc900',
useOpenid: true,
autoGetOpenid: false,
debug: true
},
globalData: {
uma // 请将uma模块绑定在gloabalData下,以便后续使用
}
});
开发者自行设置用户的unionid
setUnionid(id)
参数:
返回值:
trackEvent(eventId, params)
参数:
返回值:
wx.uma.trackEvent('事件ID');
wx.uma.trackEvent('事件ID', { '属性1':'属性值1','属性2':'属性值2' });
// 字符型属性值
wx.uma.trackEvent('ViewProductDetails', { 'Category':'家电','ItemName':'西门子冰箱' });
// 数值型属性值
wx.uma.trackEvent('Pay', { 'PayAmount':6999 });
注意:
- params为object类型时,属性值仅支持字符串和数值两种类型;
- 请在App.onLaunch之后调用事件。
当用户在您的小程序上注册以后,您的应用服务端会在用户数据库里添加一条记录并且分配一个用户ID,可以通过 setUserid
接口设置该用户ID,以便后续做数据打通或基于应用用户ID做计算时使用。
setUserid(userId, provider)
参数:
wx.uma.setUserid('custom_userid');
开发者可通过在配置中添加 uploadUserInfo: true
选项来使友盟自动上报用户信息。将 uploadUserInfo
设置为 false
则取消上报用户信息。上传的用户信息为小程序平台公开可获取的用户基础信息,例如昵称、头像、性别、地区、语言等,这些信息将用于U-MiniProgram产品中与用户相关的功能统计中。示例:
import 'umtrack-wx';
App({
umengConfig: {
appKey: 'YOUR_UMENG_APPKEY', //由友盟分配的APP_KEY
useOpenid: false, // 是否使用openid进行统计,此项为false时将使用友盟+随机ID进行用户统计。使用openid来统计微信小程序的用户,会使统计的指标更为准确,对系统准确性要求高的应用推荐使用OpenID。
autoGetOpenid: false, // 是否需要通过友盟后台获取openid,如若需要,请到友盟后台设置appId及secret
debug: true, //是否打开调试模式
uploadUserInfo: true // 自动上传用户信息,设为false取消上传,默认为false
}
});
该方案仅提供验证是否集成成功的方法,由于在开发环境下可能会存在数据不完整的情况,请您正式发布小程序后在验证数据正确性。
目前小程序SDK支持以下第三方框架,具体使用方法请参考demo:https://github.com/umeng/mp-demos
目前只有2.2.0及以上版本的SDK才支持以上第三方框架
视频引导教程
https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html