Playlists

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

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

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

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

方法

该 API 支持 playlists 资源的以下方法:

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

资源表示法

以下 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 px,高度为 90 px。频道的默认缩略图宽度为 88px,高度为 88px。
  • 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
本地化的播放列表说明。