通过关键词搜索视频

1. 接口描述

URL https://openapi.youku.com/router/rest.json
功能描述 站内视频普通搜索接口,此接口的超时时间为1秒钟。
返回格式 Json,UTF8
HTTP请求方式 GET
当前接口版本 V3
历史接口版本 V2

2. 系统参数

参数名 参数全称 必选 参数类型 参数描述
action action true String youku.search.video.keyword.get
client_id client_id true String 应用的client id
access_token access token false String oauth2的token
format format false String 可选,指定响应格式。默认保持代理接口格式化,目前支持格式为xml,json,text
timestamp timestamp true String 客户端当前时间戳,精确到秒,timestamp与开放平台请求时间误差为6分钟
version version true String 3.0
sign sign true String 对API调用参数(除sign外)的md5加密值。详情见签名方法

3. 业务参数

参数名 必选 参数类型 参数默认值 参数描述
keyword String 查询关键词
curpage int 1 查询第几页数据:最多查询100页,如果大于100则按100处理
pagesize int 25 每页返回结果数:每页最多返回100条结果,如果大于100则按100处理
orderfield String null 排序方式:默认按相关度排序,
null	按相关度倒排序
createtime	按发布时间倒排序
total_pv	按pv量倒排序
total_comment	按评论数倒排序
total_fav	按收藏数倒排序
ftype String 视频文件格式筛选:默认不筛选,
1	mp4(高清)
2	3gp
3	H263FLV
4	3GPHD
5	H264FLV(FLV升级版h264)
6	Hd2 720P(超清)
timeless int 0 视频时长筛选:定义时长小于几分钟(不包含),默认0表示不筛选
timemore int 0 视频时长筛选:定义时长大于等于几分钟(包含),默认0表示不筛选
limit_date string 发布时间筛选:默认不筛选,最近2天内发布的视频 limit_date=2,比如[1,2)天内发布的视频limit_date=1-2
cateid int 0 分类筛选:默认不筛选, (分类ID)84 世界杯 85 综艺 86 娱乐 87 教育 88 旅游 89 时尚 90 母婴 91 资讯 92 原创 93 女性 94 搞笑 95 音乐 96 电影 97 电视剧 98 体育 99 游戏 100 动漫 101 自拍 102 广告 103 生活 104 汽车 105 科技 106 其他
categories string 多分类筛选:默认不筛选,由用“,”分割的视频分类id组成的字符串 如categories=96,97,同cateid
exclude_cates String 多分类排除筛选:默认不筛选,由用“,”分割的视频分类id组成的字符串如exclude_cates=96,97,同cateid
partner int 0 合作伙伴筛选:默认不筛选,如果指定则只返回属于该合作伙伴的视频
relnum int 0 相关词查询结果:定义最多返回多少相关词,默认0表示不返回相关词结果video types=1时有效
suggestion int 0 建议纠错词:1返回结果,默认0表示不返回结果 只有在video types=1时有效
noqc int 0 不自动纠错:1不纠错,默认0表示自动纠错 只有在video types=1时有效
hl String false 结果高亮处理:是否启用高亮处理,默认不启用 hl=true 启用高亮处理,将对视频标题/标签/发布者名称中包含keyword的串进行高亮 hl=false 不启用高亮处理
noqc int 0 不自动纠错:1不纠错,默认0表示自动纠错 只有在video types=1时有效
hl_prefix String 结果高亮处理:当hl=true时,定义被高亮串的前置串
hl_suffix string 0 结果高亮处理:当hl=true时,定义被高亮串的后置串
h 开启格式化输出:当存在h参数时,格式化返回的json结果(用于调试)
userid int 0 用户id,只有在video types=25时有效
public_type int 筛选加密视频,0:公开 1:好友 4:加密
pay_type int 筛选收费视频 1:收费 0:免费

4. 返回参数

参数名 参数全称 必选 参数类型 参数描述
encodeVid true String 视频ID
title true string 视频标题
memo true string 视频简介
tags true string 视频标签
createtime true string 创建时间
total_pv true int 总访问量
total_comment true int 总评论数
total_fav true int 总收藏数
cate_ids true 分类
logo true string 视频截图
seconds true int 时长
owner true int 上传用户ID
owner_username true string 上传用户名
md5 true int md5值
size true int 视频大小
public_type true int 是否加密,0或空表示公开
source_type true int 来源类型:0:'转载',0x01:'原创',0x02:'版权',0x04:'剧集',0x08:'节目',0x10:'DVD视频'
ftype true int 视频清晰度:EMPTY = 0,3GP = 1,3GPHD = 2,FLV = 100,FLVHD = 101,MP4HD = 102,MP4HD2 = 103,MP4HD3 = 104(1080P)
title_hl true string 标题高亮处理
tags_hl true string 标签高亮处理
username_hl true string 用户名高亮处理
full_title_hl true string 完整标题高亮处理

