快应用 SDK 集成文档

下载SDK

请联系客户经理获取SDK。

引入SDK

在您工程的src/app.ux中,引入SDK:

const $Adhoc = require('./sdk').default

/* @desc: 注入方法至全局 global,以便页面调用 */
const hook2global = global.__proto__ || global
hook2global.$Adhoc = $Adhoc

export default {
  onCreate() {
    // 方式一: 随意生成ClientID
    $Adhoc.init("Your Appkey")
    // 方式二: 可以从业务系统中获取用户唯一标识后, 使用业务唯一用户标志作为ClientID使用
    $Adhoc.init("Your Appkey", '自定义ClientID')
  }
}

其中“app_key” 是在登录 AppAdhoc 后台创建“应用”之后获得的该“应用”的授权标识。

可在AppAdhoc控制台应用列表找到,如下图红线部分:

app_key

其中”client_id” 是一个唯一的 ID,用来代表一个独立访客,建议使用业务系统中用户唯一ID

如果没有指定 client_id,SDK 将自动生成一个随机的 client_id,并使用快应用的storage进行持久化。

服务器域名

request合法域名:

上报指标的域名:

https://tracker.appadhoc.com

获取变量的域名:

https://experiment.appadhoc.com

编程模式:根据“试验变量”展示相应内容

在编程模式中“试验变量”的值决定了展示的内容或程序的逻辑。

注意:试验变量值应由PM或相关A/B Testing需求制定人员在后台提前录入完毕,如下图“版本管理”红线部分:

app_key

展示相应内容:

1.获取AppAdoc后台试验变量

通过在您的小程序中调用 adhoc.getExperimentFlags(callback) 来完成:


<script>

export default {
  // 页面级组件的数据模型,影响传入数据的覆盖机制:private内定义的属性不允许被覆盖
  private: {
    title: '欢迎体验快应用开发',
    isNewHomePage: true
  },

  onInit() {
    $Adhoc.getExperimentFlags((flags) => {
      const value = flags.get('isNewHomePage')
      if(typeof(value) !== 'undefined') {
        this.isNewHomePage = value 
      }
    })
  },
  onDetailBtnClick() {
    // 指标上报
    $Adhoc.increment('clickTimes',1)
  },
}
</script>

其中,isNewHomePage 即是 “试验变量“ ,应与上图中红线标识保持一致,上面的示例代码在获取是否是新的首页后,修改了数据。

请注意在用户访问到试验页面时,需要触发试验变量才算作进入该试验,否则将不会统计进入该试验。

在此示例中,“flags.get('isNewHomePage')”算作触发变量“isNewHomePage”。请勿在非试验页面或者公用文件中调用。

在此示例中,“false”代表不读取缓存,每次均主动触发请求;“true”代表仅读取缓存。

上报指标

指标用于量化试验结果的好坏,AppAdhoc 后台中的试验图表根据此数据生成。

注意:指标值应由PM或相关AB Test需求制定人员在后台提前录入完毕,如下图“优化指标”红线部分:

优化指标

比如在进入某一逻辑分支后,可以统计点击次数。将上图中的指标“clickTimes”传入函数increment实现上报指标, 每次累加1:

<script>
export default {
  onDetailBtnClick() {
    // 指标上报
    $Adhoc.increment('clickTimes',1)
  }
}
</script>

如果需要同时上传多个指标,可以使用以下方法(多个指标将统一上传成功或失败):

<script>
export default {
  onDetailBtnClick() {
    // 指标上报
    $Adhoc.increment(['stat1', 'stat2', {key: 'stat3', val: 10}], function(error){
      if(error){
          //error handler
      }else{
          //success handler
      }
    })
  }
}
</script>

高级功能 受众定向(需要联系管理员开启)

注意:自定义受众定向条件应由PM或相关AB Test需求制定人员在后台提前录入完毕。

AppAdhoc SDK 支持预定义受众定向和自定义受众定向两种方式。

预定义受众定向功能中,开发者只需要在AppAdhoc平台中选择预设的受众标签,SDK会自动采集相关信息并判定当前用户是否进入试验(例如浏览器名称、版本、语言等用户标签),无需在代码中定义。

开发者也可以根据需要选择自定义手中标签,此方式需要在AppAdhoc平台中填写好标签的key和value,之后再代码中为当前用户设置标签,进而实现将不符合条件的用户排除在此次试验之外。比如只想要女性用户,或30岁以下的用户参与试验等。最好在init前调用。
关于受众定向详细请参考受众定向

注意:自定义受众定向条件应由PM或相关AB Test需求制定人员在后台提前录入完毕。

在运行控制/右侧定向试验:

受众定向

选择分组,点击编辑用户群:

受众定向

即得到受众条件的key,在下图例子中,“sex”是key:

受众定向

前端代码中通过“custom”添加自定义标签名及标签值,这里需要动态获取标签值上传给后台,以便后台决定该用户是否满足受众定向条件(如有疑问请联系客户经理协助)。

var sex = functionGetSex();//自定义方法,请基于实际的业务场景,按照小程序开发规范书写
$Adhoc('init',{
    appKey:'your appKey'//平台获得的 appkey 必要
})
$Adhoc.setCustomTags({ 'sex': sex })//male:自定义标签,与平台保持一致

开始试验

恭喜,您完成了AppAdhoc A/B Testing 快应用SDK的埋点集成工作,请通知PM或相关AB Test需求制定人员,点下开始试验按钮吧!

注意:确保app_key, 试验变量字符串,指标字符串与后台截图处一一对应,否则可能出现异常或无试验数据情况。

results matching ""

    No results matching ""