获取广告详情
使用 POST /v2/research/adlib/ad/detail/ 获取广告详情。
HTTP URL | https://open.tiktokapis.com/v2/research/adlib/ad/detail/ |
HTTP 请求方法 | POST |
权限范围 | research.adlib.basic |
请求
请求头
Key | 类型 | 描述 | 示例 | 是否必填 |
Authorization | 字符串 (String) | TikTok 用户授权的访问令牌,通过 /v2/oauth/token/ 获取。 | Bearer clt.example12345Example12345Example | 是 |
Content-Type | 字符串 (String) | 资源的原始媒体类型。 | application/json | 是 |
查询参数
Key | 类型 | 描述 | 示例 | 是否必填 |
fields | 字符串 (String) | 请求的字段:
| ad.id,ad.first_shown_date,ad.last_shown_date | 是 |
请求体
Key | 类型 | 描述 | 示例 | 是否必填 |
ad_id | i64 | 广告 ID。 | 104836593772645 | 是 |
请求示例
curl -L -X POST 'https://open.tiktokapis.com/v2/research/adlib/ad/detail/?fields=ad.id,ad.first_shown_date,ad.last_shown_date' \
-H 'Authorization: Bearer clt.example12345Example12345Example' \
-H 'Content-Type: application/json' \
--data-raw '{
"ad_id": 1873831353981330
}'响应
Key | 类型 | 示例 |
data | AdDetailData | 请参见以下响应示例。 |
error | ErrorStructV2 | 请参见以下响应示例。 |
响应示例
{
"data": {
"ad": {
"first_shown_date": 20210101,
"id": 1923845247192304,
"image_urls": [
"https://asdfcdn.com/17392712.jpeg?x-expires=1679169600\u0026x-signature=asdf"
],
"last_shown_date": 20210101,
"status": "active",
"videos": [
{"url": "https://asdfcdn.com/..../127364jmdfjsa93d8cn30dm2di/?mime_type=video_mp4"},
{"url": "https://asdfcdn.com/..../1kmeidhfb38u21nd82hsk389fd/?mime_type=video_mp4"}
],
"reach": {
"unique_users_seen": "30K",
"unique_users_seen_by_country": {
"GB": "18K",
"IT": "12K"
},
"unique_users_seen_breakdowns": [
{
"region": "GB",
"unique_users_seen": "18K",
"breakdowns": [
{
"age": "18-24",
"gender": "MALE",
"unique_users_seen": "9K"
},
{
"age": "18-24",
"gender": "FEMALE",
"unique_users_seen": "9K"
}
]
},
{
"region": "IT",
"unique_users_seen": "12K",
"breakdowns": [
{
"age": "18-24",
"gender": "MALE",
"unique_users_seen": "6K"
},
{
"age": "18-24",
"gender": "FEMALE",
"unique_users_seen": "6K"
}
]
}
]
},
"rejection_info": {
"affected_countries": ["FR", "IT"]
},
"title": "Shop deals now",
"external_url": "https://asdfcdn.com/purchase.html",
"download_url": "https://play.google.com/store/apps/details?id=com.asdfcdn.asdfcdn",
"call_to_action": "Learn more",
"advertising_objective": "Sales"
},
"ad_group": {
"targeting_info": {
"number_of_users_targeted": "50K",
"country": ["IT", "GB"],
"age": {
"13-17": false,
"18-24": false,
"25-34": false,
"35-44": true,
"45-54": true,
"55+": true
},
"gender": {
"female": true,
"male": true,
"other_genders": true
},
"audience_targeting": "No",
"video_interactions": "Entertainment",
"creator_interactions": "Talent",
"interest": "News & Entertainment, Business Services",
"provinces": ["Auvergne Rhone Alpes","Virginia"],
"cities": ["Westmoreland"],
"languages": ["English", "French"],
"device_models": ["Google"],
"operating_systems": ["IPHONE","ANDROID"],
"high_spending_power": "Yes",
"audience_targeting_exclude": "No"
}
},
"advertiser": {
"business_id": 1755645247067185,
"business_name": "Awesome Co.",
"country_code": "US",
"paid_by": "Awesome Co.",
"tiktok_account": {
"avatar_url": "https://asdf.tiktokcdn.com/1736254.jpeg?x-expires=1679169600\u0026x-signature=asdf",
"follower_count": 26374,
"profile_url": "https://www.tiktok.com/@awesome_co"
}
}
},
"error": {
"code": "ok",
"http_status_code": 200,
"log_id": "202207280326050102231031430C7E754E",
"message": ""
}
}数据结构
GetAdDetailData
Key | 类型 | 描述 | 示例 |
advertiser | Advertiser | 广告主元数据。 | |
ad_group | AdGroup | 广告组元数据。 | |
ad | Ad | 广告元数据。 |
Advertiser
Key | 类型 | 描述 | 示例 |
business_id | i64 | 广告主的企业 ID。 | 1755645247067185 |
business_name | 字符串 (String) | 广告主的企业名称。 | Awesome Co. |
country_code | 字符串 (String) | 广告主所在的国家/地区,取值格式为 ISO 3166-1 定义的双字母代码。 | US |
paid_by | 字符串 (String) | 广告主的资金来源。 | Awesome Co. |
tiktok_account | TikTokAccount | 广告主的 TikTok 账号信息。 | 请参见“TikTokAccount”表中的示例 |
TikTokAccount
Key | 类型 | 描述 | 示例 |
profile_url | 字符串 (String) | 广告主的 TikTok 主页链接。 | https://www.tiktok.com/@awesome_co |
avatar_url | 字符串 (String) | 广告主的 TikTok 虚拟头像链接。 | https://asdf.tiktokcdn.com/1736254.jpeg?x-expires=1679169600&x-signature=asdf |
follower_count | i64 | 广告主的 TikTok 粉丝数。 | 26374 |
AdGroup
Key | 类型 | 描述 | 示例 |
targeting_info | TargetingInfo | 广告组的目标用户。 | 请参见“TargetingInfo”表中的示例。 |
TargetingInfo
Key | 类型 | 描述 | 示例 |
number_of_users_targeted | 字符串 (String) | 目标用户总数。 | "20K" |
country | list<string> | 目标国家/地区。 | [\"FR\", \"GB\"] |
age | map<string,bool> | 目标用户的年龄段。 | { "13-17": false, "18-24": false, "25-34": false, "35-44": true, "45-54": true, "55+": true } |
gender | map<string,bool> | 目标用户性别。 | { "female": true, "male": false, "unknown": true } |
audience_targeting | 字符串 (String) | 表示用户是否属于广告主上传的受众名单的标志。 | "Yes" |
video_interactions | 字符串 (String) | 用户互动过的视频类别列表。 | "Entertainment" |
creator_interactions | 字符串 (String) | 基于用户关注或观看创作者作品的方式所划分的创作者类别列表。 | "Talent" |
interest | 字符串 (String) | 广告观众的兴趣类别列表。 | "News & Entertainment, Business Services" |
provinces | list<string> | 目标州或省份。 | ["Auvergne Rhone Alpes","Virginia"] |
cities | list<string> | 目标城市。 | ["Westmoreland"] |
languages | list<string> | 目标用户的语言。 | ["English","French"] |
device_models | list<string> | 目标设备型号。 | ["Google"] |
operating_systems | list<string> | 目标操作系统。 | ["IPHONE","ANDROID"] |
high_spending_power | 字符串 (String) | 广告是否针对高消费能力用户。 | "Yes" |
audience_targeting_exclude | 字符串 (String) | 广告是否是排除了自定义受众的定向投放。 | "No" |
Ad
Key | 类型 | 描述 | 示例 |
id | i64 | 广告 ID。 | 1923845247192304 |
first_shown_date | 字符串 (String) | 该广告首次展示日期。 | 20210101 |
last_shown_date | 字符串 (String) | 该广告最后一次展示的日期。 | 20210101 |
status | 字符串 (String) | 该广告的审计状态:active 或 inactive。 | active |
ad_videos | list<AdVideo> | 广告视频列表。 | 参见“AdVideo”表中的示例 |
image_urls | list<string> | 广告图片 URL 列表。 | [ "https://asdfcdn.com/17392712.jpeg?x-expires=1679169600\u0026x-signature=asdf" ] |
reach | Reach | 广告组的受众。 | 参见“Reach”表中的示例。 |
rejection_info | RejectionInfo | 参见“RejectionInfo”表中的示例。 | |
title | 字符串 (String) | 广告的文案。 | “今日特惠” |
external_url | 字符串 (String) | 广告链接到的外部网站 URL 地址,例如广告主网站或登陆页面。 | "https://asdfcdn.com/purchase.html" |
download_url | 字符串 (String) | 广告链接到的应用下载页 URL 地址。 | "https://play.google.com/store/apps/details?id=com.asdfcdn.asdfcdn" |
call_to_action | 字符串 (String) | 广告行动号召按钮上显示的文字。 | “了解详情” |
advertising_objective | 字符串 (String) | 为活动选择的广告目标。 | “销售” |
AdVideo
Key | 类型 | 描述 | 示例 |
url | 字符串 (String) | 该广告的视频地址。 | https://asdfcdn.com/..../127364jmdfjsa93d8cn30dm2di/?mime_type=video_mp4 |
Reach
Key | 类型 | 描述 | 示例 |
unique_users_seen | 字符串 (String) | 观看过此广告的独立用户总数。 | 10K |
unique_users_seen_by_country | map<string,string> | 按国家/地区统计的观看过此广告的独立用户数。该字段已弃用。请使用 unique_users_seen_breakdowns 字段。 | { "GB": "13K", "IT": "12K" } |
unique_users_seen_breakdowns | list<ReachBreakdown> | 按地区分组并按年龄和性别细分的观看过该广告的独立用户数量。 | 参见“ReachBreakdown”表中的示例。 |
ReachBreakdown
Key | 类型 | 描述 | 示例 |
region | 字符串 (String) | 广告的投放地区。 | "IT" |
unique_users_seen | 字符串 (String) | 此区域内观看过此广告的独立用户总数。 | "6K" |
breakdowns | list<ReachBreakdownDetail> | 该地区按年龄和性别细分的观看过该广告的独立用户数量。 | 参见“ReachBreakdownDetail”表中的示例。 |
ReachBreakdownDetail
Key | 类型 | 描述 | 示例 |
age | 字符串 (String) | 用户年龄段。 | "18-24" |
gender | 字符串 (String) | 用户性别。 | "MALE" |
unique_users_seen | 字符串 (String) | 按年龄和性别细分的观看过该广告的独立用户数量。 | "0-1K" |
ErrorStructV2
Key | 类型 | 描述 | 示例 |
code | 字符串 (String) | 字符串格式的错误类别代码。 | ok |
message | 字符串 (String) | 详细的错误描述。 | |
log_id | 字符串 (String) | 与对应请求关联的唯一日志 ID,用于错误处理。 | 202207280326050102231031430C7E754E |
http_status_code | i32 | HTTP 状态码。 | 200 |
RejectionInfo
Key | 类型 | 描述 | 示例 |
reasons | list<string> | 广告被拒绝的原因(如有)。 | ["基于我司对业务评估、用户体验和广告影响价值等因素的综合考量,你的广告/登陆页上推广的产品/服务属于广告定向投放地区的禁止行业。"] |
affected_countries | list<string> | 受影响的地区(如有),即列出的拒绝原因可能适用该广告的地区。如果广告被拒,且未指定被拒绝的投放国家/地区,则该广告可能会在所有投放国家/地区被拒。 | ["奥地利", "比利时"] |
reporting_source | 字符串 (String) | 导致广告被拒的举报或检测来源(如有)。 | 用户和第三方可以向 Tiktok 举报违反政策的行为。Tiktok 基于广告内容违反 Tiktok 《广告政策》的举报检测到该违规行为。 |
automated_notice | 字符串 (String) | 描述 TikTok 采取自动化审查处理决定的通知。如果由人工审核做出的处理决定,则此字段返回空值。 | Tiktok 采取自动化处理措施做出该决定。 |