5. 调用示例

    https://openapi.youku.com/router/rest.json?opensysparams={"timestamp": 1453720442, 
"client_id": "163d4fd10c7f9a28", "version": "3.0", "access_token": 
"d9ce66ced641240836cf6011a4c195bc", "action": "youku.search.video.keyword.get", "format":
 "json", "sign": "90cfec261f0ddc4ee843ccadf33f7885"}&caller=NOVA&keyword=abc
  			

6. 响应示例

{
    "total": 67763,
    qcStr: "||||||||||||||||||||||||||||||||||||||||",
    "items": {
        "0": {
            "vid": 87907657,
            "encodeVid": "XMzUxNjMwNjI4",
            "title": "牛人自制会射击的机器蜘蛛",
            "memo": "",
            "tags": "牛人,自制,DIY,射击,机器人,蜘蛛,机器蜘蛛,遥控,充气,cnstudio",
            "createtime": "2012-02-12 14:26:54",
            "total_pv": 5055,
            "total_comment": 6,
            "total_fav": 7,
            "cate_ids": 92,
            "logo": "0100641F464F3758E40EAD00ACA80CDFF41716-5053-EE5F-EFE7-2A91D02EF379",
            "seconds": "448",
            "owner": "11315212",
            "owner_username": "真九尾狐",
            "md5": "03000202004F375F54C98A00ACA80CAF415EF9-C109-E4C0-8EBD-FADB6AF20218",
            "size": 15951737,
            "public_type": 0,
            "source_type": 0,
            "ftype": "5",
            "title_hl": "牛<\/span>人<\/span>自制会射击的机器蜘蛛",
            "tags_hl": "牛人,自制,DIY,射击,机器人,蜘蛛,机器蜘蛛,遥控,充气,cnstudio",
            "username_hl": "真九尾狐",
            "full_title_hl": "牛<\/span>人<\/span>自制会射击的机器蜘蛛"
        },
        ...
        "24": {
            "vid": 85386240,
            "encodeVid": "XMzQxNTQ0OTYw",
            "title": "高手在民间!牛人就是这么泊车的!.转自A站",
            "memo": "当你发现自己的车被划伤,要淡定",
            "tags": "高手,牛人,泊车,停车",
            "createtime": "2012-01-10 19:56:35",
            "total_pv": 76074,
            "total_comment": 33,
            "total_fav": 28,
            "cate_ids": 104,
            "logo": "0100641F464EE402BF9532026273D387517ECA-417B-08D6-6652-7973AD6A637E",
            "seconds": "31",
            "owner": "18249319",
            "owner_username": "梦碎三千",
            "md5": "03000201004EE402BF4951026273D33E34423F-86B6-7611-668C-CE60AB0FDCA4",
            "size": 1039104,
            "public_type": 0,
            "source_type": 0,
            "ftype": "2,3,4,5",
            "title_hl": "高手在民间!牛<\/span>人<\/span>就是这么泊车的!.转自A站",
            "tags_hl": "高手,牛人,泊车,停车",
            "username_hl": "梦碎三千",
            "full_title_hl": "高手在民间!牛<\/span>人<\/span>就是这么泊车的!.转自A站"
        }
    },
    "categories": "",
    "suggestion": "",
    "relevantwords": "",
    "major_term": "",
    "cost": 59,
    "miss": false,
    "page": 25
}
			

7. 异常示例

{ total: 0, -items: { }, ver: “v1” } 
			

8. 注意事项

请预留“X-Caller”和“User-Agent”段以标识调用方名称和调用方平台请设置“Accept-Encoding: gzip, deflate”段以打开gzip压缩,并且调用方需要支持gzip解压缩如果调用方不是请求的发起方而是代理方,请设置“X-Forwarded-For”记录发起方的真实IP Referer、Cookie等段可选,建议代理方能够尽量多的带上调用方的相关信息,以便服务方分析用户行为 User-Agent:如果请求是用户直接发起的,代理平台需将用户的User-Agent带过来 X-Forwarded-For:如果请求是用户直接发起的,代理平台需将用户的真实IP带过来,否则返回数据受限 X-Real-Ip:如果请求是用户直接发起的,代理平台需将用户的真实IP带过来,否则返回数据受限。 X-Caller:明确调用方平台的名称,未知的名称可能被限制