playlistItem
资源用于标识播放列表中包含的其他资源(例如视频)。此外,playlistItem
资源包含有关所包含资源的详细信息,这些详细信息专门与该资源在该播放列表中的使用方式相关。
YouTube 还使用播放列表来标识频道上传的视频列表,其中列表中的每个 playlistItem
代表一个上传的视频。您可以从给定频道的 channel
资源中检索该列表的播放列表 ID。然后,您可以对列表使用 playlistItems.list
方法。
方法
该 API 支持对 playlistItems
资源使用以下方法:
资源表示法
以下 JSON 结构显示了 playlistItems
资源的格式:
{ "kind": "youtube#playlistItem", "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, "videoOwnerChannelTitle": string, "videoOwnerChannelId": string, "playlistId": string, "position": unsigned integer, "resourceId": { "kind": string, "videoId": string, } }, "contentDetails": { "videoId": string, "startAt": string, "endAt": string, "note": string, "videoPublishedAt": datetime }, "status": { "privacyStatus": string } }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 用于标识 API 资源的类型。该值将为 youtube#playlistItem 。 |
etag |
etag 此资源的 ETag。 |
id |
string 此 ID 是 YouTube 用来唯一标识播放列表项的 ID。 |
snippet |
object snippet 对象包含播放列表项的基本详细信息,例如其标题和在播放列表中的位置。 |
snippet.publishedAt |
datetime 内容添加到播放列表的日期和时间。该值采用 ISO 8601 格式指定。 |
snippet.channelId |
string 此 ID 用于由 YouTube 对将内容添加到播放列表的用户进行唯一标识。 |
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.videoOwnerChannelTitle |
string 上传此视频的频道的频道标题。 |
snippet.videoOwnerChannelId |
string 上传此视频的频道的频道 ID。 |
snippet.playlistId |
string 此 ID 由 YouTube 用于唯一标识播放列表项所在的播放列表。 |
snippet.position |
unsigned integer 内容在播放列表中的显示顺序。该值使用从 0 开始的索引,因此第一个项的编号为 0 ,第二个项的编号为 1 ,依此类推。 |
snippet.resourceId |
object id 对象包含可用于唯一标识作为播放列表项包含在播放列表中的资源的信息。 |
snippet.resourceId.kind |
string 所引用资源的种类或类型。 |
snippet.resourceId.videoId |
string 如果 snippet.resourceId.kind 属性的值为 youtube#video ,则此属性将存在,并且其值将包含 YouTube 用于唯一标识播放列表中视频的 ID。 |
contentDetails |
object 如果包含的项是 YouTube 视频,资源中会包含 contentDetails 对象。该对象包含有关视频的其他信息。 |
contentDetails.videoId |
string 这是 YouTube 用于唯一标识视频的 ID。如需检索 video 资源,请在 API 请求中将 id 查询参数设置为此值。 |
contentDetails.startAt |
string 注意:此属性已废弃,如果设置了此属性,系统会忽略其值。 视频应开始播放的时间,以秒为单位,自视频开头开始计算。(播放列表所有者可以指定视频在播放列表中播放时应开始和停止播放的时间。)默认值为 0 。 |
contentDetails.endAt |
string 注意:此属性已废弃,如果已设置,系统会忽略其值。 视频应停止播放的时间,以秒为单位,自视频开头开始计算。(播放列表所有者可以指定视频在播放列表中播放时应开始和停止播放的时间。)默认情况下,假设 video.endTime 是视频的结尾。 |
contentDetails.note |
string 用户为此项生成的备注。属性值的长度上限为 280 个字符。 |
contentDetails.videoPublishedAt |
datetime 视频发布到 YouTube 的日期和时间。该值采用 ISO 8601 格式指定。 |
status |
object status 对象包含有关播放列表项隐私权状态的信息。 |
status.privacyStatus |
string 播放列表项的隐私状态。上传播放列表项所代表视频的频道可以使用 videos.insert 或 videos.update 方法设置此值。 |