获取商品库中上传的商品库视频
您可以使用本接口获取电商商品库中已上传的商品库视频。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/catalog/video/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| bc_id {必填} | string | 商务中心 ID。<br><br>若想获取您有权访问的商务中心列表，可使用[/bc/get/](1737115687501826.html)。 |
| catalog_id{必填} | string | 商品库 ID。<br><br>若想获取某个商务中心中的电商商品库列表，可使用 [/catalog/get/](1740315452868610.html)，筛选对应的 `catalog_type` 为 `ECOM` 的 `catalog_id`值。<br><br>您需对商品库有商品库管理（目录管理）或广告推广权限。若想获取您有商品库管理或广告推广权限的商品库， 可使用[/bc/asset/get/](1739432717798401.html)。将`asset_type` 设置为 `CATALOG`，筛选对应的 `catalog_role` 为 `ADMIN` 或 `AD_PROMOTE`的 `asset_id` 值。 |
| catalog_video_ids | string[] | 想要筛选的商品库视频的 ID。<br><br>最大数量：50。<br><br><p><span style="color:darkred"><b>注意</b></span>：若您为`catalog_video_ids`传入了值，将忽略分页参数 `page` 和 `page_size`。 |
| page | integer | 当前页数。 <br><br>取值范围：≥1。默认值：1。 <br><br><p><span style="color:darkred"><b>注意</b></span>：若您为`catalog_video_ids`传入了值，将忽略分页参数 `page` 和 `page_size`。 |
| page_size | integer | 分页大小。 <br><br>取值范围：1-50。默认值：10。<br><br><p><span style="color:darkred"><b>注意</b></span>：若您为`catalog_video_ids`传入了值，将忽略分页参数 `page` 和 `page_size`。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/catalog/video/get/?bc_id={{bc_id}}&catalog_id={{catalog_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| 返回数据。 |
#| videos | object[] |商品库视频列表。 |
##|catalog_video_id | string | 商品库视频的 ID。 <br><br>示例：`1234567891234567891_1234567891234567891_12345678912345_12345678-a12b-34cd-ef56-7gh89i1j2k3l `。|
##| video_name| string | 视频名称。 |
##| video_link | string | 视频文件的 URL。|
##| sku_id_list | string[] | 与该视频绑定的电商商品库商品的 SKU ID 列表。|
##| category | string | 视频的商品类别。|
##| brand | string | 视频的品牌名称。 |
##| creator | string | 视频的创作者。 |
##| video_type | string | 视频的类型。 |
##| description | string | 视频的简短描述。 |
##| landing_page_url | string | 可浏览及购买与该视频关联的商品的落地页 URL。|
##| custom_label_0 | string |视频的其他信息。 |
##| custom_label_1 | string | 视频的其他信息。|
##| custom_label_2 | string | 视频的其他信息。 |
##| custom_label_3 | string | 视频的其他信息。|
##| custom_label_4 | string | 视频的其他信息。 |
##| video_id | string | 视频转存完成后生成的视频 ID。|
##| video_signature | string | 视频的 MD5 散列值。 <br><br>示例：`123abcdefg4a56e789012c3cefa4d567`。 |
##| status | string | 视频转存状态。<br><br> 枚举值： <ul><li>`PENDING`：视频转存中。 </li><li>`SUCCESS`：视频转存成功。</li><li> `FAILED`：视频转存失败。</li></ul>
##| create_time | string |视频上传完成的时间，格式为`YYYY-MM-DD HH:MM:SS`（UTC+0）。 <br><br>示例：`2024-01-01 00:00:00`。 <br><br><p><span style="color:darkred"><b>注意</b></span>：若 `status` 为`PENDING` 或 `FAILED`，本字段的值将为空字符串（`""`）。|
##| active_status | string | 视频的上架状态，由广告主自主控制。<br><br>枚举值： <ul><li>`ACTIVATED`：视频已上架，可用于广告投放。</li><li>`DEACTIVATED`：视频已下架，不可用于广告投放。下架视频可能会影响投放状态的推广系列中关联广告的投放。</li></ul>|
##| preview_url | string |仅当 `status` 为 `SUCCESS` 时返回本字段。<br><br>视频预览链接。有效期 6 小时，过期需重新获取。 |
#| page_info | object |分页信息。|
##| page | integer |当前页数。 |
##| page_size | integer | 分页大小。|
##| total_number | integer |总结果数。 |
##| total_page | integer | 总页数。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"videos": [
{
"video_id": "{{video_id}}",
"preview_url": "{{preview_url}}",
"video_type": "{{video_type}}",
"landing_page_url": "",
"create_time": "{{create_time}}",
"active_status": "DEACTIVATED",
"catalog_video_id": "{{catalog_video_id}}",
"video_link": "{{video_link}}",
"creator": "{{creator}}",
"description": "",
"status": "SUCCESS",
"video_name": "{{video_name}}",
"brand": "br10",
"category": "{{category}}",
"video_signature": "{{video_signature}}",
"sku_id_list": [
"{{sku_id_1}}",
"{{sku_id_2}}",
"{{sku_id_3}}"
]
},
{
"video_id": "{{video_id}}",
"preview_url": "{{preview_url}}",
"video_type": "{{video_type}}",
"landing_page_url": "",
"create_time": "{{create_time}}",
"active_status": "ACTIVATED",
"catalog_video_id": "{{catalog_video_id}}",
"video_link": "{{video_link}}",
"creator": "{{creator}}",
"description": "",
"status": "SUCCESS",
"video_name": "{{video_name}}",
"brand": "{{brand}}",
"category": "{{category}}",
"video_signature": "{{video_signature}}",
"sku_id_list": [
"{{sku_id_1}}",
"{{sku_id_2}}",
"{{sku_id_3}}",
"{{sku_id_4}}",
"{{sku_id_5}}"
]
}
],
"page_info": {
"total_number": 2,
"total_page": 1,
"page": 1,
"page_size": 50
}
}
}
(/code)