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 内容管理系统 (CMS) 用户。此参数适用于拥有和管理许多不同 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 请求尝试将播放列表项的位置设置为无效或不受支持的值。检查资源 snippet 中的 position 属性的值。
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 请求和响应。