Playlists: update

再生リストを変更します。たとえば、再生リストのタイトル、説明、公開ステータスを変更できます。 今すぐ試す

リクエスト

HTTP リクエスト

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

承認

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

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

パラメータ

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

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

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

このメソッドは、パラメータの値で指定された任意のパーツに含まれる変更可能なプロパティすべての既存の値よりも優先されますので、ご注意ください。たとえば、再生リストのプライバシー設定は、status パーツに含まれています。このため、リクエストが非公開の再生リストを更新しているときに、リクエストの part パラメータ値に status パーツが含まれている場合、再生リストのプライバシー設定はリクエストの本文で指定された値にかかわらず、その値に更新されます。リクエストの本文で値が指定されていない場合、既存のプライバシー設定が削除され、再生リストはデフォルトのプライバシー設定に戻されます。

リクエストの本文

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

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

    • id
    • snippet.title

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

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • snippet.tags[]

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

レスポンス

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

エラー

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

エラー タイプ エラーの詳細 説明
invalidValue invalidPlaylistSnippet リクエストに指定されている再生リスト スニペットは無効です。
notFound playlistNotFound リクエストの id パラメータで特定される再生リストが見つかりません。
required playlistTitleRequired リクエストでは、再生リストのタイトルを指定する必要があります。

実際に試してみる

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