playlist
资源表示 YouTube 播放列表。播放列表是一组视频,可以按顺序观看,也可以与其他用户分享。默认情况下,播放列表会向其他用户公开显示,但播放列表也可以设为公开或私享。
YouTube 还会使用播放列表来标识频道的特殊视频合集,例如:
- 上传的视频
- 获得好评(赞)的视频
channel resource
中检索每个列表的播放列表 ID。然后,您可以使用
playlistItems.list
方法检索这些列表中的任何一个。您还可以通过调用 playlistItems.insert
和 playlistItems.delete
方法来添加或移除这些列表中的项目。
方法
该 API 支持以下针对 playlists
资源的方法:
资源表示法
以下 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 有效键值包括:
|
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 对象包含播放列表的本地化标题和说明,或播放列表元数据的默认语言标题。
localizations 对象添加、更新或删除本地化标题。 |
snippet.localized.title |
string 本地化的播放列表标题。 |
snippet.localized.description |
string 本地化的播放列表说明。 |
status |
object status 对象包含播放列表的状态信息。 |
status.privacyStatus |
string 播放列表的隐私状态。 此属性的有效值包括:
|
status.podcastStatus |
string 播放列表的播客状态。如果值为 enabled ,则相应播放列表会被标记为播客节目。如需将播放列表的播客状态设为 enabled ,该播放列表必须具有播放列表图片。此属性的有效值为:
|
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 本地化的播放列表说明。 |