获取 TTO 账号的品牌主页
此接口可用于获取 TikTok One (TTO) Creator Marketplace 账号的现有品牌主页。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/tto/tcm/brand/profile/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|经 TTO Creator Marketplace 账号授权的访问令牌。<br>可以通过[获取访问令牌](https://business-api.tiktok.com/portal/docs/obtain-authorization-and-authentication-from-a-tto-creator-marketplace-account/v1.3)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|--- |--- |--- |
| tto_tcm_account_id {必填} | string | TTO Creator Marketplace 账号的 ID。<br><br>若想获取可通过 `Access-Token` 访问的账号的 ID,需使用 [/tto/oauth2/tcm/](1815693478150146.html) 接口。 |
| brand_profile_ids | string[] | 用于筛选结果的现有品牌主页 ID。<br><br>最大数量:20。 |
| page | number | 当前页码。<br><br>值范围:≥ 1。<br>默认值:1。 |
| page_size | number | 页面大小。<br><br>值范围:1-100。<br>默认值:10。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/tto/tcm/brand/profile/get/?tto_tcm_account_id={{tto_tcm_account_id}}&page=1&page_size=100' \
--header 'Access-Token: {{Access-Token}}'
(/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|返回数据。|
#|brands | object[] | 品牌主页列表。 |
##|brand_profile_id | string | 品牌主页 ID。 |
##|brand_name | string | 品牌名称。 |
##|brand_industry | string | 品牌行业 ID。 |
##|brand_website | string | 品牌网站链接。 |
##|logo_url | string | 你的 TTO Creator Marketplace 账号的品牌 Logo 图片的 URL。<br><br><p><span style="color:darkred"><b>注意</b></span>:此 URL 由系统为品牌 Logo 图片生成,与在创建品牌主页的请求中通过 `logo_url` 传入的 URL 不同。 |
##|tiktok_account_url|string|你的 TikTok 账号的 URL。<br><br>如果未提供用于创建品牌主页的 TikTok 账号 URL,此字段将为空字符串 (`""`)。|
#| 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": {
"brands": [
{
"brand_industry_id": "10102102000",
"brand_name": "{{brand_name}}",
"brand_profile_id": "{{brand_profile_id}}",
"brand_website": "{{brand_website}}",
"logo_url": null
},
{
"brand_industry_id": "17103000000",
"brand_name": "{{brand_name}}",
"brand_profile_id": "{{brand_profile_id}}",
"brand_website": "{{brand_website}}",
"logo_url": "{{logo_url}}"
}
],
"page_info": {
"page": 1,
"page_size": 100,
"total_number": 2,
"total_page": 1
}
}
}
(/code)