获取创意疲劳检测结果
您可以使用本接口检测广告在过去的某个时间区间是否发生了创意疲劳。
若您希望通过Webhook订阅单个广告、广告组中所有广告或广告账户下所有广告的疲劳状态,请查看订阅Webhook-订阅广告疲劳状态小节。
欲了解创意疲劳检测功能的详情,请点击这里。
注意
创意疲劳检测目前为白名单功能。如需使用此功能,请联系您的TikTok销售代表。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/creative_fatigue/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |
| ad_id {必填} | string | 广告ID,用于获取对应的创意疲劳检测结果。 |
| filtering {必填} | object | 筛选条件。 |
#| start_date {必填} | string | 查询开始时间(闭区间)。格式:`YYYY-MM-DD`(广告主账户时区)。<br>只允许指定过去60天内的日期。 |
#| end_date{必填} | string | 查询结束时间(开区间)。格式:`YYYY-MM-DD`(广告主账户时区)。 <br>只允许指定过去60天内的日期。 |
| page | number | 当前页数。 <br>默认值:1。<br>取值范围:≥ 1。 |
| page_size | number | 分页大小。<br>默认值:10。 <br>取值范围:[1, 500]。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/creative_fatigue/get/' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": "{{advertiser_id}}",
"ad_id": "{{ad_id}}",
"filtering": {
"start_date": "2023-05-22",
"end_date": "2023-05-24"
},
"page": 1,
"page_size": 500
}'
(/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)。 |
|request_id |string| 请求的日志ID,唯一标识一个请求。 |
|data |object| 返回数据。 |
#| list | object[] | 创意疲劳检测结果信息。 |
##| adgroup_id | string | 广告(`ad_id`)所属的广告组ID。 |
##| ad_id | string | 广告ID。 |
##| date | string | 所获取的指标(`metrics`)数据对应的日期。 |
##| metrics | object | 日期(`date`)对应的指标数据。 |
###| has_fatigue | boolean | 是否检测到创意疲劳。 |
###| fatigue_index | number | 疲劳指数是衡量CPA(每行动成本),消耗,新用户触达率及其他表现指标每日变化的综合指标。指标数值越高代表创意疲劳程度越高。 |
###| dnu | number | 日新增用户人数,即该广告当日所吸引的新增用户人数。 |
###| dnu_ratio | number | 日新增用户比率。 <br> 本指标计算方式为:该广告当日所吸引的新增用户人数/该广告过去60天内的日新增用户人数最大值。 |
###| spend | number | 总消耗,即投放广告产生的花费金额。对应币种为广告账户默认币种。 |
###| cost_per_conversion | number | 当广告属于非iOS 14专属推广系列时,本指标返回实际值。 当广告属于iOS 14专属推广系列时,本指标返回`0.0`。 您可通过[/campaign/get/](https://ads.tiktok.com/marketing_api/docs?id=1739315828649986)返回的`campaign_type`值确定推广系列是否为iOS 14专属推广系列。<br> <br> 转化成本,即广告花费平均到单次转化的成本,计数结果基于展示时间点统计。对应币种为广告账户默认币种。 |
###| skan_cost_per_conversion | number | 当广告属于iOS 14专属推广系列时,本指标返回实际值。当广告属于非iOS 14专属推广系列时,本指标返回`0.0`。 您可通过[/campaign/get/](https://ads.tiktok.com/marketing_api/docs?id=1739315828649986)返回的`campaign_type`值确定推广系列是否为iOS 14专属推广系列。 <br> <br> 转化成本 (SKAN),即广告花费平均到单次转化的成本。由于SKAdnetwork(SKAN)限制,可能只有部分数据。计数结果基于回传时间统计,与实际发生时间存在延迟。对应币种为广告账户默认币种。 |
#| page_info | object | 分页信息。 |
##| page | number | 当前页数。 |
##| page_size | number | 分页大小。 |
##| total_number | number | 结果总数。 |
##| total_page | number | 总页数。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"page_info": {
"page_size": 500,
"total_page": 1,
"total_number": 2,
"page": 1
},
"list": [
{
"adgroup_id": "{{adgroup_id}}",
"date": "2023-05-22",
"metrics": {
"dnu": 26832,
"has_fatigue": false,
"skan_cost_per_conversion": 0.0,
"cost_per_conversion": 11.39,
"fatigue_index": 0.43000000000000005,
"dnu_ratio": 0.57,
"spend": 125.24
},
"ad_id": "{{ad_id}}"
},
{
"adgroup_id": "{{adgroup_id}}",
"date": "2023-05-23",
"metrics": {
"dnu": 32741,
"has_fatigue": false,
"skan_cost_per_conversion": 0.0,
"cost_per_conversion": 13.65,
"fatigue_index": 0.30000000000000004,
"dnu_ratio": 0.7,
"spend": 136.51
}
"ad_id": "{{ad_id}}"
}
]
}
}
(/code)