A/B Testing SDK 在使用前请确保已经成功集成依赖于神策分析支付宝小程序 SDK,并进行了 SDK 初始化,详情可参考,详情可参考 SDK 集成 。
- sa-sdk-mini 项目支付宝小程序 SDK v0.9.0 及以上版本。
- sa-sdk-alipaymini 项目(不再维护)支付宝小程序 SDK v1.1.9 及以上版本。
集成和初始化SDK
首先您需要集成神策分析支付宝小程序 SDK。在 A/B Testing 插件初始化时需要传入请求分流试验的地址。(创建具体的试验后,可下载 SDK 说明文档/复制具体代码示例)
同步引入方式:
import sensors from './utils/sensorsdata.min.js';
import abtest from './utils/abtest.min.js';
// 支付宝小程序 SDK 初始化参数配置
sensors.setPara({
server_url: '数据接收地址',
})
// 完成小程序 SDK 的初始化
sensors.init();
// A/B Testing 插件集成
sensors.usePlugin(abtest, {
url: "分流试验请求地址"
})
App({
onLaunch() {
}
})
数据接收地址( server_url )与分流试验请求地址( url )域名,开发者进入支付宝 开放平台控制台 > 对应应用概览页 > 开发设置 > 开发信息 > 服务器IP白名单,点击 设置/查看,进入 IP 白名单管理页面。
获取试验变量
初始化 SDK 之后,通过 API 获取具体试验的变量值,根据获取试验变量值的方式,可分为下面三种策略:
- fetchCacheABTest :读取本地缓存,缓存不存在时使用默认值
- asyncFetchABTest :忽略本地缓存,从服务端获取数据
- fastFetchABTest :优先读取本地缓存,缓存不存在时从服务端获取数据
如何确定应该选择哪个API获取试验变量值?
1.一般情况下,我们推荐使用fastFetchABTest获取试验变量值。
2.如果您对性能有要求,可以使用fetchCacheABTest, 只从本地缓存中获取变量值,但可能导致用户无法及时命中最新的试验。
3.如果您进行时间片轮转试验,且对时效性有要求,可以使用asyncFetchABTest 获取试验变量值,但会存在一定的网络延迟。
1. 请确保对A/B分流返回的 result 结果 & 接口中使用的默认值,都做了正常的业务逻辑处理!
2. 请确保默认值 default_value 和当前试验值类型相同。比如参数对应试验值为 Int 类型,则传入的 default_value 也必须是 Int 类型,同时返回的试验结果 result 也是 Int 类型
以 fastFetchABTest 为例,可在相应的业务逻辑中添加如下代码:
// abtest 为初始化 A/B Testing 插件时指定的全局变量
// Number 类型试验(第二个参数 0,表示未命中试验时,会返回此默认值,请根据业务需要更改此处的值)
abtest.fastFetchABTest({
param_name:"具体的试验参数",
default_value: 0,
value_type: "Number",
callback: function(result){
// TODO 请根据 result 进行自己的试验
}
});
获取设备主体试验变量
SDK支持使用设备主体进行分流。需要您在初始化SDK时,将匿名ID设置为公共属性。初始化并设置公共属性的具体方式如下:
import sensors from './utils/sensorsdata.min.js';
import abtest from './utils/abtest.min.js';
// 支付宝小程序 SDK 初始化参数配置
sensors.setPara({
server_url: '数据接收地址',
})
//设备主体分流需要将匿名ID设置为公共属性
sensors.registerApp({
anonymous_id: sensors.getAnonymousID()
});
// A/B Testing 插件集成
sensors.usePlugin(abtest, {
url: "分流试验请求地址"
})
// 完成小程序 SDK 的初始化
sensors.init();
App({
onLaunch() {
}
})
后续可以使用
- fetchCacheABTest :读取本地缓存,缓存不存在时使用默认值
- asyncFetchABTest :忽略本地缓存,从服务端获取数据
- fastFetchABTest :优先读取本地缓存,缓存不存在时从服务端获取数据
三种方式同获取试验变量
使用示例
使用示例
/// 神策埋点 SDK 初始化
// import 从 GitHub 中下载的最新的 sensorsdata.es6.min.js,及 abtest.esm.min.js 文件
import sensors from './utils/sensorsdata.min.js';
import abtest from './utils/abtest.min.js';
sensors.setPara({
server_url: '数据接收地址',
})
// A/B Testing 插件集成
sensors.usePlugin(abtest, {
url: "请求分流试验的地址"
})
// 完成小程序 SDK 的初始化
sensors.init();
App({
onLaunch(){
},
onShow(){
// 获取试验结果,abtest 对象在页面中使用时需要像 app.js 页面中一样先引入此对象
abtest.fastFetchABTest({
param_name: "具体的试验参数",
default_value: 0,
value_type: "Number",
callback: function(result){
// 获取用户命中的试验结果,针对用户可能命中的试验进行处理
switch(result){
case 0:
break;
case 1:
// 试验组 1 的处理逻辑
break;
case 2:
// 试验组 2 的处理逻辑
break;
// ……
// ……
default:
// 其他情况的处理逻辑
break;
}
}
});
}
});
调试试验
可以通过录入白名单的方式,把小程序用户加入白名单;加入白名单后,会强制命中当前试验指定的分组(白名单只在试验调试状态有效)。
集成神策分析支付宝小程序 SDK 后,在开发者工具控制台中查看任意一条数据,可以获取当前用户的 distinct_id。在开发版及体验版中,通过手机打开控制台也可以通过类似方式获取到 distinct_id。
将此 distinct_id (设备ID)添加到调试设备中。