获取 TikTok 应用内链接
您可以使用本接口获取 TikTok 公开网址的对应应用内链接。获取的地址可以用于创建覆盖和频次广告中,需要将地址传入广告的deeplink字段。
注意
应用内链接目前为白名单功能。如需使用此功能,请联系您的 TikTok 销售代表。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/tools/open_url/|/v1.3/tool/open_url/|
|请求参数类型 |advertiser_id: number|advertiser_id`: string|
## 请求
**地址**: https://business-api.tiktok.com/open_api/v1.3/tool/open_url/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告账号 ID。 |
|url {必填}|string| 您想要获取对应应用内链接的TikTok公开网址。 |
|url_type {必填}| string| TikTok公开网址类型。枚举值:<ul><li>`USER_PROFILE`:用户档案页面。</li><li>`VIDEO`:视频详情页面。</li><li>`HASHTAG_CHALLENGE`:挑战赛页面。</li><li>`MUSIC`:音乐页面。</li><li>`STICKER`:贴纸(特效)页面。</li><li>`STICKER_SHOOTER`:贴纸开拍页面。</li></ul>|
示例
(code CURL CURL)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/tool/open_url/?advertiser_id={{advertiser_id}}&url={{url}}&url_type=USER_PROFILE' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段|类型|描述|
|---|---|---|
|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|返回数据。 |
#|open_url|string| TikTok应用内链接。|
#|supported_regions|string[]| 贴纸(特效)可以使用的国家和地区。仅当`url_type` 为`STICKER` 或`STICKER_SHOOTER`时返回。 |
示例
(code JSON JSON)
{
"code": 0,
"message": "OK",
"request_id": "2021090212163301024502410742C587F8",
"data": {
"open_url": "sslocal://user/profile/60320267633123456?sec_uid=MS4wLjABAAAAzUKwYoagO3vLvQVSeMxAFUc5INu7rqzoCFmlOYtAtbd9Rah9FpoMg9wpr8QdkdIf"
}
}
(/code)