获取添加至广告账户的 URL 资源列表
您可以使用本接口获取已添加至广告账户的 URL 资源列表。
欲了解添加和验证 URL 资源的详细步骤,参阅管理 URL 资源。
重要提示
自 2025 年 10 月 15 日起,使用此接口时需要同时指定开发者应用的密钥。注意
尽管已验证的域名的子域名自动视作已验证,但除非您通过/business/property/add/将这些子域名专门添加到广告主账户中,否则本接口将不会返回这些子域名的信息。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/business/property/list/
方法 GET
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| app_id {必填} | string |开发者应用ID。<br><br>若想获取<strong>应用ID</strong>,您可以导航至<strong>[应用管理](https://business-api.tiktok.com/portal/apps)</strong> > <strong>App Detail</strong> > <strong>基本信息</strong>。|
|secret {必填}|string| 开发者应用密钥。<br><br>若想获取<strong>密钥</strong>,可以导航至<strong>[应用管理](https://ads.tiktok.com/marketing_api/apps/)</strong> > <strong>App Detail</strong> > <strong>基本信息</strong>。|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/business/property/list/?app_id={{app_id}}&secret={{secret}}' \
(/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| 返回数据。 |
#| url_property_info_list | object | 已添加至广告账户的 URL 资源的信息。 |
##| property_type| integer | URL 资源的类型。 <br>枚举值: <ul><li>1:网域。</li><li>2:网址前缀。</li></ul>|
##| url | string | 已添加至广告账户的自有 URL。|
##| property_status | integer | URL 资源的验证状态。<br>枚举值: <ul><li> 0:等待验证。</li><li>1:已验证。</li><li>2:由于验证尝试失败而未验证。您需要重新验证 URL 资源。</li></ul> |
##| signature | string | 在所有权验证过程中要使用的签名字符串。 |
##| file_name | string | 在所有权验证过程中要使用的签名文件名。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"url_property_info_list": [
{
"property_type": {{property_type}},
"url": "{{url}}",
"property_status": {{property_status}},
"signature": "{{signature}}",
"file_name": "{{file_name}}"
}
]
}
}
(/code)