支付宝小程序
本文包含友盟+支付宝小程序统计分析SDK的接入方法、集成测试及相关FAQ等内容。按以下步骤成功集成SDK后,即可查看友盟+为您支付宝小程序提供的数据采集服务。
适用范围
该文档适用于友盟+支付宝小程序统计SDK 2.8.0 及以上版本
一、支付宝小程序统计SDK快速集成

1. 注册友盟+账号
登录友盟+官网,按照引导注册友盟+账号
特别提醒:我们建议开发者在注册账号时使用企业邮箱,避免使用个人邮箱注册,防止由于个人离职带来的问题,建议使用的账号形式 :umeng@企业域名、apps@企业域名、dev@企业域名
2. Appkey申请
进入小程序统计后台创建Appkey,按要求填写小程序名称及类型:
3. 创建支付宝小程序并接入SDK
3.1 安装SDK
安装SDK有两种方式,一种是在IDE内安装,另一种是在命令行内使用npm安装。
3.1.1 在IDE内安装
切换到NPM依赖管理
输入umtrack-alipay
从搜索结果列表中选中umtrack-alipay, 并检查版本是否正确

3.1.2 在命令行内使用npm安装
npm install umtrack-alipay --save3.2 集成
在app.js文件内,添加如下代码,即可进行基础指标的统计:
import 'umtrack-alipay';
App({
umengConfig:{
appKey:'YOUR_UMENG_APPKEY',//由友盟分配的APP_KEY
debug:true,//是否打开调试模式
}
});注意:切记一定要正确设置umengConfig,不要拼写错误
3.3 支付宝小程序增加友盟+数据服务域名白名单
操作步骤:登录支付宝小程序后台,进入小程序的 设置->开发设置->服务器域名白名单,把 ulogs.umeng.com,umini.shujupie.com添加至白名单,如图:

3.4 SDK配置项总结及注意事项
参数配置项 | 类型/值 | 首次使用默认值 | 注意事项 | 参数功能 |
uploadUserInfo | true /false | false | 开启为true时,请确认在启动时获取用户信息,否则支付宝会进行获取失败的报错,影响质量分。 | 获取用户的信息和头像,可以在「分享分析」功能中根据头像查看用户的分享排行 |
debug | true / false | true | 暂无 | 是否打开调试模式;建议打开,可以帮助在小程序端进行数据上报的debug |
enableVerify | true / false | false | 剪切板功能是用于埋点验证获取测试设备信息的;当开启为true时,用户侧可能会被提示获取剪切板信息;请确认线上发布版本设置为false;在进行发版前埋点验证工作时,可以参数设置为true | 剪切板是用于埋点验证获取测试设备信息,以便进行埋点验证的测试工作。 |
3.6 demo
具体集成方式可参考demo:https://github.com/umeng/mp-demos
二、高级功能
1. 自定义事件:
参考: 小程序自定义事件文档
2. 设置应用用户ID
当用户在您的小程序上注册以后,您的应用服务端会在用户数据库里添加一条记录并且分配一个用户ID,可以通过 setUserid 接口设置该用户ID,以便后续做数据打通或基于应用用户ID做计算时使用。
setUserid(userId, provider)参数:
userId(string): 您的应用为用户生成的唯一ID
provider(string): ID提供方,兼容老接口使用,无特殊需要应忽略该参数
返回值:无示例:
my.uma.setUserid('custom_userid');3. 上传用户信息
开发者可通过在配置中添加 uploadUserInfo: true 选项来使友盟自动上报用户信息。将 uploadUserInfo 设置为 false 则取消上报用户信息。上传的用户信息为小程序平台公开可获取的用户基础信息,例如昵称、头像、性别、地区、语言等,这些信息将用于U-MiniProgram产品中与用户相关的功能统计中。示例:
import'umtrack-alipay';
App({
umengConfig:{
appKey:'YOUR_UMENG_APPKEY',//由友盟分配的APP_KEY
debug:true,//是否打开调试模式
uploadUserInfo:true// 自动上传用户信息,设为false取消上传
}
});4. 超级属性
使用「行业」功能时,请使用超级属性来上报分组结构中最低层级的属性值。具体功能使用请查看功能使用文档。https://developer.umeng.com/docs/147615/detail/180890注1: 超级属性设置上报时机:1.在打开获取到属性值时,上报;在发生属性值变化时,也进行上报;(例如由a->b; 由 null -> a)一旦被设置,后续的所有自定义事件,页面浏览等都带有该属性。注2: 超级属性的生命周期:用户调用 setSuperProperty 至 session_end注3: 如需删除时,可在调用 setSuperProperty 方法时传入 null, undefined 等空值,或不传参数。
my.uma.setSuperProperty(property);参数:
property(string): 超级属性
返回值:无示例:
my.uma.setSuperProperty('123456');三、SDK成功接入验证方法
该方案仅提供验证是否集成成功的方法,由于在开发环境下可能会存在数据不完整的情况,请您正式发布小程序后在验证数据正确性。
按照上述描述方法引入SDK;
进入IDE打开调试工具中的console选项,若看到有
[UMENG] -- 集成SDK成功和[UMENG] -- 数据发送成功提示 即表示SDK集成成功。
注意:
提示 “api: getOpenUserData 暂不支持,请在真机调试”,请在手机上验证是否存在该提示,若不存在即可忽略此提示;
四、说明事项
SDK统计仅仅会在支付宝版本大于等于 10.1.52 才能生效,低版本将获取不到统计信息;
慎重调用my.clearStorage()以及my.clearStorageSync()接口!SDK会将用户相关操作数据缓存在客户端数据存储模块,在特定时间启动发送策略。若调用该接口可导致数据统计不准确的问题;
若用户在使用小程序过程强制关闭支付宝有可能会造成统计数据丢失的情况。
五、第三方框架支持
目前小程序SDK支持以下第三方框架,具体使用方法请参考demo:https://github.com/umeng/mp-demos
uniapp
taro
chameleon
mpvue
wepy2
微信小程序
目前只有2.2.0及以上版本的SDK才支持以上第三方框架
FAQ:
Q: 注册应用时,提示应用名称已存在
A:【友盟+】后台的应用名与实际应用名和包名无关,建议命名为应用名+平台
Q: 我忘记我的Appkey了,在哪里能查到
A:进入小程序统计-应用设置页面,可看到当前小程序的Appkey