REST API 集成文档

直接调用api获取当前用户对应的试验版本,并完成数据上报。

根据“试验变量”展示相应内容

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

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

app_key

POST请求示例:

POST  http://experiment.appadhoc.com/get_flags_async

Request Headers(请求头)
Content-Type: application/json
Body
{
"app_key": "your-app-key",
"client_id": "your-clientId-maybe-imei-or-something",
"summary": {},
"custom": {}
}

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

注意:试验“应用”此时应该提前创建完毕。可在AppAdhoc控制台应用列表找到,如下图红线部分:

your_app_key

clientID用于标识用户ID,需要开发者根据自己的用户系统传入。对于同一台设备或同一位用户,应当保持其每次访问时clientID不变。

该请求返回的json数据结构:

Response 200 Headers(响应头)
Content-Type: application/json
Body
{
  "experiments": [{
       "id": " the-experimentId-ABServer-give-to-a-cilent ",     
          "flags": [
           "flag1",
            "flag2"
      ]}],
      "flags": {
        "flag1": true,
        "flag2": "abc",
        "flag3": 1
      }
}

“flags”即“试验变量“,应与控制台中所填写的变量名称一致。获取到变量值后,开发者可以根据不同的变量值,写相应的逻辑。

上报指标

指标用于量化试验结果的好坏,AppAdhoc 后台中的试验图表根据此数据生成。在可视化试验和多链接合并试验中,您也可以通过此方法定义上报指标。

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

优化指标

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

POST  http://tracker.appadhoc.com/tracker   
Request Headers(请求头)
Content-Type: application/json
Body
{
  "app_key": "your-app-key",
  "client_id": "your-clientId-maybe-imei-or-something",
  "summary": {},
  "custom": {},
  "stats": [{
    "key": "clickTimes",
    "value": 1,
    "timestamp": 1514365098,
    "experiment_ids": ["the-experimentId-ABServer-give-to-a-cilent"]
  }]
}

其中client_id,experiment_ids需要与上一步获取试验变量时保持一致。clientID用于标识用户或设备的唯一身份,experiment_id由获取试验变量的请求返回,用于标识该用户进入了哪个试验版本。

"timestamp"表示事件发生时的时间戳,请务必正确填写,否则可能造成数据丢失。

请注意使用此方式进行试验时,您需要自行判断用户进入试验的时机并上报UV。

通常我们建议当确定用户被展示了不同试验版本时才认为用户进入试验。UV的指标名称设定为"Event-GET_EXPERIMENT_FLAGS",不需要在控制台中填写。

UV上报的json示例:

{
  "app_key": "your-app-key",
  "client_id": "your-clientId-maybe-imei-or-something",
  "summary": {},
  "custom": {},
  "stats": [{
    "key": "Event-GET_EXPERIMENT_FLAGS",
    "value": 1,
    "timestamp": 1514365098,
    "experiment_ids": ["the-experimentId-ABServer-give-to-a-cilent"]
  }]
}

开始试验

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

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

results matching ""

    No results matching ""