获取广告组诊断
您可以使用本接口获取对于活跃广告组的诊断,包括存在的问题以及改进或提升的建议。
无对应建议的广告组将不会返回。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{25%}|v1.2{35%}|v1.3{40%}|
|---|---|---|
|接口路径| /v1.2/tools/diagnosis/get/|/v1.3/tool/diagnosis/get/|
|请求参数类型|advertiser_id: number<br>adgroup_ids: number[]|advertiser_id: string<br>adgroup_ids: string[]|
|请求参数名称|filters|filtering|
| 废弃请求参数 | / | <ul><li>fields</li><li>diagnosis_status</li><li>page</li><li>page_size</li></ul> |
| 新增请求参数 | / |issue_category|
|返回参数名称|list|results|
|返回参数类型|adgroup_id: number<br>pixel_id: number<br>adgroup_id(位于related_ad_groups下): number|adgroup_id(位于results下): string<br>pixel_id: string<br>adgroup_id(位于related_ad_groups下): string|
| 废弃返回参数 | / | <ul><li>diagnosis_status</li><li>learning_status</li><li>targeting(包括本对象数组中的所有字段)</li><li>website_url(位于creative下) </li><li>loading_time(位于creative下)</li><li>related_ad_groups(包括本对象数组中的所有字段,位于event_track下)</li><li>page_info</li></ul> |
| 新增返回参数 | / |<ul><li>creative下:<ul><li>suggestion_time</li><li>ad_id</li></ul></li><li>bid_and_budget下:<ul><li>suggestion_time</li><li>ad_id</li><li>bid_edr_info(包括本对象数组中的所有字段)</li><li>budget_edr_info(包括本对象数组中的所有字段) </li></ul></li><li>event_track下: <ul><li>suggestion_time</li></ul></li></ul> |
| 废弃枚举值 | / | <ul><li>creative下返回参数issue_suggestion的枚举值LANDING_PAGE</li><li>bid_and_budget下返回参数issue_suggestion的枚举值TRAFFIC_EXPLORE</li></ul> |
| 新增枚举值 | / |bid_and_budget下返回参数issue_suggestion的枚举值BID_EDR和BUDGET_EDR`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/tool/diagnosis/get/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID。 |
|filtering|object| 筛选条件。|
#|adgroup_ids|string[]|您想要获取诊断的广告组 ID 列表。<br>最大数量:20。|
#| issue_category | string[] | 问题类别。<br><br>允许值:<ul><li> `CREATIVE`:创意相关问题。</li><li>`BID_AND_BUDGET`:出价和预算相关问题。</li><li>`EVENT_TRACK`:事件追踪相关问题。</li></ul><br><ul><li>若传入多个值,将返回属于指定的问题类别的诊断。</li><li>若未传入本字段,将返回存在的所有问题类别的诊断。</li></ul> |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/tool/diagnosis/get/?advertiser_id={{advertiser_id}}&filtering={"adgroup_ids":["{{adgroup_ids}}"], "issue_category": ["CREATIVE", "BID_AND_BUDGET", "EVENT_TRACK"]}' \
--header 'Access-Token: {{Access-Token}}' \
(/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|返回数据。|
#|results|object[]|广告组列表及诊断信息。|
##|adgroup_id|string| 广告组 ID。|
##|adgroup_name|string|广告组名称。|
##|diagnosis|object| 该广告组的诊断信息。|
###|diagnosis_time|string|请求诊断数据的日期及时间(UTC+0 时间),格式为"YYYY-MM-DD HH:MM:SS"。<br>示例:"2024-01-01 00:00:01"。|
###|suggestions|object[]|对于本广告组的建议。|
####|creative|object[]| 针对创意的建议。<br>若未诊断出广告组中素材的问题,本字段的值将为空列表(`[]`)。|
#####|suggestion_time|string|诊断出问题并生成建议的日期及时间(UTC+0 时间),格式为"YYYY-MM-DD HH:MM:SS"。<br>示例:"2024-01-01 00:00:01"。|
#####|suggestion_id|string|建议 ID。|
#####|vid|string|视频 ID。<br>示例:v07033g50000c1irpg9l3c4i8hcdp7hg。|
#####|name|string|广告名称。|
#####|ad_id|string|广告 ID。<br>示例:1700286510378002。|
#####|issue_suggestion|string|问题建议。<br>枚举值: <ul><li>`NOBGM`: 视频无背景音乐。您需为视频添加背景音乐。可使用 [/creative/quick_optimization/create/](1739355078757377.html)为视频创建一键优化任务。</li><li>`VIDEO_LENGTH`:视频时长过短。需编辑视频增加时长。可使用 [/creative/quick_optimization/create/](1739355078757377.html)为视频创建一键优化任务。</li><li>`VIDEO_RESOLUTION`:视频分辨率过低。需替换为高分辨率视频。</li></ul>|
####|bid_and_budget|object[]|针对出价及预算的建议。<br>若未诊断出广告组中出价及预算的问题,本字段的值将为空列表(`[]`)。|
#####|suggestion_time|string|诊断出问题并生成建议的日期及时间(UTC+0 时间),格式为"YYYY-MM-DD HH:MM:SS"。<br>示例:"2024-01-01 00:00:01"。|
#####|suggestion_id|string|建议 ID。|
#####|issue_suggestion|string| 问题建议。枚举值: <ul><li>`SUGGEST_BID`: 建议更改出价</li><li>`SUGGEST_BUDGET`: 建议更改预算</li><li>`NOBID_SWITCH`: 切换为最大投放量出价策略</li><li> `BUDGET_EDR`:预算预估成效建议。若想了解预估成效详情,可查看[预估成效](1746463274713089.html)。</li><li> `BID_EDR`:出价预估成效建议。</li></ul> |
#####|bid|number|在`issue_suggestion`为 `SUGGEST_BID`时返回。<br>当前出价。|
#####|budget|number|在`issue_suggestion`为`SUGGEST_BID`, `SUGGEST_BUDGET`, 或`NOBID_SWITCH`时返回。<br>当前预算。|
#####|suggest_bid|number|在`issue_suggestion`为`SUGGEST_BID`时返回。<br>建议出价。|
#####|suggest_budget|number| 在`issue_suggestion`为`SUGGEST_BUDGET` 或`NOBID_SWITCH`时返回。<br>建议预算。|
#####|cost_floor|number|在`issue_suggestion`为`SUGGEST_BID`时返回。<br>预估成本下限。|
#####| bid_edr_info | object[] | 若`issue_suggestion`非`BID_EDR` ,本字段的值将为空列表(`[]`)。 <br>针对该广告组的出价预估成效建议。<br>9 组推荐出价及预估成效数据,推荐出价涨幅从-10%逐步增加5%,最高推荐增加30%出价。 |
######| recommended_bid | number | 推荐出价。<br>若需更新合适的出价,请使用[/adgroup/update/](1739586761631745.html)接口,将出价传给`conversion_bid_price`字段 ,在当天(广告主账户时区)进行更新。 |
######| bid_increase_ratio | number | 出价增加的预估比例。 |
######| estimated_cost | number | 预估花费。 |
######| cost_uplift | number | 预估花费提升量。 |
######| cost_uplift_ratio | number | 预估花费提升比例。 |
#####| budget_edr_info | object[] | 若`issue_suggestion`非`BUDGET_EDR` ,本字段的值将为空列表(`[]`)。<br>针对该广告组的预算预估成效建议。<br>15 组推荐预算及预估成效数据,推荐预算涨幅从 -20% 逐步增加5%,最高推荐增加 50% 预算 。 |
######| recommended_budget | number | 推荐预算。若需更新合适的预算,请使用 [/adgroup/budget/update/](1739591133130817.html)接口在当天(广告主账户时区)更新。 |
######| budget_increase_ratio | number | 预算增加的预估比例。 |
######| estimated_conversion | number | 预估转化量。 |
######| conversion_uplift | number | 预估转化提升量。 |
######| conversion_uplift_ratio | number | 预估转化提升比例。 |
######| cpa | number | 预估 CPA。 |
######| cpa_uplift | number | 预估 CPA 提升量。 |
######| cpa_uplift_ratio | number | 预估 CPA 提升比例。 |
######| impression | number | 预估展示数。 |
####|event_track|object[]|针对事件追踪的建议。<br>若未诊断出广告组中事件追踪的问题,本字段的值将为空列表(`[]`)。|
#####|suggestion_time|string|诊断出问题并生成建议的日期及时间(UTC+0 时间),格式为"YYYY-MM-DD HH:MM:SS"。<br>示例:"2024-01-01 00:00:01"。|
#####|suggestion_id|string|建议 ID。|
#####|issue_suggestion|string| 问题建议。<br>枚举值:<ul><li>`PIXEL`:该 Pixel 过去 7 日内无任何活动。请检查您的 Pixel 设置。</li></ul>|
#####|pixel_id|string|Pixel ID。|
#####|pixel_code|string|Pixel 代码。|
示例
(code curl http)
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"results": [
{
"adgroup_id": "{{adgroup_id}}",
"adgroup_name": "{{adgroup_name}}",
"diagnosis": {
"diagnosis_time": "{{diagnosis_time}}",
"suggestions": [
{
"bid_and_budget": [],
"creative": [],
"event_track": [
{
"issue_suggestion": "PIXEL",
"pixel_code": "{{pixel_code}}",
"pixel_id": "{{pixel_id}}",
"suggestion_id": "{{suggestion_id}}",
"suggestion_time": "{{suggestion_time}}"
}
]
}
]
}
}
]
}
}
(/code)