Playlists

playlist 资源表示 YouTube 播放列表。播放列表是可以连续观看并与其他用户分享的视频集合。默认情况下,播放列表会向其他用户公开显示,但播放列表可以是公开或私享的。

YouTube 还会使用播放列表来标识频道的特殊视频集,例如:

  • 已上传的视频
  • 好评如潮(赞过)的视频
更具体地说,这些列表与频道相关联,频道集合了个人、群组或公司的视频、播放列表和其他 YouTube 信息。您可以从指定频道的 channel resource 中检索每个列表的播放列表 ID。

然后,您可以使用 playlistItems.list 方法来检索其中的任何列表。您还可以通过调用 playlistItems.insertplaylistItems.delete 方法,在这些列表中添加或移除项。

方法

对于 playlists 资源,该 API 支持以下方法:

list
返回与 API 请求参数匹配的播放列表集合。例如,您可以检索经过身份验证的用户拥有的所有播放列表,也可以按唯一 ID 检索一个或多个播放列表。立即试用
insert
创建播放列表。 立即试用
update
修改播放列表。例如,您可以更改播放列表的标题、说明或隐私状态。 立即试用
删除
删除播放列表。 立即试用

资源表示法

以下 JSON 结构显示了 playlists 资源的格式:

{
  "kind": "youtube#playlist",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "channelTitle": string,
    "defaultLanguage": string,
    "localized": {
      "title": string,
      "description": string
    }
  },
  "status": {
    "privacyStatus": string
  },
  "contentDetails": {
    "itemCount": unsigned integer
  },
  "player": {
    "embedHtml": string
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

属性

下表定义了此资源中显示的属性:

属性
kind string
标识 API 资源的类型。其值为 youtube#playlist
etag etag
此资源的 Etag。
id string
YouTube 用来唯一标识播放列表的 ID。
snippet object
snippet 对象包含播放列表的基本详情,例如其标题和说明。
snippet.publishedAt datetime
播放列表的创建日期和时间。该值以 ISO 8601 格式指定。
snippet.channelId string
YouTube 用来唯一标识发布播放列表的频道的 ID。
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.tags[] list
此属性已废弃。

与播放列表相关联的关键字标记。
snippet.defaultLanguage string
playlist 资源的 snippet.titlesnippet.description 属性中的文本语言。
snippet.localized object
snippet.localized 对象包含播放列表的本地化标题和说明,或播放列表元数据默认语言的标题。
  • 如果 playlists.list 请求使用 hl 参数指定应针对哪种语言返回本地化文本,并且该语言提供该语言的本地化文本,则系统会在资源代码段中返回本地化文本。
  • 如果未指定 hl 参数值指定了值,但指定语言的本地化元数据不可用,则返回默认语言的元数据。
此属性包含只读值。使用 localizations 对象添加、更新或删除已本地化的影视内容。
snippet.localized.title string
本地化的播放列表标题。
snippet.localized.description string
本地化的播放列表说明。
status object
status 对象包含播放列表的状态信息。
status.privacyStatus string
播放列表的隐私状态。

此属性的有效值包括:
  • private
  • public
  • unlisted
contentDetails object
contentDetails 对象包含有关播放列表内容的信息,包括播放列表中的视频数量。
contentDetails.itemCount unsigned integer
播放列表中的视频数量。
player object
player 对象包含可用于在嵌入式播放器中播放播放列表的信息。
player.embedHtml string
<iframe> 标记,用于嵌入将播放播放列表的播放器。
localizations object
localizations 对象封装了播放列表元数据的翻译。
localizations.(key) object
与键值对关联的本地化文本的语言。该值是一个包含 BCP-47 语言代码的字符串。
localizations.(key).title string
本地化的播放列表标题。
localizations.(key).description string
本地化的播放列表说明。