Playlists: update

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

割り当てへの影響: このメソッドの呼び出しでは、50 ユニットの割り当て費用が発生します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。認証と承認の詳細については、OAuth 2.0 承認の実装をご覧ください。

範囲
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 コンテンツ所有者にリンクされていなければなりません。

リクエスト本文

リクエスト本文に playlist リソースを指定します。

そのリソースの場合:

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

    • id
    • snippet.title

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

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

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

レスポンス

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

エラー

次の表に、このメソッドの呼び出しに対する応答として API から返される可能性のあるエラー メッセージを示します。詳細については、YouTube Data API - エラーをご覧ください。

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

試してみよう:

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