实现：播放列表

以下示例展示了如何使用 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

检索用户的播放列表

此示例检索了由特定频道创建的播放列表。该示例包含两个步骤：

检索特定播放列表的相关信息

如需检索一个或多个特定播放列表的相关信息，请调用 playlists.list 方法，并将 id 参数设为以英文逗号分隔的 YouTube 播放列表 ID 列表，这些 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 资源：

    以下 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 可将视频标识为特定播放列表中的项目。

如需在 API 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，然后将该值用于要删除的播放列表。