以下示例展示了如何使用 YouTube Data API (v3) 执行与播放列表和播放列表项相关的函数。
检索当前用户的播放列表
调用 playlists.list
方法可检索当前已验证身份的用户的播放列表。在请求中,将 mine
参数的值设置为 true
。请注意,使用 mine
参数的请求必须使用 OAuth 2.0 进行授权。
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=snippet,contentDetails &mine=true
检索用户的播放列表
此示例会检索特定频道创建的播放列表。该示例包含两个步骤:
-
第 1 步:检索频道 ID
调用
channels.list
方法可检索与特定 YouTube 用户名相关联的频道 ID。(在此示例中,用户名为GoogleDevelopers
。)在 API 响应中,id
属性用于标识频道 ID。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list? part=id &forUsername=GoogleDevelopers
-
第 2 步:检索频道的播放列表
调用
playlists.list
方法以检索频道的播放列表。将channelId
参数的值设置为第 1 步中获得的值。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=snippet,contentDetails &channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw
检索有关特定播放列表的信息
如需检索一个或多个特定播放列表的相关信息,请调用 playlists.list
方法,并将 id
参数设置为包含所需资源的 YouTube 播放列表 ID 的逗号分隔列表。此功能的一个常见用例是,请求检索一组搜索结果中返回的播放列表的其他信息。例如,您可能需要检索每个播放列表中的内容数量。
以下请求会调用 playlists.list
方法,以检索与查询字词“GoogleDevelopers”匹配的两个播放列表中的项数。此信息位于 playlist
资源的 contentDetails.itemCount
属性中,因此请求会将 part
参数值设置为 contentDetails
。
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=contentDetails &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w
添加播放列表
此示例调用 playlists.insert
方法,以便在经过身份验证的用户的频道中创建私享播放列表。对此方法的任何 API 请求都必须使用 OAuth 2.0 进行授权。
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert? part=snippet,status
指向 API Explorer 的链接还会设置一个参数,用于指定 API 请求的正文。请求正文包含一个 playlist
资源,用于定义播放列表的标题、说明和隐私状态等信息。在此示例中,请求正文为:
{ "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "privacyStatus": "private" } }
以下示例将新播放列表标记为播客节目:
{ "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "podcastStatus": "enabled" } }
相关代码示例:Java、JavaScript、.NET、PHP、Python
更新播放列表
以下示例将播放列表的隐私状态从 private
更新为 public
。该示例包含两个步骤:
-
第 1 步:检索播放列表 ID
调用
playlists.list
方法可检索当前已验证用户频道中的播放列表。上面用于检索当前用户的播放列表的示例请求演示了此请求。调用该 API 的应用可以处理 API 响应,以使用每个播放列表的 ID 作为键来显示播放列表列表。 -
第 2 步:更新播放列表
调用
playlists.update
方法可修改特定播放列表。此方法需要有效的 OAuth 2.0 授权令牌。请求正文必须包含
playlist
资源的snippet
部分,因为调用此方法时需要snippet.title
属性。此外,如果要更新的播放列表资源为snippet.description
或snippet.tags
属性指定了值,则必须在更新请求中重新指定这些值,否则系统会将其删除。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update? part=snippet,status
如上文中添加播放列表的示例所示,指向 API Explorer 的链接会设置一个参数,用于指定 API 请求的正文。请求正文包含一个
playlist
资源,用于定义播放列表的标题、说明和隐私状态等信息。此示例中使用了以下请求正文:{ "id": "PLAYLIST_ID", "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "privacyStatus": "public" } }
以下示例将播放列表标记为播客节目:
{ "id": "PLAYLIST_ID", "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "podcastStatus": "enabled" } }
注意:如果您要在 API Explorer 中测试此查询,则需要将有效的播放列表 ID 替换为资源正文。如需获取播放列表 ID,我们建议您先运行上面显示的添加播放列表请求。从 API 响应中提取播放列表 ID,并将该值用于要更新的播放列表。此示例中使用的播放列表标题和说明与该示例中使用的相同。
添加播放列表项
此示例将内容添加到播放列表。此请求必须使用 OAuth 2.0 授权。此示例包含两个步骤:
-
第 1 步:检索适当的播放列表 ID
调用
playlists.list
方法可检索当前已验证用户频道中的播放列表。上面用于检索当前用户的播放列表的示例请求演示了此请求。调用该 API 的应用可以处理 API 响应,以使用每个播放列表的 ID 作为键来显示播放列表列表。 -
第 2 步:将视频添加到播放列表
调用
playlistItems.insert
方法可将视频添加到播放列表。此请求必须使用 OAuth 2.0 授权。请求正文是一个playlistItem
资源,其中至少指定了以下值:snippet.playlistId
用于标识要将视频添加到的播放列表。这是您在第 1 步中获取的播放列表 ID。snippet.resourceId.kind
包含值youtube#video
。snippet.resourceId.videoId
用于标识您要添加到播放列表中的视频。媒体资源价值是唯一的 YouTube 视频 ID。
以下 API 请求会将视频添加到播放列表。请求正文如下:
{ "snippet": { "playlistId": "PLAYLIST_ID", "resourceId": { "kind": "youtube#video", "videoId": "VIDEO_ID" } } }
如需在 API Explorer 中完成请求,您需要为
snippet.playlistId
和snippet.resourceId.videoId
属性设置值。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert? part=snippet
注意:
playlistItems.insert
方法的文档中列出了您在添加播放列表项时可以设置的其他属性值。
添加播放列表图片
您可以使用 v3 API 的 playlistImages.insert
方法上传自定义缩略图图片,并为播放列表设置该图片。在请求中,playlistId
参数的值用于标识要使用缩略图的播放列表。
您无法使用 API Explorer 测试此查询,因为 API Explorer 不支持上传媒体文件,而这是此方法的要求。
更新播放列表项
此示例会更新播放列表项,使其成为播放列表中的第一项。此请求必须使用 OAuth 2.0 授权。此示例包含三个步骤:
-
第 1 步:检索适当的播放列表 ID
调用
playlists.list
方法可检索当前已验证用户频道中的播放列表。上面用于检索当前用户的播放列表的示例请求演示了此请求。调用该 API 的应用可以处理 API 响应,以使用每个播放列表的 ID 作为键来显示播放列表列表。 -
第 2 步:检索所选播放列表中的项
调用
playlistItems.list
方法以检索所选播放列表中的视频列表。将playlistId
参数的值设置为您在第 1 步中获取的播放列表 ID。API 响应中的每个资源都包含一个
id
属性,用于标识用于唯一标识相应内容的播放列表项 ID。您将在下一步中使用该值从列表中移除某个项。 -
第 3 步:更新所选的播放列表项
调用
playlistItems.update
方法可更改视频在播放列表中的位置。将part
参数值设置为snippet
。请求正文必须是playlistItem
资源,并且至少设置以下值:- 将
id
属性设置为在第 2 步中获取的播放列表项 ID。 - 将
snippet.playlistId
属性设置为第 1 步中获取的播放列表 ID。 - 将
snippet.resourceId.kind
属性设置为youtube#video
。 - 将
snippet.resourceId.videoId
属性设置为用于唯一标识播放列表中包含的视频的视频 ID。 - 将
snippet.position
属性设置为0
或您希望项显示的任意位置(使用从 0 开始的索引)。
以下 API 请求会将播放列表项更新为播放列表中的第一个项。请求正文如下:
{ "id": "PLAYLIST_ITEM_ID", "snippet": { "playlistId": "PLAYLIST_ID", "resourceId": { "kind": "youtube#video", "videoId": "VIDEO_ID" }, "position": 0 } }
如需在 API Explorer 中完成请求,您需要为
id
、snippet.playlistId
和snippet.resourceId.videoId
属性设置值。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update? part=snippet
- 将
更新播放列表图片
您可以使用 v3 API 的 playlistImages.update
方法更新播放列表的缩略图。在请求中,playlistId
参数的值用于标识要使用缩略图的播放列表。
您无法使用 API Explorer 测试此查询,因为 API Explorer 不支持上传媒体文件,而这是此方法的要求。
移除播放列表项
此示例会从播放列表中删除视频。此请求必须使用 OAuth 2.0 授权。此示例包含三个步骤。前两个步骤与上例中更新播放列表项的步骤相同。
完成这些步骤后,调用 playlistItems.delete
方法即可从播放列表中移除视频。将请求的 id
参数设置为要移除的项的播放列表项 ID。此请求必须使用 OAuth 2.0 授权。
请注意,用于标识播放列表中视频的播放列表项 ID 不同于用于唯一标识视频的 YouTube 视频 ID。播放列表项 ID 用于将视频标识为特定播放列表中的项。
如需在 APIs Explorer 中完成请求,您需要设置 id
属性的值。
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete? id=PLAYLIST_ITEM_ID
移除播放列表图片
此示例会删除播放列表图片。该示例包含两个步骤:
-
第 1 步:检索播放列表
调用
playlists.list
方法可检索当前已验证用户频道中的播放列表。上面用于检索当前用户的播放列表的示例请求演示了此请求。调用该 API 的应用可以处理 API 响应,以使用每个播放列表的 ID 作为键来显示播放列表列表。 -
第 2 步:检索播放列表图片 ID
调用
playlistImages.list
方法可检索播放列表的缩略图图片。使用您要更改的播放列表的播放列表 ID。 -
第 3 步:删除播放列表图片
调用
playlistImages.delete
方法可删除特定播放列表图片。在请求中,id
参数用于指定要删除的播放列表图片的 ID。此方法需要有效的 OAuth 2.0 授权令牌。如果您要在 API Explorer 中测试此查询,则需要将id
参数值替换为有效的播放列表 ID。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete? id=ID
注意:如果您要在 API Explorer 中测试此查询,则需要将
id
参数值替换为有效的播放列表图片 ID。
移除播放列表
此示例删除了播放列表。该示例包含两个步骤:
-
第 1 步:检索播放列表 ID
调用
playlists.list
方法可检索当前已验证用户频道中的播放列表。上面用于检索当前用户的播放列表的示例请求演示了此请求。调用该 API 的应用可以处理 API 响应,以使用每个播放列表的 ID 作为键来显示播放列表列表。 -
第 2 步:删除播放列表
调用
playlists.delete
方法可删除特定播放列表。在请求中,id
参数用于指定要删除的播放列表的播放列表 ID。此方法需要有效的 OAuth 2.0 授权令牌。如果您要在 API Explorer 中测试此查询,则需要将id
参数值替换为有效的播放列表 ID。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete? id=PLAYLIST_ID
注意:如果您要在 API Explorer 中测试此查询,则需要将
id
参数值替换为有效的播放列表 ID。如需获取播放列表 ID,我们建议您先运行上面显示的添加播放列表请求。从 API 响应中提取播放列表 ID,并将该值用于要删除的播放列表。