PlaylistItems

playlistItem 资源用于标识播放列表中包含的其他资源,例如视频。此外,playlistItem 资源还包含所含资源的详细信息,具体与该资源在该播放列表中的使用方式有关。

YouTube 还会使用播放列表来识别频道中上传的视频列表,其中每个 playlistItem 代表一个上传的视频。您可以从给定频道的 channel resource 中检索该列表的播放列表 ID。然后,您可以使用 playlistItems.list 方法创建列表。

方法

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

list
返回与 API 请求参数匹配的播放列表项集合。您可以检索指定播放列表中的所有播放列表项,或者按播放列表 ID 检索一个或多个播放列表项。立即试用
插入
将资源添加到播放列表。 立即试用
update
修改播放列表项。例如,您可以更新项在播放列表中的位置。 立即试用
delete
删除播放列表项。 立即试用

资源表示法

以下 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
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.videoOwnerChannelTitle string
上传视频的频道的频道标题。
snippet.videoOwnerChannelId string
上传此视频的频道的频道 ID。
snippet.playlistId string
YouTube 用来唯一标识播放列表项所在的播放列表的 ID。
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.insertvideos.update 方法设置此值。