PlaylistItems: insert

再生リストにリソースを追加します。

割り当てへの影響: このメソッドを呼び出すと、50 ユニットの割り当てコストが発生します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

スコープ
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

パラメータ

次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
このオペレーションでは、part パラメータには 2 つの目的があります。書き込みオペレーションで設定するプロパティと、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 リクエストとレスポンスを確認します。