PlaylistItems: insert

将资源添加到播放列表中。

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

常见使用场景

请求

HTTP 请求

POST 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
  • id
  • snippet
  • status
可选参数
onBehalfOfContentOwner string
此参数只能在正确授权的请求中使用。注意:此参数仅适用于 YouTube 内容合作伙伴。

onBehalfOfContentOwner 参数用于指明该请求的授权凭据会标识代表参数值中指定的内容所有者执行操作的 YouTube 内容管理系统用户。此参数适用于拥有和管理众多不同 YouTube 频道的 YouTube 内容合作伙伴。它可让内容所有者在一次身份验证后获得访问其所有视频和频道数据的权限,而无需为每个频道提供身份验证凭据。用户进行身份验证时所用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。

请求正文

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

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

    • snippet.playlistId
    • snippet.resourceId

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

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

响应

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

错误

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

错误类型 错误详情 说明
forbidden (403) playlistContainsMaximumNumberOfVideos 播放列表包含的项目数量已达上限。
forbidden (403) playlistItemsNotAccessible 该请求未获得适当的授权,无法插入指定的播放列表项。
invalidValue (400) invalidContentDetails 请求中的 contentDetails 属性无效。可能的原因是 contentDetails.note 字段长度超过了 280 个字符。
invalidValue (400) invalidPlaylistItemPosition 该请求试图将播放列表项的位置设置为无效或不受支持的值。请检查资源的 snippetposition 属性的值。
invalidValue (400) invalidResourceType 不支持为资源 ID 指定的 type 执行此操作。资源 ID 用于标识要添加到播放列表的项目,例如 youtube#video
invalidValue (400) manualSortRequired 该请求尝试设置播放列表项的位置,但播放列表未使用手动排序。(例如,播放列表项可以按日期或热门程度排序)。您可以通过从请求插入的资源中移除 snippet.position 元素来解决该错误。如果您希望播放列表项在列表中具有特定位置,需要先在播放列表设置中将播放列表的排序选项更新为手动。你可以在 YouTube 视频管理器中调整此设置。
invalidValue (400) videoAlreadyInAnotherSeriesPlaylist 你尝试添加到该播放列表的视频已在另一系列播放列表中。
notFound (404) playlistNotFound 找不到使用该请求的 playlistId 参数标识的播放列表。
notFound (404) videoNotFound 找不到你尝试添加到播放列表的视频。检查 videoId 属性的值,确保其正确无误。
required (400) channelIdRequired 请求没有为必需的 channelId 属性指定值。
required (400) playlistIdRequired 请求没有为必需的 playlistId 属性指定值。
required (400) resourceIdRequired 请求必须包含一个 snippet 对象指定 resourceId 的资源。
invalidValue (400) playlistOperationUnsupported 该 API 不支持将视频插入指定的播放列表。例如,您无法将视频插入已上传视频的播放列表中。

试试看!

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