You need to enable JavaScript to run this app.
导航
ListLongVideos - 获取长视频列表
最近更新时间:2024.04.19 15:50:05首次发布时间:2024.04.18 16:41:25

分页获取长视频列表。
长视频列表按用户分配的ExternalId的字典序排序,暂不支持自定义排序。

使用场景

  • 长视频库是内容定制提供的一项扩展能力,能够将客户的长视频媒资库与内容定制丰富的横版短视频/竖版小视频资源进行关联,该能力目前可以在商品推广的场景下使用。
  • 基于长视频库 OpenAPI,客户可以灵活的实现长视频库的同步和管理,打通客户系统和内容定制的长视频库。

注意事项

  • 请求频率:不建议直接在在线服务场景 (例如推荐) 中使用,同账号下单接口限流100QPS
  • 前提条件:已完成商品推广-长视频库相关配置。

请求说明

  • 请求方式:POST
  • 请求地址:https://mercury.volcengineapi.com?Action=ListLongVideos&Version=2022-01-01
  • 请求头:ServiceName:volc_torchlight_api

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必填
示例值
描述
Action
String

ListLongVideos

要执行的操作,取值:ListLongVideos。

Version
String

2022-01-01

API的版本,取值:2022-01-01。

Body

参数
类型
是否必填
示例值
描述
UtmSource
String

xxx_default_content

渠道号。

PageNumber
Integer

10

翻页页码,起始值为1,默认值为1。

PageSize
Integer

100

翻页每页的大小,默认值为10,最大值为100。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
PageNumber
Integer

10

原样返回请求参数(请求参数未填写时则为参数默认值)。

PageSize
Integer

10

原样返回请求参数值(请求参数未填写时则为参数默认值)。

TotalCount
Integer

100

查询结果的总数。

LongVideos
Array of LongVideo

长视频信息列表。

请求示例

{
    "UtmSource":"xxx_default_content",
    "PageSize":2,
    "PageNumber":1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230306141941A2***D4C07737D2E777B",
        "Action": "ListLongVideos",
        "Version": "2022-01-01",
        "Service": "volc_torchlight_api",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 2,
        "TotalCount": 2,
        "LongVideos": [
            {
                "ExternalId": "l00000000001",
                "Name": "勇敢的心",
                "MatchedName": "勇敢的心",
                "Directors": [
                    "梅尔·吉布森"
                ],
                "Actors": [
                    "梅尔·吉布森",
                    "苏菲·玛索",
                    "布莱恩·考克斯"
                ],
                "Extra": ""
            },
            {
                "ExternalId": "l00000000002",
                "Name": "大白鲨",
                "MatchedName": "大白鲨",
                "Directors": [
                    "史蒂文·斯皮尔伯格"
                ],
                "Actors": [
                    "罗伊·谢德",
                    "罗伯特·肖",
                    "理查德·德莱福斯"
                ],
                "Extra": ""
            }
        ]
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。