PlaylistItems: update

再生リストのアイテムを変更します。たとえば、再生リスト内のアイテムの位置を更新できます。

割り当てへの影響: このメソッドの呼び出しには、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 名が含まれています。
  • contentDetails
  • id
  • snippet
  • status
オプション パラメータ
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 リクエストとレスポンスを確認します。