跳转到主要内容
PRODUCT DOCUMENTS

快速找到所需文档,高效完成接入与排障

浏览产品文档与友盟 Skill,展开目录并阅读正文。

支付宝模板小程序

本文包含友盟+支付宝模板小程序统计分析SDK的接入方法、集成测试、Demo、注意事项等内容。按以下步骤成功集成SDK后,即可查看友盟+为您支付宝模板小程序采集的数据。

业务场景

统计分析通过小程序模板创建的多个小程序明细及汇总数据

适用范围

  • 使用友盟+支付宝小程序统计SDK 2.3.2及以上版本;

  • 支付宝版本大于10.1.52版本

集成流程

1. 注册友盟+账号

登录友盟+官方网站(www.umeng.com),点击右上角“免费注册”按钮,按照提示注册友盟+账户。

注册友盟账号

特别提醒:建议使用企业邮箱,避免使用个人邮箱注册,防止由于个人离职带来的问题;建议使用的账号形式 :umeng@企业域名、apps@企业域名、dev@企业域名

2. 安装SDK

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

npm install umtrack-alipay --save

2.2 在IDE内安装

  1. 切换到NPM依赖管理

  2. 输入umtrack-alipay

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

3. 集成SDK

在小程序模板app.js文件内,添加如下代码:

import'umtrack-alipay';
App({
  umengConfig:{
    appKey:'YOUR_UMENG_APPKEY',//由友盟分配的APP_KEY,当通过模板新建小程序时,调用Open API申请APP_KEY,并通过脚本自动写入参数
    debug:true//是否打开调试模式
}
});

通过模板新建小程序时(参考下图),调用 Open API 自动申请Appkey(Open API说明文档),并通过脚本自动填写至appKey参数(黄豆网最佳实践参考:Appkey参数填写脚本.txt)。集成后,所有新建小程序,将呈现在服务商账户下。

API文档 https://developer.umeng.com/docs/147615/detail/162443

API测试工具

4. 添加友盟+数据服务白名单

登录支付宝小程序控制台,进入“设置 -> 开发服务 -> 开发设置”,添加 umini.shujupie.com 至域名白名单DC858F14-EA5E-4c85-BFA5-2EA2976F6B66.png

5. 添加友盟+数据服务功能

登录支付宝小程序控制台,进入“开发服务 -> 版本管理”,在“能力列表”点击 “添加功能”;搜索“友盟”,勾选 小程序-友盟+小程序统计 功能后,点击右下角 确定 完成添加功能。

友盟+数据服务功能

6. 可选:设置用户ID及用户信息上传

6.1 设置用户ID

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

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

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

my.uma.setUserid('custom_userid');

6.2 上传用户信息

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

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

    uploadUserInfo:true// 自动上传用户信息,设为false取消上传,默认为false
}
});

7. SDK成功接入验证方法

按照上述描述方法引入SDK,进入IDE打开调试工具中的Console:

  • 若提示“[umeng] — 集成SDK成功”,即表示SDK集成成功

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

接入成功后,通过模板创建的小程序将展现在账户名下(如下图),点击“查看”即可分析单个小程序数据。

SDK接入成功

注意

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

  • 若提示“api: getOpenUserData 暂不支持,请在真机调试”,请在手机上验证是否存在该提示,若不存在即可忽略此提示;请您将支付宝IED升级至更新至1.0版本或以上,否则会出现预览失败的情况。

Demo

目前小程序SDK支持以下第三方框架,具体使用方法请参考demo: https://github.com/umeng/mp-demos

说明

目前只有2.2.0及以上版本的SDK才支持以上第三方框架

特别注意

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

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

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

后续功能

1. 自定义事件,深入分析用户行为及转化漏斗

2. 授权管理,允许其他账户查看单个或多个小程序统计数据

如果您集成中遇到问题,或创建应用数超过300,欢迎钉钉搜索:31891587,加入VIP服务群,将有工作人员为您服务。