获取对比测试结果
您可以使用本接口在对比测试结束至少 24 小时后,获取测试结果,包括每个指标对应的 p 值。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/split_test/result/get/
方法 POST
header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token{必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|advertiser_id {必填} | string | 广告主ID。 |
|split_test_group_id {必填} | string | 拆分对比测试组ID。 |
示例
(code curl http)
curl --location 'https://business-api.tiktok.com/open_api/v1.3/split_test/result/get/?advertiser_id={{advertiser_id}}&split_test_group_id={{split_test_group_id}}' \
--header 'Content-Type: application/json' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number | 返回码。完整返回码列表及描述,可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string | 返回信息。更多信息可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|data |object| 返回数据。 |
#| split_test_status | string | 拆分对比测试的状态。<br><br>枚举值:<ul><li> `UNKNOWN`:状态未知。 </li><li> `NOT_STARTED`: 测试未开始,因为未到测试的开始时间(`start_time`)。 </li><li> `IN_PROGRESS`: 测试进行中。</li><li> `REPORTING_GENERATING`: 报告生成中。测试的结束时间(`end_time` )已过,但报告还未生成完毕。</li><li> `COMPLETED`: 测试成功完成,或因人为使用[/split_test/end/](https://ads.tiktok.com/marketing_api/docs?id=1742666522399746)接口,测试已暂停。</li><li>`CANCELLED`: 测试在开始时间(`start_time`)之前被取消。该枚举值仅支持<b>推广系列层级</b>拆分对比测试。</li></ul> |
#| split_test_level | string |拆分对比测试层级。<br><br>枚举值:<ul><li>`ADGROUP`:广告组层级拆分对比测试。</li><li>`CAMPAIGN`:推广系列层级拆分对比测试。</li></ul>|
#| object_info | object[] | 与该拆分对比测试绑定的两个广告组的有关信息。 |
##| adgroup_id | string | 广告组 ID。 |
##| adgroup_name | string | 广告组名称。 |
##| optimization_goal | string | 广告组的优化目标。<br>枚举值参见 [枚举值 - 优化目标](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138#item-link-优化目标)。 |
#| cells | object[] | 拆分对比测试单元列表。|
##| object_ids | string[] |与该拆分对比测试绑定的单元内的`campaign_id` 或`adgroup_id`列表。|
#| test_variable | string | 拆分对比测试变量。<br><br>枚举值:<ul><li> `BIDDING_OPTIMIZATION` : 为出价和优化字段设置不同的优化值,对比不同优化方法对广告表现的影响。</li><li>`TARGTING` : 在广告组层级设置不同的定向值,比较广告组对触达不同受众群体或人群的效果。</li><li>`CREATIVE` : 设置不同的创意素材,比较创意素材对广告表现的影响。</li><li>`CUSTOM`: 设置多个变量,比较这些变量对广告表现的影响。该枚举值仅支持<b>推广系列层级</b>拆分对比测试。</li></ul> |
#| key_metric | string | 创建对比测试时指定的关键指标。<br>若未赋值, 则将使用下列默认值:<ul><li><b>广告组层级</b>拆分对比测试中,若两个广告组的优化目标均为`REACH` ,则默认关键指标为`COST_PER_REACH`。其他情况下,默认关键指标为 `COST_PER_SHOW`。</li><li><b>推广系列层级</b>拆分对比测试的默认关键指标为`UNSET`。</li></ul> |
#| start_time | string | 拆分对比测试的起始时间,格式为:`YYYY-MM-DD HH:MM:SS`(广告账户时区)。<br>示例:`2022-01-01 00:00:00`。 |
#| end_time | string | 拆分对比测试的结束时间,格式为:`YYYY-MM-DD HH:MM:SS`(广告账户时区)。 <br> 示例: `2022-01-01 00:00:00`。 |
#| p_value_info | object[] | 对比测试结果信息。 |
##| metric | string | 指标名称。<br><br>枚举值: <ul><li>`UNSET`:未设置。</li><li>`CONVERT_RATE`:CVR(转化率)。</li><li> `CLICK_THROUGH_RATE`:点击率(CTR)。</li><li> `COST_PER_SHOW`:千次展示成本(CPM)。</li><li> `COST_PER_CONVERT`:每次转化成本。</li><li> `COST_PER_REACH`:覆盖单人成本。 </li><li> `COST_PER_CLICK`:每次点击成本。</li><li>`COST_PER_FOCUSED_VIEW`:每次专注观看成本。</li><li>`FOCUSED_VIEW_RATE`:专注观看率。</li><li>`COMPLETE_PAYMENT_ROAS`:支付完成 ROAS。</li><li>`COST_PER_LANDING_PAGE_VIEW`:落地页浏览平均成本。</li><li>`LANDING_PAGE_VIEW_RATE`:落地页浏览率。</li><li>`CLICK`:点击量。</li><li>`REACH`:覆盖人数。 </li><li> `SHOW`:展示量。</li><li> `CONVERT`:转化量。</li><li> `COST`:成本。</li></ul> |
##| p_value | float | 指标的 p 值。若 p 值<= 0.1,则视作存在胜出广告组或推广系列。 |
|request_id|string|请求的日志 ID,唯一标识一个请求。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"key_metric": "FOCUSED_VIEW_RATE",
"object_info": [
{
"optimization_goal": "FOCUSED_VIEW_RATE",
"adgroup_name": "{{adgroup_name}}",
"adgroup_id": "{{adgroup_id}}"
},
{
"optimization_goal": "ENGAGED_VIEW_FIFTEEN",
"adgroup_name": "{{adgroup_name}}",
"adgroup_id": "{{adgroup_id}}"
}
],
"start_time": "{{start_time}}",
"test_variable": "BIDDING_OPTIMIZATION",
"p_value_info": [],
"end_time": "{{end_time}}",
"split_test_status": "NOT_STARTED"
}
}
(/code)