Search

search 结果包含与 API 请求中指定的搜索参数匹配的 YouTube 视频、频道或播放列表的相关信息。虽然搜索结果指向具有唯一标识符的资源(例如视频),但它没有自己的永久性数据。

方法

该 API 支持以下搜索方法:

list
返回与 API 请求中指定的查询参数匹配的搜索结果集合。默认情况下,搜索结果集会识别匹配的 videochannelplaylist 资源,但您也可以配置查询,以便仅检索特定类型的资源。 立即试用

资源表示法

以下 JSON 结构显示了搜索结果的格式:

{
  "kind": "youtube#searchResult",
  "etag": etag,
  "id": {
    "kind": string,
    "videoId": string,
    "channelId": string,
    "playlistId": string
  },
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "channelTitle": string,
    "liveBroadcastContent": string
  }
}

属性

下表定义了搜索结果中显示的属性:

属性
kind string
用于标识 API 资源的类型。该值将为 youtube#searchResult
etag etag
此资源的 ETag。
id object
id 对象包含可用于唯一标识与搜索请求匹配的资源的信息。
id.kind string
API 资源的类型。
id.videoId string
如果 id.type 属性的值为 youtube#video,则此属性将存在,并且其值将包含 YouTube 用来唯一标识与搜索查询匹配的视频的 ID。
id.channelId string
如果 id.type 属性的值为 youtube#channel,则此属性将存在,并且其值将包含 YouTube 用来唯一标识与搜索查询匹配的频道的 ID。
id.playlistId string
如果 id.type 属性的值为 youtube#playlist,则此属性将存在,并且其值将包含 YouTube 用来唯一标识与搜索查询匹配的播放列表的 ID。
snippet object
snippet 对象包含有关搜索结果的基本详细信息,例如其标题或说明。例如,如果搜索结果是视频,则标题将是视频的标题,说明将是视频的说明。
snippet.publishedAt datetime
搜索结果标识的资源的创建日期和时间。该值采用 ISO 8601 格式指定。
snippet.channelId string
此值由 YouTube 用于唯一标识发布了搜索结果中所标识资源的频道。
snippet.title string
搜索结果的标题。
snippet.description string
搜索结果的说明。
snippet.thumbnails object
与搜索结果相关联的缩略图的映射。对于映射中的每个对象,键是缩略图的名称,值是包含缩略图的其他信息的对象。
snippet.thumbnails.(key) object
有效的键值包括:
  • default - 默认缩略图。视频或提及视频的资源(例如播放列表项或搜索结果)的默认缩略图宽度为 120 像素,高度为 90 像素。频道的默认缩略图宽度为 88 像素,高度为 88 像素。
  • medium - 缩略图的更高分辨率版本。对于视频(或引用视频的资源),此图片的宽度为 320 像素,高度为 180 像素。对于频道,此图片的宽度为 240 像素,高度为 240 像素。
  • high - 缩略图的较高分辨率版本。对于视频(或提及视频的资源),此图片的宽度为 480 像素,高度为 360 像素。对于频道,此图片的宽度为 800 像素,高度为 800 像素。
  • standard - 比 high 分辨率图片分辨率更高的缩略图图片。此图片适用于某些视频以及提及视频的其他资源,例如播放列表项或搜索结果。此图片的宽度为 640 像素,高度为 480 像素。
  • maxres - 缩略图图片的分辨率最高版本。此图片尺寸适用于部分视频以及提及视频的其他资源,例如播放列表项或搜索结果。此图片的宽度为 1280 像素,高度为 720 像素。
snippet.thumbnails.(key).url string
图片的网址。
snippet.thumbnails.(key).width unsigned integer
图片的宽度。
snippet.thumbnails.(key).height unsigned integer
图片的高度。
snippet.channelTitle string
发布搜索结果中标识的资源的频道的标题。
snippet.liveBroadcastContent string
指示 videochannel 资源是否包含直播内容。有效的属性值为 upcominglivenone

对于 video 资源,值为 upcoming 表示视频是尚未开始的直播,值为 live 表示视频是正在进行的直播。对于 channel 资源,值 upcoming 表示频道有尚未开始的预定直播,值 live 表示频道有正在进行的直播。