Playlists

playlist 资源表示 YouTube 播放列表。播放列表是一组视频，可以按顺序观看，也可以与其他用户分享。默认情况下，播放列表会向其他用户公开显示，但播放列表也可以设为公开或私享。

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

  • 上传的视频
  • 获得好评（赞）的视频
更具体地说，这些名单与频道相关联，而频道是个人、群组或公司的视频、播放列表和其他 YouTube 信息的集合。您可以从指定频道的 channel resource 中检索每个列表的播放列表 ID。

然后，您可以使用 playlistItems.list 方法检索这些列表中的任何一个。您还可以通过调用 playlistItems.insert 和 playlistItems.delete 方法来添加或移除这些列表中的项目。

方法

该 API 支持以下针对 playlists 资源的方法：

list
返回与 API 请求参数匹配的播放列表集合。例如，您可以检索经过身份验证的用户拥有的所有播放列表，也可以按唯一 ID 检索一个或多个播放列表。 立即试用。
insert
创建播放列表。 立即试用。
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,
    "podcastStatus": enum
  },
  "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 像素（宽）x 88 像素（高）。
  • medium - 缩略图的更高分辨率版本。对于视频（或引用视频的资源），此图片的宽度为 320 像素，高度为 180 像素。对于频道，此图片的宽度和高度均为 240 像素。
  • high - 缩略图图片的高分辨率版本。对于视频（或引用视频的资源），此图片的宽度为 480 像素，高度为 360 像素。对于频道，此图片的宽度和高度均为 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.title 和 snippet.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
status.podcastStatus string
播放列表的播客状态。如果值为 enabled，则相应播放列表会被标记为播客节目。如需将播放列表的播客状态设为 enabled，该播放列表必须具有播放列表图片。

此属性的有效值为：
  • enabled
  • disabled
  • unspecified
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
本地化的播放列表说明。