获取网页锚点
你可以使用本接口获取你的 TikTok One (TTO) Creator Marketplace 账号中已有的网页锚点。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/tto/tcm/anchor/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|经 TikTok One 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) 接口。|
|anchor_ids|string[]|锚点 ID 列表。<br><br>最大数量：100。<br><br>如果不传入 `anchor_ids`，将返回 TTO Creator Marketplace 账号中的所有锚点。|
|page|integer|当前页码。<br><br>值范围：≥ 1。<br>默认值：1。|
|page_size|integer|页面大小。<br><br>值范围：1-50。<br>默认值：10。|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/tto/tcm/anchor/get/?tto_tcm_account_id={{tto_tcm_account_id}}&page=1&page_size=50' \
--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|返回数据。|
#|anchors|object[]|锚点列表。|
##|anchor_id|string|锚点 ID。|
##|status|string|锚点状态。<br><br>枚举值： <ul><li>`DRAFT`：锚点处于草稿模式。</li><li>`CREATED`：锚点已创建，但尚未进入审核。</li><li>`IN_REVIEW`：锚点正在审核中。</li><li>`APPROVED`：锚点已通过审核。</li><li>`REJECTED_BY_AUDIT`：锚点在审核中被拒。</li></ul>|
##|anchor_type|string|锚点类型。<br><br>枚举值： <ul><li>`WEB_ANCHOR`：网页锚点。此类锚点可用于在达人视频描述上方展示网站链接。</li></ul>|
##|anchor_sub_type|string|当 `anchor_type` 为 `WEB_ANCHOR` 时返回。网页锚点的具体类型。<br><br>枚举值： <ul><li>`DESTINATION`：网页直达链接。此类锚点可将观众跳转到可在 TikTok 内打开的网页直达链接。锚点会同时显示在达人的视频和评论区中。</li><li>`ECOMMERCE`：评论区商务模板。此类锚点将观众跳转到品牌可添加优惠券链接的内部落地页。锚点将仅显示在达人的视频评论区中。</li><li>`ENTERTAINMENT`：评论区娱乐模板。此类锚点将观众跳转到品牌可添加视频片段的内部落地页。锚点将仅显示在达人的视频评论区中。</li></ul>|
##|country_code|string|国家或地区代码。系统将使用此国家或地区应用商店的应用信息。此锚点在其他国家/地区不可用。<br><br>若想了解代码所代表的国家或地区，参见[地区代码](1737585867307010.html)文档。|
##|call_to_action|object|锚点链接信息。|
###|landing_page_url|string|锚点将观众跳转到的页面的 URL。该页面展示你的商品或服务的详细信息。|
###|ios_download_link|string|供用户下载你的应用的 iOS 下载链接。<br><br>当 `anchor_type` 为 `WEB_ANCHOR` 时，此字段将为空。|
###|ios_deep_link|string|供用户下载你的应用的 iOS 下载深度链接。<br><br>当 `anchor_type` 为 `WEB_ANCHOR` 时，此字段将为空。|
###|android_download_link|string|供用户下载你的应用的 Android 下载链接。<br><br>当 `anchor_type` 为 `WEB_ANCHOR` 时，此字段将为空。|
###|android_deep_link|string|供用户下载你的应用的 Android 下载深度链接。<br><br>当 `anchor_type` 为 `WEB_ANCHOR` 时，此字段将为空。|
##|anchor_title|string|锚点标题。|
##|anchor_name|string|锚点名称。|
##|anchor_sub_title|string|锚点标题，用于向 TikTok 用户说明你所推广商品或服务的内容。<br><br>当 `anchor_sub_type` 为 `DESTINATION` 时，此字段将为空。|
##|thumbnail_url|string|锚点的缩略图 URL。|
##|coupon_link|object|此字段仅在 `anchor_sub_type` 为 `ECOMMERCE` 时返回非空值。<br><br>优惠券链接信息，该链接将用户跳转到包含你的推广系列折扣详细信息的页面。|
###|discount|number|折扣。<br><br>例如，当 `discount` 为 `5` 时，表示打九五折。|
###|coupon_url|string|优惠券 URL。|
###|coupon_code|string|优惠券代码。|
##|pixel_id|string|用于度量和分析推广效果的 Pixel 的 ID。|
##|creator_preview_url|string|锚点和落地页的预览 URL，可用于手机端预览。<br><br> 此 URL 不会过期。|
##|advertiser_preview_url|string|锚点和落地页的手机预览 URL，可用于桌面端预览。<br><br>此 URL 不会过期。<br><br>当 `anchor_sub_type` 为 `DESTINATION` 时，此字段将为空。|
#|page_info|object|分页信息。|
##|page|number|当前页码。|
##|page_size|number|当前页面大小。|
##|total_number|number|结果总数。|
##|total_page|number|页面总数。|
示例
(code Success-Response http)
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"anchors": [
{
"advertiser_preview_url": "{{advertiser_preview_url}}",
"anchor_id": "{{anchor_id}}",
"anchor_name": "{{anchor_name}}",
"anchor_sub_title": "{{anchor_sub_title}}",
"anchor_sub_type": "ENTERTAINMENT",
"anchor_title": "{{anchor_title}}",
"anchor_type": "WEB_ANCHOR",
"call_to_action": {
"android_deep_link": null,
"android_download_link": null,
"ios_deep_link": null,
"ios_download_link": null,
"landing_page_url": "{{landing_page_url}}"
},
"country_code": "TW",
"coupon_link": null,
"creator_preview_url": "{{creator_preview_url}}",
"pixel_id": null,
"status": "IN_REVIEW",
"thumbnail_url": "{{thumbnail_url}}"
},
{
"advertiser_preview_url": "{{advertiser_preview_url}}",
"anchor_id": "{{anchor_id}}",
"anchor_name": "{{anchor_name}}",
"anchor_sub_title": "{{anchor_sub_title}}",
"anchor_sub_type": "ECOMMERCE",
"anchor_title": "{{anchor_title}}",
"anchor_type": "WEB_ANCHOR",
"call_to_action": {
"android_deep_link": null,
"android_download_link": null,
"ios_deep_link": null,
"ios_download_link": null,
"landing_page_url": "{{landing_page_url}}"
},
"country_code": "US",
"coupon_link": {
"coupon_code": "",
"coupon_url": "",
"discount": 5
},
"creator_preview_url": "{{creator_preview_url}}",
"status": "IN_REVIEW",
"thumbnail_url": "{{thumbnail_url}}"
},
{
"advertiser_preview_url": null,
"anchor_id": "{{anchor_id}}",
"anchor_name": "{{anchor_name}}",
"anchor_sub_title": null,
"anchor_sub_type": "DESTINATION",
"anchor_title": "Watch Now",
"anchor_type": "WEB_ANCHOR",
"call_to_action": {
"android_deep_link": null,
"android_download_link": null,
"ios_deep_link": null,
"ios_download_link": null,
"landing_page_url": "{{landing_page_url}}"
},
"country_code": "CA",
"coupon_link": null,
"creator_preview_url": "{{creator_preview_url}}",
"pixel_id": "7258197703320944642",
"status": "IN_REVIEW",
"thumbnail_url": "{{thumbnail_url}}"
}
],
"page_info": {
"page": 1,
"page_size": 50,
"total_number": 3,
"total_page": 1
}
}
}
(/code)