WARNING

💡 模块名:GameHelper.ABTest

描述

AB 系统是一个实验工具箱，例如当有一个功能或者多个功能需要加入但又不确定是正向还是负向时，就可以使用 AB 系统，来将这些功能按人数比例展示给这些用户，然后观察这些用户的数据结果选择最佳。

支持两个实验工具：

• 微信平台的实验工具
• SDK 内置的本地实验工具 实际使用时请根据需求选择其一并在初始化时传入对应的配置参数开启实验

AB 标识跟随版本，版本迭代更新时会存在以下情况：

1. 新版本若为新一轮 AB 实验时，上个版本的 AB 标识会重新分配

2. 若无实验配置，上版本的 AB 标识会被清除；

3. 若新版本设置新一轮的 AB 实验且设置了保留上版本的 AB 标识，则会无条件保留上版本的 AB 标识，检测上版本无 AB 标识时才会执行新版本的用户筛选逻辑。

用户群体名称解释和划分依据：

• 买量用户 -- 从买量场景进入游戏的用户为买量用户，会将该用户的买量属性保存到本地，后续重新进入都会被视作买量用户
• 新老用户 -- 相对某个版本而言，例如线上为 1.11 版本（那些首次进入游戏为 1.11 版本的是新用户，在 1.11 版本之前就进入过游戏的这些用户为 1.11 版本的老用户），现在更新 1.5 版本上线，那么之前的线上 1.11 版本新用户和老用户都被归类为老用户，仅首次进入为 1.5 版本的这部分用户为新用户

接入说明

在 SDK 初始化函数内传入配置参数即可开启 AB 实验

GameHelper.init({
    ticket: "fjkdsiiifwifi",
    ...
    abTestConfig: {
        // testName和testAmount仅需配置其中一个，分别表示使用微信实验工具或者本地实验工具
        // 若同时配置了，会优先读取testName并使用微信实验工具
        testName: "xxxx",  // 微信实验参数名称，使用微信实验工具时配置
        testAmount: 2,  // number类型，表示实验总数，使用本地实验工具时配置
        config: {   // 配置须知，若不配置任何字段，则默认所有用户均参与AB测试
            maiLiang:1,  // 1- AB测试群体为买量 2-测试群体为非买量
            new: 1, // 1- 新用户参与测试  2- 老用户参数测试
            reserve: true  // 若用户上版本分配到了AB，沿用上版本AB分配的结果
        }
    }
    ...
})

注意仅在有 AB 实验需求时配置 abTestConfig 参数，如果不做 AB 实验或者取消 AB 实验请去掉参数配置。

配置参数说明

参数名	类型	是否必填	说明
testName	string	二选一	微信实验参数
testAmount	number		分包数量，如分 AB 包，填 2；分 ABC 包，填 3，依此类推
config	object	选填	筛选条件，不配置表示不使用该筛选条件
config.maiLiang	number	选填	1- 筛选买量 2-筛选非买量 参与测试
config.new	number	选填	1-筛选新用户 2-筛选老用户 参与测试
config.reserve	boolean	选填	是否保留上版本 AB 测试包体标识；true-保留 false-不保留

开启微信实验工具

微信官方实验工具说明
使用微信实验工具，参数值为实验参数，由实验提出人或发布同事提供；无需设置 testAmount；config 参数中可根据需求配置 maiLiang 和 reserve 字段；

开启本地实验工具

使用本地实验工具，根据分包数量填写数字；使用本工具时可能会配合 maiLiang、new 参数使用，请仔细选择。

测试

注意开启 AB 实验后，需要升级版本号，AB 标识的分配有且仅在首次进入新版本时执行，后续再进入都只会沿用上次进入新版本时分配到的结果； 在调试包(debugMode=true)的情况下，可在控制台搜索关键字“[ABTest]”查看实验分配情况。

未开启实验

不满足实验条件，不参与实验

接口索引

属性

属性名	类型	描述
isBuyedUser	boolean	是否为买量用户
bucketTest	string	分配的 AB 标识，若为参与 AB 实验，返回空字符串
isJoinTest	boolean	是否参与 AB 实验