获取升级版 Smart+ 推广系列异步复制任务的结果
此接口可用于查看升级版 Smart+ 推广系列异步复制任务的结果。
建议在使用 /smart_plus/campaign/copy/task/create/ 接口创建任务后等待约 5 分钟,再查看任务结果。
注意
- 推广系列异步复制 API 目前为白名单功能。如需使用此功能,请联系你的 TikTok 销售代表。 - 全局频控限制适用于此接口。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/smart_plus/campaign/copy/task/check/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](1738373164380162.html)接口获取。 |
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。|
| task_id {必填} | string | 推广系列异步复制任务的 ID。<br><br>若想获取任务 ID,需使用 [/smart_plus/campaign/copy/task/create/](https://business-api.tiktok.com/portal/docs/create-an-asynchronous-copy-task-for-an-upgraded-smart-campaign/v1.3) 接口。|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/smart_plus/campaign/copy/task/check/?advertiser_id={{advertiser_id}}&task_id={{task_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|-|-|-|
|code |number|返回码。完整返回码列表及描述参见[附录 - 返回码](https://business-api.tiktok.com/portal/docs/return-codes-appendix/v1.3)。|
|message |string|返回信息。更多信息参见[附录 - 返回码](https://business-api.tiktok.com/portal/docs/return-codes-appendix/v1.3)。|
|request_id|string| 请求的日志 ID,唯一标识一个请求。|
|data|object|返回数据。|
#| task_status | string | 推广系列异步复制任务的状态。<br><br>枚举值:<ul><li>`RUNNING`:任务正在处理中。</li><li>`SUCCESS`:任务已处理完毕。查看 `task_result`,确认任务是否成功完成。</li><li>`FAILURE`:任务处理失败。</li></ul>|
#| task_info | object | 任务结果概览。|
##| total_ad_count | number | 尝试复制的广告总数。|
##| success_ad_count | number | 已成功复制的广告数量。|
#| task_result | object | 任务结果的详细信息。|
##| campaign_id | string | 新建推广系列的 ID。|
##| campaign_name | string | 新建推广系列的名称。<br><br>如果推广系列复制失败,仍会返回此字段,用以标明未成功复制的推广系列。|
##| campaign_error_infos | string[] | 推广系列复制过程中出现的错误。<br><br>如果未出现错误,此字段的值为空列表 (`[]`)。|
##| adgroup_result_list | object[] | 广告组复制结果的详细信息。|
###| adgroup_id | string | 新建广告组的 ID。|
###| adgroup_name | string | 新建广告组的名称。<br><br>如果广告组复制失败,仍会返回此字段,用以标明未成功复制的广告组。|
###| total_ad_count | number | 尝试复制到新建广告组的广告数量。|
###| success_ad_count | number | 已成功复制到新建广告组的广告数量。|
###| adgroup_error_list | string[] | 广告组复制过程中出现的错误。<br><br>如果未出现错误,此字段的值为空列表 (`[]`)。|
###| ad_status | string | 将广告从原广告组复制到新建广告组的结果。<br><br>枚举值:<ul><li>`ALL_SUCCESS`:已成功复制原广告组中的所有广告。</li><li>`PARTIAL_SUCCESS`:无法复制原广告组中的部分或所有广告。</li></ul>|
###| ad_result_list | object[] | 广告复制结果的详细信息。|
####| is_success | boolean | 是否成功复制原广告。<br><br>支持的值:`true`、`false`。|
####| smart_plus_ad_id | string | 新建广告的 ID。|
####| ad_name | string | 新建广告的名称。<br><br>如果广告复制失败,仍会返回此字段,用以标明未成功复制的广告。|
####| ad_error_list | string[] | 广告复制过程中出现的错误。<br><br>如果未出现错误,此字段的值为空列表 (`[]`)。|
示例
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"task_info": {
"success_ad_count": 1,
"total_ad_count": 1
},
"task_result": {
"adgroup_result_list": [
{
"ad_result_list": [
{
"ad_error_list": [],
"ad_name": "{{ad_name}}",
"is_success": true,
"smart_plus_ad_id": "{{smart_plus_ad_id}}"
}
],
"ad_status": "ALL_SUCCESS",
"adgroup_error_list": [],
"adgroup_id": "{{adgroup_id}}",
"adgroup_name": "{{adgroup_name}}",
"success_ad_count": 1,
"total_ad_count": 1
}
],
"campaign_error_infos": [],
"campaign_id": "{{campaign_id}}",
"campaign_name": "{{campaign_name}}"
},
"task_status": "SUCCESS"
}
}
(/code)