Playlists: update

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

割り当ての影響:このメソッドを呼び出すと、割り当てコストは 50 単位になります。

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 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 レスポンスに含まれるプロパティを指定します。

このメソッドは、リクエスト本文で指定された任意の部分に含まれる可変プロパティの既存の値をオーバーライドします。たとえば、再生リストの説明は snippet 部分に含め、リクエスト本文に含める必要があります。リクエストで snippet.description プロパティに値が指定されていない場合、プレイリストの既存の説明が削除されます。

次のリストに、パラメータ値に含めることができる part の名前を示します。
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
オプション パラメータ
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、パラメータ値で指定されたコンテンツ所有者に代わって行動する YouTube CMS ユーザーを識別するリクエストの認証情報です。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。

リクエスト本文

リクエストの本文にプレイリスト リソースを指定します。対象リソース:

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

    • id
    • snippet.title

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

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

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

レスポンス

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

エラー

次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
badRequest (400) defaultLanguageNotSetError localizations を更新するには、defaultLanguage を設定する必要があります。
badRequest (400) localizationValidationError ローカライズ オブジェクトの値のいずれかが検証で不合格でした。playlists.list メソッドを使用して有効な値を取得し、playlists リソース ドキュメントのガイドラインに沿って更新します。
forbidden (403) playlistForbidden この操作は禁止されているか、リクエストが正しく承認されていません。
invalidValue (400) invalidPlaylistSnippet リクエストに指定されている再生リスト スニペットは無効です。
notFound (404) playlistNotFound リクエストの id パラメータで識別されるプレイリストが見つかりません。
required (400) playlistTitleRequired リクエストでは、再生リストのタイトルを指定する必要があります。
invalidValue (400) playlistOperationUnsupported API は、指定したプレイリストを更新する機能をサポートしていません。たとえば、アップロードした動画再生リストのプロパティを更新することはできません。

実習

APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。