获取广告账号的推广系列标签
此接口可用于获取广告账号内的推广系列标签列表。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/campaign_label/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](1738373164380162.html)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id{必填} | string | 广告主 ID。 |
| campaign_label_ids | string[] | 推广系列标签 ID 列表。<br><br>最大数量:50。<br><br>每个标签 ID 必须为 19 位数字字符串。<br><br><p><span style="color:darkred"><b>注意</b></span>:本筛选条件仅支持在同步基础报表中使用。</p> |
| campaign_label_names | string[] | 推广系列标签名称列表。<br><br>支持模糊匹配。<br><br>最大数量:10。 |
| campaign_label_types | string[] | 推广系列标签类型列表。<br><br>枚举值:<ul><li>`GENERAL`:通用标签。</li><li>`MARKETING_EVENT`:营销事件标签。</li></ul> |
| page | number | 当前页数。<br><br>默认值:1。<br><br>取值范围:≥1。 |
| page_size | number | 分页大小。<br><br>默认值:10。<br><br>取值范围:1-1,000。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign_label/get/?advertiser_id={{advertiser_id}}&page=1&page_size=1000' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number|返回码。完整返回码列表及描述参见[附录 - 返回码](1737172488964097.html)。 |
|message|string|返回信息。更多信息参见[附录 - 返回码](1737172488964097.html)。|
|request_id |string|请求的日志 ID,唯一标识一个请求。 |
|data |object|返回数据。|
#|list|object[]|广告账号内推广系列标签的详细信息。|
##|campaign_label_id|string|推广系列标签 ID。|
##|campaign_label_name|string|推广系列标签名称。|
##|campaign_label_type|string|推广系列标签类型。<br><br>枚举值:<ul><li>`GENERAL`:通用标签。</li><li>`MARKETING_EVENT`:营销事件标签。</li></ul>|
##|campaign_label_color|string|推广系列标签颜色。|
##|create_time|string|推广系列标签创建时间,格式为 `YYYY-MM-DD HH:MM:SS` (UTC+0)。<br><br>示例:`2025-01-01 00:00:01`。|
#|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": {
"list": [
{
"campaign_label_color": "pinkFilled",
"campaign_label_id": "{{campaign_label_id}}",
"campaign_label_name": "{{campaign_label_name}}",
"campaign_label_type": "MARKETING_EVENT",
"create_time": "{{create_time}}"
},
{
"campaign_label_color": "blueOutlined",
"campaign_label_id": "{{campaign_label_id}}",
"campaign_label_name": "{{campaign_label_name}}",
"campaign_label_type": "GENERAL",
"create_time": "{{create_time}}"
}
],
"page_info": {
"page": 1,
"page_size": 1000,
"total_number": 2,
"total_page": 1
}
}
}
(/code)