QQ小程序
该文档包含友盟+QQ小程序统计包含SDK的接入方法、集成测试等内容。按以下步骤成功集成SDK后,即可查看友盟+为您QQ小程序提供的数据采集服务。
适用范围
友盟+QQ小程序统计SDK 2.4.0 及以上版本。
一、QQ小程序统计SDK快速集成
1. 注册友盟+账号
登录友盟+官网,按照引导注册友盟+账号
特别提醒:我们建议开发者在注册账号时使用企业邮箱,避免使用个人邮箱注册,防止由于个人离职带来的问题,建议使用的账号形式 :umeng@企业域名、apps@企业域名、dev@企业域名
2. Appkey申请
进入小程序统计后台创建Appkey,按要求填写小程序名称及类型:
您也可通过OpenAPI批量申请Appkey,具体文档参考:https://developer.umeng.com/open-api/docs/com.umeng.umini/umeng.umini.createMiniApp/1
行业分类请参考:https://developer.umeng.com/docs/147615/detail/169442若创建应用数超过300,请联系在线客服
3. 创建QQ小程序并接入SDK
3.1 集成SDK
3.1.1 手动集成方式
下载sdk, https://at.umtrack.com/myaeWD, 把下载的文件放在QQ小程序项目里,比如 utils 目录下。下面会假设 SDK 文件放在 utils 目录下。
在QQ小程序项目根目录的启动文件 app.js 文件的顶部添加以下JS代码
在app.js文件内,添加如下代码,即可进行基础指标的统计:
var uma = require('./utils/uma.min');
App({
umengConfig:{
appKey:'YOUR_UMENG_APPKEY',//由友盟分配的APP_KEY
useOpenid:true,// 使用Openid进行统计,此项为false时将使用友盟+uuid进行用户统计。使用Openid来统计QQ小程序的用户,会使统计的指标更为准确,对系统准确性要求高的应用推荐使用Openid。
autoGetOpenid:false,// 使用openid进行统计时,是否授权友盟自动获取Openid,如若需要,请到友盟后台"设置管理-应用信息"(https://mp.umeng.com/setting/appset)中设置appId及secret
debug:true,//是否打开调试模式
uploadUserInfo:true// 自动上传用户信息,设为false取消上传,默认为false
}
});注意:切记一定要正确设置umengConfig,不要拼写错误
3.2 使用 Openid(可选)
当useOpenid: true时方法一:开启autoGetOpenid: true并在友盟后台”设置管理-应用信息”(https://mp.umeng.com/setting/appset)中设置有效appId及secret信息,授权友盟自动获取Openid
App({
umengConfig:{
appKey:'YOUR_UMENG_APPKEY',//由友盟分配的APP_KEY
useOpenid:true,
autoGetOpenid:true// 授权友盟+通过后台自动获取openid,可防止数据统计过程中因未采集到OpenID而造成数据丢失的情况。开启后请到友盟后台"设置管理-应用信息"(https://mp.umeng.com/setting/appset)中设置中添加appId及secret信息
}
})方法二:若未开启autoGetOpenid: true自动获取OpenId,开发者需要额外添加代码上传Openid,否则数据不会上报
// 开启后必须额外添加代码上传Openid,否则数据不会上报
qq.uma.setOpenid(openid)参数:
id(string): 开发者获取到的用户Openid
返回值:
无
3.3 QQ小程序增加友盟+数据服务域名
在QQ开发者后台添加request合法域名:https://umini.shujupie.com操作步骤:登录QQ小程序开放平台,进入小程序的 设置->开发设置->服务器域名,把 https://umini.shujupie.com 加入 request合法域名,如图:
3.4 demo
具体集成方式可参考demo:https://github.com/umeng/mp-demos
3.5 sdk配置项及注意事项总结

二、高级功能
如需使用其他API,需要添加如下代码:
import'umtrack-qq';
App({
umengConfig:{
appKey:'test5d886faf4ca357bfc900',
useOpenid:true,
autoGetOpenid:false,
debug:true
}
});1. setUnionid
开发者自行设置用户的unionid
qq.uma.setUnionid(id)参数:
id(string): 开发者获取到的用户unionid
返回值:
无
2. 自定义事件
参考:小程序自定义事件文档
3. 设置应用用户ID
当用户在您的小程序上注册以后,您的应用服务端会在用户数据库里添加一条记录并且分配一个用户ID,可以通过 setUserid 接口设置该用户ID,以便后续做数据打通或基于应用用户ID做计算时使用。
setUserid(userId, provider)参数:
userId(string): 您的应用为用户生成的唯一ID
provider(string): ID提供方,兼容老接口使用,无特殊需要应忽略该参数
返回值:无示例:
qq.uma.setUserid('custom_userid');4. 上传用户信息
开发者可通过在配置中添加 uploadUserInfo: true 选项来使友盟自动上报用户信息。将 uploadUserInfo 设置为 false 则取消上报用户信息。上传的用户信息为小程序平台公开可获取的用户基础信息,例如昵称、头像、性别、地区、语言等,这些信息将用于U-MiniProgram产品中与用户相关的功能统计中。示例:
import'umtrack-qq';
App({
umengConfig:{
appKey:'YOUR_UMENG_APPKEY',//由友盟分配的APP_KEY
useOpenid:false,// 是否使用openid进行统计,此项为false时将使用友盟+随机ID进行用户统计。使用openid来统计QQ小程序的用户,会使统计的指标更为准确,对系统准确性要求高的应用推荐使用OpenID。
autoGetOpenid:false,// 是否需要通过友盟后台获取openid,如若需要,请到友盟后台设置appId及secret
debug:true,//是否打开调试模式
uploadUserInfo:true// 自动上传用户信息,设为false取消上传,默认为false
}
});三、SDK成功接入验证方法
该方案仅提供验证是否集成成功的方法,由于在开发环境下可能会存在数据不完整的情况,请您正式发布小程序后在验证数据正确性。
按照上述描述方法引入SDK;
进入IDE打开调试工具中的console选项,若看到有
[umeng] -- SDK集成成功和[umeng] -- 数据发送成功提示 即表示SDK集成成功。
四、说明事项
慎重调用qq.clearStorage()以及qq.clearStorageSync()接口!SDK会将用户相关操作数据缓存在客户端数据存储模块,在特定时间启动发送策略。若调用该接口可导致数据统计不准确的问题;
若用户在使用小程序过程强制关闭QQ有可能会造成统计数据丢失的情况。
五、第三方框架支持
目前小程序SDK支持以下第三方框架,具体使用方法请参考demo:https://github.com/umeng/mp-demos
uniapp
taro
chameleon
mpvue
wepy2
目前只有2.2.0及以上版本的SDK才支持以上第三方框架
FAQ:
Q: 注册应用时,提示应用名称已存在
A:【友盟+】后台的应用名与实际应用名和包名无关,建议命名为应用名+平台
Q: 我忘记我的Appkey了,在哪里能查到
A:进入小程序统计-应用设置页面,可看到当前小程序的Appkey
https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html