← 返回目录
📁 API Reference › GMV Max

(即将废弃)获取自定义作品中视频的详情

您可以使用本接口获取商品 GMV Max 推广系列中的自定义作品合集中使用的视频详情。

重要提示
此接口将在下一个 API 版本中弃用。为确保无缝集成,可使用/gmv_max/creation/custom_anchor_video_list/get/和/gmv_max/creation/shop_video/video_anchors/获取自定义作品中视频的详情。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/gmv_max/custom_anchor_video_list/get/

方法 GET

Header

|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|

参数

|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
| advertiser_id {必填} | string | 广告账户 ID。 |
| campaign_id {必填} | string | GMV Max 推广系列的 ID。<br><br>如需筛选广告账户中的现有 GMV Max 推广系列,需使用 [/gmv_max/campaign/get/](1826463372290177.html) 接口。<br><br><p><span style="color:darkred"><b>重要提示</b></span>: 为增强安全性,自 2026 年 4 月 30 日起,此参数将变为必填。为确保 API 的顺畅集成,建议尽快更新集成方案,在未来的所有调用中都明确指定此参数。</p> |
| campaign_custom_anchor_video_id{必填}  | string | 商品 GMV Max 推广系列中创建的自定义的作品的合集 ID。<br><br>若想获取与商品 GMV Max 推广系列绑定的自定义的作品的合集,可使用 [/campaign/gmv_max/info/](https://business-api.TikTok.com/portal/docs?id=1822000968821762) 并查看返回的 `campaign_custom_anchor_video_id`。 |
| custom_anchor_video_list {必填} | object[] | 要筛选的带有自定义商品链接的视频(即自定义的作品中的视频)。<br><br>最大数量:20。<br><br>若想获取与商品 GMV Max 推广系列绑定的自定义作品,可使用 [/campaign/gmv_max/info/](https://business-api.TikTok.com/portal/docs?id=1822000968821762) 并查看返回的 `custom_anchor_video_list`。 |
# | item_id {必填} | string | TikTok 帖子 ID。 |
# | identity_info {必填} | object | 与该 TikTok 帖子绑定的认证身份的有关信息。 |
## | identity_id {必填} | string | 认证身份 ID。 |
## | identity_type {必填} | string | 认证身份类型。<br><br>枚举值:<ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。</li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。</li></ul> |
## | identity_authorized_bc_id {+条件必填} | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 时,本字段必填。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。 |
## | identity_authorized_shop_id {+条件必填} | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 且 [/gmv_max/identity/get/](1822001101474882.html) 为此认证身份返回了 `identity_authorized_shop_id` 字段时,本字段必填。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
## | store_id {+条件必填} | string | 仅当 `identity_type` 为 `TTS_TT` 时,本字段必填。<br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
# | spu_id_list | string[] | 与该作品中的自定义商品锚点链接绑定的商品的 SPU ID 列表。<br><br>最大数量:1。<br><br>若您希望返回 `spu_id_list` 字段,需在请求中传入 `spu_id_list`。 |

示例

在返回中包含 spu_id_list

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/gmv_max/custom_anchor_video_list/get/?advertiser_id={{advertiser_id}}&campaign_id={{campaign_id}}&campaign_custom_anchor_video_id={{campaign_custom_anchor_video_id}}&custom_anchor_video_list=[{"item_id":"{{item_id}}","identity_info":{"identity_id":"{{identity_id}}","identity_type":"TT_USER"},"spu_id_list":["{{spu_id}}"]}]'
--header 'Access-Token: {{Access-Token}}'
(/code)

在返回中不包含 spu_id_list

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/gmv_max/custom_anchor_video_list/get/?advertiser_id={{advertiser_id}}&campaign_id={{campaign_id}}&campaign_custom_anchor_video_id={{campaign_custom_anchor_video_id}}&custom_anchor_video_list=[{"item_id":"{{item_id}}","identity_info":{"identity_id":"{{identity_id}}","identity_type":"TT_USER"}}]'
--header 'Access-Token: {{Access-Token}}'
(/code)

返回

|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|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| 返回数据。 |
# | custom_anchor_video_list | object[] | 自定义的作品中的视频列表。 |
## | item_id | string | TikTok 帖子 ID。<br><br>示例:`1234567891234567891`。 |
## | text | string | TikTok 帖子描述。<br><br>示例:`summer`。 |
## | spu_id_list | string[] | 仅当请求中传入 `spu_id_list` 时返回本字段。<br><br>与该 TikTok 帖子绑定的商品 SPU ID 列表。 |
## | identity_info | object | 与该 TikTok 帖子绑定的认证身份的有关信息。 |
### | identity_id | string | 认证身份 ID。 |
### | identity_type | string | 认证身份类型。<br><br>枚举值:<ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。</li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。</li></ul> |
### | identity_authorized_bc_id | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 时返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。 |
### | identity_authorized_shop_id | string | 仅为部分 `BC_AUTH_TT` 认证身份返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
### | store_id | string | 仅当 `identity_type` 为 `TTS_TT` 时返回本字段。<br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
### | profile_image | string | 与该认证身份绑定的 TikTok 账号的主页头像临时 URL。<br><br>有效期:约 48 小时。过期时间包含在 `x-expires` 参数后的 URL 中,格式为以秒为单位的 Epoch/Unix 时间戳。<br><br>URL 过期后,您需要调用 [/gmv_max/custom_anchor_video_list/get/](1830215925061633.html) 获取新的 URL。 |
### | user_name | string | 与该认证身份绑定的 TikTok 账号的用户名。 |
## | video_info | object | 帖子中视频的详情。 |
### | video_id | string | 视频 ID。<br><br>示例:`video_12345`。 |
### | video_cover_url | string | 视频封面的临时 URL。<br><br>有效期:约 24 小时。过期时间包含在 `x-expires` 参数后的 URL 中,格式为以秒为单位的 Epoch/Unix 时间戳。<br><br>URL 过期后,您需要调用 [/gmv_max/custom_anchor_video_list/get/](1830215925061633.html) 获取新的 URL。 |
### | preview_url | string | 视频的临时预览 URL。<br><br>有效期:6 小时。<br><br>URL 过期后,您需要调用 [/gmv_max/custom_anchor_video_list/get/](1830215925061633.html) 获取新的 URL。 |
### | height | number | 视频的高度,单位为像素。<br><br>示例:1920。 |
### | width | number | 视频的宽度,单位为像素。<br><br>示例:1080。 |
### | bit_rate | number | 视频的码率,单位为 bps。<br><br>示例:8500323。 |
### | duration | number | 视频的时长,单位为秒。<br><br>示例:3.669。 |
### | size | number | 视频文件的大小,单位为 byte。<br><br>示例:3898461。 |
### | signature | string | 视频文件的 MD5 值。<br><br>示例:`ab1cd2345e678fghi91jkl23b456m7no`。 |
### | format | string | 视频的格式。<br><br>示例:`mp4`。 |
### | definition | string | 视频的清晰度。<br><br>示例:`1080p`。 |
### | fps | number | 视频的每秒帧数(FPS)。<br><br>示例:27。 |

示例

在返回中包含 spu_id_list

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "custom_anchor_video_list": [
            {
                "identity_info": {
                    "identity_id": "{{identity_id}}",
                    "identity_type": "TT_USER",
                    "profile_image": "{{profile_image}}",
                    "user_name": "{{user_name}}"
                },
                "item_id": "{{item_id}}",
                "spu_id_list": [
                    "{{spu_id}}"
                ],
                "text": "{{text}}",
                "video_info": {
                    "bit_rate": 824497,
                    "definition": "540p",
                    "duration": 10.444,
                    "format": "mp4",
                    "fps": 30,
                    "height": 960,
                    "preview_url": "{{preview_url}}",
                    "signature": "{{signature}}",
                    "size": 1076382,
                    "video_cover_url": "{{video_cover_url}}",
                    "video_id": "{{video_id}}",
                    "width": 540
                }
            }
        ]
    }
}
(/code)

在返回中不包含 spu_id_list

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "custom_anchor_video_list": [
            {
                "identity_info": {
                    "identity_id": "{{identity_id}}",
                    "identity_type": "TT_USER",
                    "profile_image": "{{profile_image}}",
                    "user_name": "{{user_name}}"
                },
                "item_id": "{{item_id}}",
                "text": "{{text}}",
                "video_info": {
                    "bit_rate": 824497,
                    "definition": "540p",
                    "duration": 10.444,
                    "format": "mp4",
                    "fps": 30,
                    "height": 960,
                    "preview_url": "{{preview_url}}",
                    "signature": "{{signature}}",
                    "size": 1076382,
                    "video_cover_url": "{{video_cover_url}}",
                    "video_id": "{{video_id}}",
                    "width": 540
                }
            }
        ]
    }
}
(/code)

内容来源:TikTok API for Business 官方文档 · 本地归档

在接这个接口时卡住了?
Stuck wiring this API into production? We build ad-delivery tooling on these platforms — campaign automation, reporting pipelines, error-handling and migration between API versions.
联系我们 · Talk to us 每日平台更新简报 →