PlaylistItems: update

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

割り当てへの影響: このメソッドの呼び出しにより、50 ユニットの割り当てコストが発生します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

認可

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

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

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

このパラメータは、さまざまな YouTube チャンネルを所有および管理している YouTube コンテンツ パートナー向けに設計されています。コンテンツ所有者に所属するユーザーは、一度認証すれば、チャンネルごとに認証情報を提示しなくても、コンテンツ所有者の動画およびチャンネルのすべてのデータにアクセスして管理できるようになります。

このパラメータが存在する場合、その値はコンテンツ所有者を識別し、リクエストの承認認証情報はそのコンテンツ所有者の代理権限がある YouTube ユーザーを識別します。ユーザーが認証に使用するアカウントは、YouTube クリエイター ツールの設定で指定したコンテンツ所有者にリンクされている必要があります。

リクエスト本文

リクエストの本文には playlistItem リソースを指定します。このリソースについて:

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

    • id
    • snippet.playlistId
    • snippet.resourceId

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

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

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

レスポンス

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

エラー

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

エラーのタイプ エラーの詳細 説明
forbidden (403) playlistItemsNotAccessible リクエストは適切に承認されていないため、指定された再生リスト アイテムを更新できません。
invalidValue (400) invalidPlaylistItemPosition このリクエストは、再生リスト アイテムの位置に無効な値またはサポートされていない値を設定しようとしています。リソースの snippet にある position プロパティの値を確認します。
invalidValue (400) invalidResourceType リソース ID に指定された type は、このオペレーションではサポートされていません。リソース ID は再生リストに追加されるアイテムを識別します（例: youtube#video）。
invalidValue (400) invalidSnippet リクエストに有効な snippet プロパティが指定されていません。
invalidValue (400) manualSortRequired リクエストで再生リストのアイテムの位置を設定しようとしましたが、再生リストの並べ替えが手動で行われていません。（たとえば、再生リストのアイテムは日付や人気度で並べ替えることができます）。このエラーに対処するには、リクエストが挿入するリソースから snippet.position 要素を削除します。再生リストのアイテムを特定の位置に配置するには、まず再生リストの設定で [順序] オプションを [手動] に更新する必要があります。この設定は YouTube の [動画の管理] で調整できます。
notFound (404) playlistItemNotFound リクエストの id プロパティで識別される再生リストのアイテムが見つかりません。
notFound (404) playlistNotFound リクエストの playlistId パラメータで特定される再生リストが見つかりません。
required (400) channelIdRequired 必須プロパティ channelId の値がリクエストに指定されていません。
required (400) playlistIdRequired 必須プロパティ playlistId の値がリクエストに指定されていません。
required (400) playlistItemIdRequired リクエストで指定された再生リスト アイテム リソースは、id プロパティを使用して、更新する再生リスト アイテムを識別する必要があります。
invalidValue (400) playlistOperationUnsupported この API では、指定された再生リスト内の動画を更新する機能はサポートされていません。たとえば、アップロードした動画の再生リスト内の動画は更新できません。

試してみよう:

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