PlaylistItems: update

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

リクエスト

HTTP リクエスト

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

承認

このリクエストは、最低でも以下のスコープの 1 つによって承認される必要があります(認証と承認の詳細については、こちらをご覧ください)。

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

パラメータ

下記の表は、このクエリでサポートされているパラメータの一覧です。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
この操作では、part パラメータは 2 つの目的で使用されます。書き込み操作で設定されるプロパティの特定と API レスポンスに含まれるプロパティの特定です。

このパラメータに指定できる part 名は snippetcontentDetailsstatus です。

このメソッドは、パラメータの値で指定された任意のパーツに含まれる変更可能なプロパティすべての既存の値よりも優先されますので、ご注意ください。たとえば、再生リスト アイテムでは開始時間と終了時間を指定できますが、これはユーザーがこの再生リストの動画を視聴しているときに再生する動画の時間帯を表します。このような値の設定された再生リスト アイテムをリクエストによって更新する場合、リクエストの part パラメータ値に contentDetails パーツが含まれていると、この再生リストの開始時間と終了時間は、リクエストの本文でどのような値が指定されていても、その値に更新されます。リクエストの本文に値が指定されていない場合は、既存の開始時間と終了時間が削除され、デフォルト設定で置き換えられます。

リクエストの本文

リクエストの本文には playlistItem リソースを指定します。 このリソースでは、次の点に注意してください。

  • 以下のプロパティの値を指定する必要があります。

    • id
    • snippet.playlistId
    • snippet.resourceId

  • 以下のプロパティの値を設定することができます。

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

    更新リクエストを送信する場合、既に値が設定されているプロパティの値を指定していないと、そのプロパティの既存の値が削除されます。

レスポンス

成功すると、このメソッドは、レスポンスの本文で playlistItem リソースを返します。

エラー

次の表は、このメソッドを呼び出したときに API からレスポンスとして返される可能性のあるエラー メッセージの一覧です。詳細については、エラー メッセージのドキュメントを参照してください。

エラー タイプ エラーの詳細 説明
invalidValue invalidPlaylistItemPosition このリクエストは、再生リスト アイテムの位置に無効な値またはサポートされていない値を設定しようとしています。リソースの snippetposition プロパティの値を確認してください。
invalidValue invalidResourceType リソース ID に指定された type は、この操作ではサポートされていません。リソース ID は、再生リストに追加するアイテムを特定します(例: youtube#video)。
invalidValue invalidSnippet このリクエストでは、有効な snippet プロパティが指定されていません。
notFound playlistItemNotFound リクエストの id プロパティで特定される再生リスト アイテムが見つかりません。
notFound playlistNotFound リクエストの playlistId パラメータで特定される再生リストが見つかりません。
required channelIdRequired リクエストには、必須プロパティ channelId の値が指定されていません。
required playlistIdRequired リクエストには、必須プロパティ playlistId の値が指定されていません。
required playlistItemIdRequired リクエストで指定された再生リスト アイテム リソースは、id プロパティを使用して、更新する再生リスト アイテムを特定する必要があります。

実際に試してみる

API Explorer を使用し、ライブ データに対してこのメソッドを呼び出して、API リクエストとレスポンスを確認してください。