支付宝小程序 SDK (beta)

LF
Last updated last month

支付宝小程序SDK目前属于灰度内测功能,如有需求,请联系您的客户成功经理或商务对接人,申请进行灰度内测。

接入前准备

在项目中接入一个新的小程序应用

在你的 GrowingIO 项目页面点击右上角点击小齿轮,在弹出的列表中选择“应用管理“。在应用管理页面,点击“新建应用“来创建一个新应用。

然后会到达SDK集成页面,平台选择支付宝小程序,填写支付宝小程序的应用名称,和支付宝小程序的AppID ,点击“下一步”,即可以到达支付宝小程序SDK接入的页面。

目前仅支持小程序类应用集成在同一个项目下,暂不支持小程序产品和web\iOS\Android端产品集成在同一项目下。

如果需要集成其他端产品,或者需要在已有web/iOS/Andoird产品集成的情况下,集成小程序产品,请创建新的项目。

支付宝小程序SDK标准接入指南

选择”支付宝小程序“平台,填写”应用名称“ 和 "AppID",点击"下一步"。

1 下载小程序采集SDK

下载 gio-alip.js 文件

curl --compressed https://assets.growingio.com/gio-alip.js -o gio-alip.js

当下载到 gio-alip.js 文件以后,把文件放在支付宝小程序项目里,比如 utils 目录下。下面会假设 SDK 文件放在 utils 目录下。

2 添加跟踪代码

在支付宝小程序项目根目录的 app.js 文件的顶部添加以下 JS 代码,请注意一定要放在 App() 之前:

var gio = require("utils/gio-alip.js");
// version 是你的小程序的版本号
gio('init', '你的项目ID', '你的支付宝小程序AppID', { version: '1.0' });
修改项目中的App和Page,如下:
App({})改写为:
App($global.trackApp({
}))
所有的Page({})改写为:
$global.GioPage({
})

每次发布小程序新版本的时候,更新一下版本号 version,可以在 GrowingIO 分析不同版本的数据。除了 version 之外,还有以下额外参数可以使用。

参数

解释

forceLogin

true | false

是否要用用户登陆支付宝获取 userid作为访问用户ID标识采集,建议你的小程序在打开强制要求用户登陆支付宝获取 userid时,才进行开启。默认 false

debug

true | false

是否开启调试模式,可以在调试体验版时看到采集的数据,默认 false

version

string

你的小程序的版本号

followShare

true | false

详细跟踪分享数据,开启后可使用分享分析功能统计分享带来的用户量。默认 false

forceLogin 是一个需要特别注意的参数。GrowingIO 默认会在小程序里面设置用户标识符,存储在 Storage 里面。这个用户标识符潜在可能会被 clearStorage清除掉,所以有可能不同的用户标识符对应同一个支付宝用户的 userid。如果你的支付宝小程序在用户打开后会去做登陆并且获取 userid ,可以设置 forceLogin 为 true。当 forceLogin 为 true 的时候,用户标识符会使用 userid,潜在风险是如果用户没有授权,数据不会发送,所以请特别注意这个参数的设置,具体集成示例:

gio('init', '你的项目ID', '你的支付宝小程序AppID', { version: '1.0', forceLogin: true });
...
// 当获取到 userid 后,调用以下方法
gio("identify", userid);

3 添加请求服务器域名

要正常采集小程序的数据并发送给 GrowingIO,需要在支付宝小程序里事先设置一个通讯域名,允许跟 GrowingIO API 服务器进行网络通信。具体步骤如下:

  1. 登录支付宝小程序后台,进入配置

  2. 打开小程序详情/设置/开发设置

  3. 配置httpRequest接口请求域名白名单:https://wxapi.growingio.com

4 添加分享参数

转发分享小程序是小程序获客的重要场景,想要详细的进行转发分享的统计,需要在SDK参数中,设置如下参数,值为true

参数

解释

followShare

true | false

详细跟踪分享数据,开启后可使用分享分析功能统计分享带来的用户量。默认 false

即支付宝小程序项目根目录的 app.js 文件设置参数如下:

var gio = require("utils/gio-alip.js");
// version 是你的小程序的版本号,发版时请调整
gio('init', '你的项目ID', '你的支付宝小程序AppID', { version: '1.0', followShare: true });

5 SDK支付宝用户属性设置

作为用户行为数据分析工具,用户信息的完善会给后续的分析带来很大的帮助。在小程序中,支付宝用户属性是非常重要的设置,只有完善了支付宝用户属性信息,支付宝的访问用户变量(如下表)才可以在分析工具中使用,交互数据定义、数据校验功能才会方便通过用支付宝相关的信息(支付宝姓名和头像)定位用户。

下面是专门针对用户的三个接口:

绑定支付宝用户ID

当用户在你的小程序上登陆获取到 userid 后,可以用过 identify 接口绑定支付宝用户ID,后续在 GrowingIO 中获取更准确的支付宝访问用户量。示例代码如下:

my.httpRequest({
url: 'http://isv.com/auth', // 该url是自己的服务地址,实现的功能是服务端拿到authcode去开放平台进行token验证
data: {
authcode: res.authCode
},
success: (res) => {
gio('identify', res.uid)
}
});

设置支付宝用户信息

当用户在你的小程序上绑定支付宝信息后,可以通过 setVisitor 接口设置支付宝用户信息,后续在 GrowingIO 中分析这个数据。示例代码如下:

my.getAuthUserInfo({
success: (userInfo) => {
gio('setVisitor', userInfo);
}
});

支付宝信息包含用户昵称用户头像性别支付宝所填国家支付宝所填省份支付宝所填城市用户类型用户状态是否通过实名认证学生认证

*注:用户画像中的部分数据,只有在设置支付宝用户信息后,才可以统计。

设置注册用户ID

当用户在你的小程序上注册以后,你的产品应用服务端会在CRM 用户数据库里添加一条记录并且分配一个 ID,可以通过 setUserId 接口设置注册用户ID,后续在 GrowingIO 中分析登录用户这个数据。示例代码如下:

gio('setUserId', YOUR_USER_ID);

设置注册用户信息

当用户在你的小程序上传了注册用户ID后,可以通过 setUser 接口设置注册用户信息,例如用户会员等级,后续在 GrowingIO 中分析这个数据。示例代码如下,

gio('setUserId', user.id);
gio('setUser', {
id: user.id,
level: user.level
});

6 检测数据

当集成成功后,需要回到 GrowingIO SDK 集成页面,点击右下角“检测数据”。请在添加了跟踪代码的支付宝小程序重新启动几次,发送数据给 GrowingIO,完成安装最后一步。

7 进入数据校验模块,查看数据发送情况

检测成功后,可以使用数据验证功能,实时查看数据发送情况。