PlaylistItems: update

修改播放列表项。例如，您可以更新内容在播放列表中的位置。

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

常见使用场景

请求

HTTP 请求

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

授权

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

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

参数

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

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

请注意，如果参数值指定的任意部分包含，此方法将覆盖所有可变属性的现有值。例如，播放列表项可以指定开始时间和结束时间，以标识当用户观看播放列表中的视频时，视频的播放时间部分。如果您的请求正在更新设置了这些值的播放列表项，并且请求的 part 参数值包含 contentDetails 部分，则播放列表项的开始和结束时间将更新为请求正文指定的任何值。如果请求正文未指定值，则系统会移除现有的开始时间和结束时间，并将其替换为默认设置。

以下列表包含可包含在参数值中的 part 名称：
  • contentDetails
  • id
  • snippet
  • status
可选参数
onBehalfOfContentOwner string
注意：onBehalfOfContentOwner 参数专供 YouTube 内容合作伙伴使用，并且只能在适当授权的请求中使用。

此参数适用于拥有和管理众多不同 YouTube 频道的 YouTube 内容合作伙伴。它可让与内容所有者相关联的用户仅通过一次身份验证，之后便可访问和管理内容所有者的所有视频和频道数据，而无需分别为每个频道提供身份验证凭据。

如果存在该参数，它的值即代表内容所有者，而请求的授权凭据将标识已获得授权可代表该内容所有者行事的 YouTube 用户。用户用于进行身份验证的帐号必须在 YouTube 创作者工作室设置中与指定的内容所有者相关联。

请求正文

在请求正文中提供 playlistItem 资源。 针对该资源：

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

    • id
    • snippet.playlistId
    • snippet.resourceId

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

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

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

响应

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

错误

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

错误类型 错误详情 说明
forbidden (403) playlistItemsNotAccessible 该请求未获得适当的授权，无法更新指定的播放列表项。
invalidValue (400) invalidPlaylistItemPosition 该请求试图将播放列表项的位置设置为无效或不受支持的值。请检查资源的 snippet 中 position 属性的值。
invalidValue (400) invalidResourceType 不支持为资源 ID 指定的 type 执行此操作。资源 ID 用于标识要添加到播放列表的项目，例如 youtube#video。
invalidValue (400) invalidSnippet 请求未指定有效的 snippet 属性。
invalidValue (400) manualSortRequired 该请求尝试设置播放列表项的位置，但播放列表未使用手动排序。（例如，播放列表项可以按日期或热门程度排序）。您可以通过从请求插入的资源中移除 snippet.position 元素来解决该错误。如果您希望播放列表项在列表中具有特定位置，需要先在播放列表设置中将播放列表的排序选项更新为手动。你可以在 YouTube 视频管理器中调整此设置。
notFound (404) playlistItemNotFound 无法找到通过请求的 id 属性标识的播放列表项。
notFound (404) playlistNotFound 找不到使用该请求的 playlistId 参数标识的播放列表。
required (400) channelIdRequired 请求没有为必需的 channelId 属性指定值。
required (400) playlistIdRequired 请求没有为必需的 playlistId 属性指定值。
required (400) playlistItemIdRequired 请求中指定的播放列表项资源必须使用 id 属性来标识要更新的播放列表项。
invalidValue (400) playlistOperationUnsupported 该 API 不支持更新指定播放列表中的视频。例如，您无法更新已上传视频播放列表中的视频。

试试看！

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