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
    • status.podcastStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

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

レスポンス

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

エラー

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

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

試してみよう:

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