支付宝小程序：小程序模板快速集成

本文档适用于 模板开发模式 接入的服务商（ISV）在自身小程序内快速集成友盟+ SDK，获取数据服务能力。

本文档适用于友盟+支付宝小程序统计 SDK 2.3.2 及以上版本，并且支付宝版本需大于 10.1.52 版本。

特别提醒：我们建议开发者在注册账号时使用企业邮箱，避免使用个人邮箱注册，防止由于个人离职带来的问题，建议使用的账号形式 ：umeng@企业域名、apps@企业域名、dev@企业域名

安装SDK有两种方式，一种是在 IDE 内安装，另一种是在命令行内使用 npm 安装。

1. 切换到 NPM 依赖管理；

2. 输入 umtrack-alipay；

3. 从搜索结果列表中选中 umtrack-alipay, 并检查版本是否正确。

npm install umtrack-alipay --save

在 app.js 文件内，添加如下代码，即可进行基础指标的统计：

import 'umtrack-alipay';App({  umengConfig: {    appKey: 'YOUR_UMENG_APPKEY', //由友盟分配的APP_KEY    debug: true //是否打开调试模式  }});

登录支付宝小程序后台，进入小程序的 设置->开发设置->服务器域名白名单，把 umini.shujupie.com 添加至白名单，如图：

1. 请务必在支付宝平台勾选 友盟+数据服务 功能包，否则将导致无法统计数据；

2. 添加流程：进入小程序后台开发管理菜单，能力列表 部分可以点击 添加功能 来给创建的小程序添加功能，如下图所示；开发者勾选 小程序-友盟+小程序统计 功能后，点击右下角 确定 即完成添加功能。

服务商在获取小程序 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()); }

特别说明：

1. OpenAPI 具体说明请参考：

? ? ?https://developer.umeng.com/open-api/docs/com.umeng.umini/umeng.umini.createMiniApp/1

1. 行业分类请参考：https://developer.umeng.com/docs/147615/detail/169442

2. 若创建应用数超过300，请联系在线客服。

trackEvent(eventId, params)

参数：

• id(string): 事件 ID 需在官网申请，长度在128个字符内

• params(object|string):

  • object 不能为数组

  • 当 params 为 object 类型时，每个 key 长度不能超过256个字符

  • 当 params 为 object 类型时，其携带 key 的个数不能超过100个

  • 存在规则不合法情况时，丢弃整条事件

返回值：

* 无

my.uma.trackEvent('事件ID');

my.uma.trackEvent('事件ID', { '属性1':'属性值1','属性2':'属性值2' });// 字符型属性值my.uma.trackEvent('ViewProductDetails', { 'Category':'家电','ItemName':'西门子冰箱' });// 数值型属性值my.uma.trackEvent('Pay', { 'PayAmount':6999 });

埋点注意事项：

1. params 为 object 类型时，属性值仅支持字符串和数值两种类型;

2. 请在 App.onLaunch 之后调用事件。

1. 进入U-MiniProgram后台“自定义事件”页面，点击“事件管理”；

2. 点击“添加事件”，输入小程序埋点的事件ID和名称；

3. 返回小程序自定义事件页面查看该事件数据。

当用户在您的小程序上注册以后，您的应用服务端会在用户数据库里添加一条记录并且分配一个用户ID，可以通过setUserid接口设置该用户ID，以便后续做数据打通或基于应用用户ID做计算时使用。

代码:

setUserid(userId, provider)

参数：

• userId(string): 您的应用为用户生成的唯一 ID。

• provider(string): ID提供方，兼容老接口使用，无特殊需要应忽略该参数返回值：无示例：

my.uma.setUserid('custom_userid');

开发者可通过在配置中添加 uploadUserInfo: true 选项来使友盟自动上报用户信息。将 uploadUserInfo 设置为 false 取消上报用户信息。上传的用户信息为小程序平台公开可获取的用户基础信息，例如昵称、头像、性别、地区、语言等，这些信息将用于 U-MiniProgram 产品中与用户相关的功能统计中。示例：

代码:

import 'umtrack-alipay';App({  umengConfig: {    appKey: 'YOUR_UMENG_APPKEY', //由友盟分配的APP_KEY    debug: true, //是否打开调试模式    uploadUserInfo: true // 自动上传用户信息，设为false取消上传，默认为false  }});

该方案仅提供验证是否集成成功的方法，由于在开发环境下可能会存在数据不完整的情况，请您正式发布小程序后在验证数据正确性。

1. 按照上述描述方法引入 SDK；

2. 进入IDE打开调试工具中的 console。

若提示“[umeng] — 集成SDK成功”提示，即表示 SDK 集成成功。

若提示“[umeng] ，请确保已经勾选"友盟+数据服务功能！”，请您务必确认已在支付宝开发者中心已经勾选添加“友盟+数据服务”;

注意：

若提示“api: getOpenUserData 暂不支持，请在真机调试”，请在手机上验证是否存在该提示，若不存在即可忽略此提示；

请您将支付宝 IED 升级至更新至 1.0 版本或以上，否则会出现预览失败的情况。

说明事项：

1. SDK 统计仅仅会在支付宝版本大于等于 10.1.52 才能生效，低版本将获取不到统计信息；

2. 慎重调用my.clearStorage()以及my.clearStorageSync(接口！SDK会将用户相关操作数据缓存在客户端数据存储模块，在特定时间启动发送策略。若调用该接口可导致数据统计不准确的问题；

3. 若用户在使用小程序过程强制关闭支付宝有可能会造成统计数据丢失的情况。