Playlists: update

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

对配额的影响:调用此方法会产生 50 个单元的配额费用

常见使用场景

请求

HTTP 请求

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

授权

此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。

范围
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 内容管理系统用户。此参数适用于拥有和管理众多不同 YouTube 频道的 YouTube 内容合作伙伴。它可让内容所有者在一次身份验证后获得访问其所有视频和频道数据的权限,而无需为每个频道提供身份验证凭据。用户进行身份验证时所用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。

请求正文

在请求正文中提供播放列表资源。 针对该资源:

  • 您必须为以下属性指定一个值:

    • id
    • snippet.title

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

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

    如果您要提交更新请求,但您的请求没有为已经包含某个值的属性值指定值,则该属性的现有值将被删除。

响应

如果成功,此方法将在响应正文中返回一个播放列表资源

错误

下表列出了 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 请求和响应。