PlaylistItems

playlistItem 资源用于标识播放列表中包含的其他资源(例如视频)。此外,playlistItem 资源还包含有关所含资源的详细信息,这些信息专门涉及相应资源在相应播放列表中的使用方式。

YouTube 还会使用播放列表来标识频道的已上传视频列表,该列表中的每个 playlistItem 都代表一个已上传的视频。您可以从指定频道的 channel 资源中检索相应列表的播放列表 ID。然后,您可以使用 playlistItems.list 方法处理该列表。

方法

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

list
返回与 API 请求参数匹配的播放列表项集合。您可以检索指定播放列表中的所有播放列表项,也可以按唯一 ID 检索一个或多个播放列表项。 立即试用
insert
将资源添加到播放列表。 立即试用
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 像素,高度为 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.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 方法设置此值。