再生リストのアイテムを変更します。たとえば、再生リスト内のアイテムの位置を更新できます。
割り当ての影響: このメソッドを呼び出すと、割り当てコストは 50 単位になります。
一般的なユースケース
リクエスト
HTTP リクエスト
PUT 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 の部分が含まれている場合、再生リストの開始時間と終了時間は、リクエスト本文で指定された任意の値に更新されます。リクエストの本文で値が指定されていない場合は、既存の開始時間と終了時間が削除され、デフォルト設定に置き換えられます。次のリストには、パラメータ値に指定できる part 名が含まれています。
|
|
オプション パラメータ | ||
onBehalfOfContentOwner |
string 注: onBehalfOfContentOwner パラメータは YouTube コンテンツ パートナー専用であり、適切に承認されたリクエストでのみ使用できます。このパラメータは、さまざまな YouTube チャンネルを所有し、管理している YouTube コンテンツ パートナーを対象としています。この方法により、コンテンツ所有者は、認証された後のコンテンツ所有者と動画のデータすべてにアクセスして管理できるようになります。個別のチャンネルごとに認証情報を提供する必要はありません。 このパラメータが指定されている場合は、その値の所有者がコンテンツ所有者を識別し、リクエストの承認認証情報によってコンテンツ所有者の正式な代理人である YouTube ユーザーが識別されます。ユーザーが認証するアカウントは、YouTube クリエイター ツールの設定で指定したコンテンツ所有者にリンクしている必要があります。 |
リクエスト本文
リクエストの本文に playlistItem リソースを指定します。 対象リソース:
-
以下のプロパティの値を指定する必要があります。
id
snippet.playlistId
snippet.resourceId
-
以下のプロパティの値を指定することができます。
snippet.position
contentDetails.note
contentDetails.startAt
contentDetails.endAt
更新リクエストを送信する場合、既に値が設定されているプロパティの値を指定していないと、そのプロパティの既存の値が削除されます。
レスポンス
成功すると、このメソッドは、レスポンスの本文で playlistItem リソースを返します。
エラー
次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。
エラーのタイプ | エラーの詳細 | 説明 |
---|---|---|
forbidden (403) |
playlistItemsNotAccessible |
指定されたプレイリスト アイテムを更新する権限が、リクエストに正しくありません。 |
invalidValue (400) |
invalidPlaylistItemPosition |
このリクエストは、再生リスト アイテムの位置に無効な値またはサポートされていない値を設定しようとしています。リソースの snippet の position プロパティの値を確認します。 |
invalidValue (400) |
invalidResourceType |
リソース ID に指定された type は、このオペレーションではサポートされていません。リソース ID は再生リストに追加されるアイテムを識別します(例: youtube#video )。 |
invalidValue (400) |
invalidSnippet |
リクエストに有効な snippet プロパティが指定されていない。 |
invalidValue (400) |
manualSortRequired |
リクエストはプレイリスト アイテムの位置を設定しようとしますが、プレイリストは手動並べ替えを使用しません。(プレイリストの項目は日付や人気順で並べ替えられる場合があります)。このエラーを解決するには、リクエストによって挿入されたリソースから snippet.position 要素を削除します。再生リストの項目をリストの特定の位置に掲載するには、再生リストの設定で [順序] オプションを [手動] に更新する必要があります。この設定は YouTube の [動画の管理] で調整できます。 |
notFound (404) |
playlistItemNotFound |
リクエストの id プロパティで識別されるプレイリスト アイテムが見つかりません。 |
notFound (404) |
playlistNotFound |
リクエストの playlistId パラメータで識別されるプレイリストが見つかりません。 |
required (400) |
channelIdRequired |
リクエストで、必須の channelId プロパティの値が指定されていません。 |
required (400) |
playlistIdRequired |
リクエストで、必須の playlistId プロパティの値が指定されていません。 |
required (400) |
playlistItemIdRequired |
リクエストで指定されたプレイリスト アイテムのリソースは、id プロパティを使用して、更新するプレイリスト アイテムを特定する必要があります。 |
invalidValue (400) |
playlistOperationUnsupported |
この API は、指定した再生リスト内の動画を更新する機能をサポートしていません。たとえば、アップロード済みの動画の再生リストにある動画を更新することはできません。 |
実習
APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。