再生リストにリソースを追加します。
割り当ての影響: このメソッドを呼び出すと、割り当てコストは 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 名を示します。
|
|
オプション パラメータ | ||
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 のリクエストとレスポンスを確認します。