Playlists: update

修改播放列表。例如，您可以更改播放列表的标题、说明或隐私状态。

配额影响：对此方法的调用会产生 50 个单位的配额费用。

常见使用场景

请求

HTTP 请求

PUT https://www.googleapis.com/youtube/v3/playlists

授权

此请求需要获得以下至少一个范围的授权。如需详细了解身份验证和授权，请参阅实现 OAuth 2.0 授权。

范围
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

参数

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
part string
在本操作中，part 参数有两个用途。它用于标识写入操作将设置的属性，以及 API 响应将包含的属性。

请注意，此方法会替换请求正文中指定的任何部分中包含的可变属性的现有值。例如，播放列表的说明包含在 snippet 部分中，该部分必须包含在请求正文中。如果请求未为 snippet.description 属性指定值，系统会删除播放列表的现有说明。

以下列表包含您可以在参数值中添加的 part 名称：
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
可选参数
onBehalfOfContentOwner string
此参数只能在经过适当授权的请求中使用。

注意：此参数仅供 YouTube 内容合作伙伴使用。

onBehalfOfContentOwner 参数表示请求的授权凭据标识了代表参数值中指定的内容所有者行事的 YouTube CMS 用户。此参数适用于拥有和管理许多不同 YouTube 频道的 YouTube 内容合作伙伴。借助此功能，内容所有者只需进行一次身份验证，即可访问其所有视频和频道数据，而无需为每个频道分别提供身份验证凭据。用户进行身份验证时使用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。

请求正文

在请求正文中提供 playlist 资源。

对于该资源：

  • 您必须为以下属性指定值：

    • id
    • snippet.title

  • 您可以为以下属性设置值：

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • status.podcastStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

    如果您提交更新请求，并且您的请求未为已具有值的媒体资源指定值，则系统会删除该媒体资源的现有值。

响应

如果成功，此方法将在响应正文中返回 playlist 资源。

错误

下表列出了该 API 在响应对此方法的调用时可能会返回的错误消息。如需了解详情，请参阅 YouTube Data API - 错误。

错误类型 错误详情 说明
badRequest (400) defaultLanguageNotSetError 必须设置 defaultLanguage 以更新 localizations。
badRequest (400) localizationValidationError 本地化对象中的某个值未通过验证。使用 playlists.list 方法检索有效值，并确保按照播放列表资源文档中的准则更新这些值。
forbidden (403) playlistForbidden 此操作已被禁止，或者请求未获得适当授权。
invalidValue (400) invalidPlaylistSnippet 请求提供的播放列表摘要无效。
notFound (404) playlistNotFound 找不到使用请求的 id 参数标识的播放列表。
required (400) playlistTitleRequired 请求必须指定播放列表标题。
invalidValue (400) playlistOperationUnsupported 该 API 不支持更新指定播放列表。例如，您无法更新上传的视频播放列表的属性。

试试看！

使用 APIs Explorer 调用此 API，并查看 API 请求和响应。