获取手动推广系列异步复制任务的结果
此接口可用于查看手动推广系列异步复制任务的结果。
建议在使用 /campaign/copy/task/create/ 接口创建任务后等待约 1 分钟,再查看任务结果。
若想查看升级版 Smart+ 推广系列异步复制任务的结果,需改用 /smart_plus/campaign/copy/task/check/ 接口。
注意
- 推广系列异步复制 API 目前为白名单功能。如需使用此功能,请联系你的 TikTok 销售代表。
- 此接口的频控限制为每个开发者应用每秒最多查询 2 次 (QPS) 和每分钟最多查询 60 次 (QPM)。全局频控限制不适用于此接口。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/campaign/copy/task/check/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|--- |--- |--- |
| advertiser_id {必填} | string | 广告主 ID。 |
| task_id {必填} | string | 推广系列异步复制任务的 ID。<br><br>若想获取任务 ID,需使用 [/campaign/copy/task/create/](1788434394151938.html) 接口。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/copy/task/check/' \
--header 'Access-Token: {{Access-Token}}' \
--data '{
"advertiser_id": "{{advertiser_id}}",
"task_id": "{{task_id}}"
}'
(/code)
返回
|字段{35%}|类型{15%}|描述{50%}|
|-|-|-|
|code |number|返回码。完整返回码列表及描述参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message|string|返回信息。更多信息参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|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 | 已成功复制的广告数量。 |
##| total_smart_creative_adgroup_count | number | 尝试复制的智能创意广告组总数。 |
##| success_smart_creative_adgroup_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> |
###| is_smart_creative | boolean | 新建广告组是否为智能创意广告组。<br><br>枚举值:`true`、`false`。 |
###| smart_creative_result | object | 仅当 `is_smart_creative` 为 `true` 时返回。<br><br>复制原智能创意广告组中的广告创意的结果详细信息。 |
####| is_success | boolean | 是否成功复制原智能创意广告组中用于生成智能创意广告的广告创意。<br><br>枚举值:`true`、`false`。 |
####| smart_creative_error_list | string[] | 复制原智能创意广告组中的广告创意时出现的错误。<br><br>如果未出现错误,此字段的值将为空列表 (`[]`)。 |
###| ad_result_list | object[] | 广告复制结果的详细信息。 |
####| is_success | boolean | 是否成功复制原广告。<br><br>枚举值:`true`、`false`。 |
####| ad_id | string | 新建广告的 ID。 |
####| ad_name | string | 新建广告的名称。<br><br>如果广告复制失败,仍会返回此字段,用以标明未成功复制的广告。 |
####| ad_error_list | string[] | 广告复制过程中出现的错误。<br><br>如果未出现错误,此字段的值将为空列表 (`[]`)。 |
示例
复制任务的结果可能有所不同,具体取决于原广告组的类型以及任务的结果。以下代码示例展示了不同的使用场景:
成功执行非 ACO、非智能创意广告组的复制任务
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"task_result": {
"campaign_name": "{{campaign_name}}",
"adgroup_result_list": [
{
"total_ad_count": 1,
"adgroup_id": "{{adgroup_id}}",
"adgroup_name": "{{adgroup_name}}",
"adgroup_error_list": [],
"success_ad_count": 1,
"ad_result_list": [
{
"ad_name": "{{ad_name}}",
"is_success": true,
"ad_error_list": [],
"ad_id": "{{ad_id}}"
}
],
"is_smart_creative": false,
"ad_status": "ALL_SUCCESS"
}
],
"campaign_id": "{{campaign_id}}",
"campaign_error_infos": []
},
"task_status": "SUCCESS",
"task_info": {
"total_ad_count": 1,
"total_smart_creative_adgroup_count": 0,
"success_smart_creative_adgroup_count": 0,
"success_ad_count": 1
}
}
}
(/code)
成功执行智能创意广告组的复制任务
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"task_info": {
"success_ad_count": 0,
"success_smart_creative_adgroup_count": 1,
"total_ad_count": 0,
"total_smart_creative_adgroup_count": 1
},
"task_result": {
"campaign_id": "{{campaign_id}}",
"campaign_name": "{{campaign_name}}",
"campaign_error_infos": [],
"adgroup_result_list": [
{
"is_smart_creative": true,
"adgroup_name": "{{adgroup_name}}",
"adgroup_id": "{{adgroup_id}}",
"smart_creative_result": {
"smart_creative_error_list": [],
"is_success": true
},
"ad_status": "ALL_SUCCESS",
"adgroup_error_list": [],
"ad_result_list": [],
"success_ad_count": 0,
"total_ad_count": 0
}
]
},
"task_status": "SUCCESS"
}
}
(/code)
成功执行非 ACO、非智能创意广告组的部分复制任务
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"task_info": {
"success_ad_count": 1,
"success_smart_creative_adgroup_count": 0,
"total_ad_count": 2,
"total_smart_creative_adgroup_count": 0
},
"task_result": {
"campaign_id": "{{campaign_id}}",
"campaign_name": "{{campaign_name}}",
"campaign_error_infos": [],
"adgroup_result_list": [
{
"is_smart_creative": false,
"adgroup_name": "{{adgroup_name}}",
"adgroup_id": "{{adgroup_id}}",
"ad_status": "ALL_SUCCESS",
"adgroup_error_list": [],
"ad_result_list": [
{
"ad_error_list": [],
"ad_id": "{{ad_id}}",
"ad_name": "{{ad_name}}",
"is_success": true
}
],
"success_ad_count": 1,
"total_ad_count": 1
},
{
"is_smart_creative": false,
"adgroup_name": "{{adgroup_name}}",
"adgroup_id": "0",
"ad_status": "PARTIAL_SUCCESS",
"adgroup_error_list": [],
"ad_result_list": [
{
"ad_error_list": [
"Unable to access image. Make sure your account has access and it's in a supported format (JPG, JPEG, PNG, GIF)."
],
"ad_id": null,
"ad_name": "{{ad_name}}",
"is_success": false
}
],
"success_ad_count": 0,
"total_ad_count": 1
}
]
},
"task_status": "SUCCESS"
}
}
(/code)
未成功执行非 ACO、非智能创意广告组的复制任务
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"task_info": {
"success_ad_count": 0,
"success_smart_creative_adgroup_count": 0,
"total_ad_count": 1,
"total_smart_creative_adgroup_count": 0
},
"task_result": {
"campaign_id": null,
"campaign_name": "{{campaign_name}}",
"campaign_error_infos": [],
"adgroup_result_list": [
{
"is_smart_creative": false,
"adgroup_name": "{{adgroup_name}}",
"adgroup_id": "0",
"ad_status": "PARTIAL_SUCCESS",
"adgroup_error_list": [],
"ad_result_list": [
{
"ad_error_list": [
"Unable to find \"Identity_ID\". Try again.",
"Update failed due to system error. Please try again."
],
"ad_id": null,
"ad_name": "{{ad_name}}",
"is_success": false
}
],
"success_ad_count": 0,
"total_ad_count": 1
}
]
},
"task_status": "SUCCESS"
}
}
(/code)