再生リストにリソースを追加します。
割り当てへの影響: このメソッドの呼び出しにより、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 のリクエストとレスポンスを確認します。