API リファレンス

この API リファレンスでは、YouTube Live Streaming API を使用して YouTube でライブ配信と動画ストリーミングをスケジュールする方法について説明します。

リソースタイプ

LiveBroadcasts

liveBroadcast リソースは、YouTube でライブ動画を介してストリーミングされるイベントを表します。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/youtube/v3 を基準とする URI
bind POST /liveBroadcasts/bind YouTube ブロードキャストをストリームにバインドするか、ブロードキャストとストリーム間の既存のバインドを削除します。ブロードキャストには 1 つの動画ストリームのみをバインドできますが、動画ストリームは複数のブロードキャストにバインドできます。
delete DELETE /liveBroadcasts ブロードキャストを削除します。
insert POST /liveBroadcasts ブロードキャストを作成します。
list GET /liveBroadcasts API リクエスト パラメータに一致する YouTube ライブ配信のリストを返します。
transition POST /liveBroadcasts/transition YouTube ライブ配信のステータスを変更し、新しいステータスに関連するプロセスを開始します。たとえば、ブロードキャストのステータスを testing に変更すると、YouTube はブロードキャストのモニター ストリームに動画の送信を開始します。このメソッドを呼び出す前に、ブロードキャスト バインド ストリームの status.streamStatus プロパティの値が active であることを確認する必要があります。
update PUT /liveBroadcasts ブロードキャストを更新します。たとえば、liveBroadcast リソースの contentDetails オブジェクトで定義されているブロードキャスト設定を変更できます。
cuepoint POST /liveBroadcasts/cuepoint ライブ配信にキューポイントを挿入します。キューポイントによってミッドロール挿入点がトリガーされる可能性があります。

LiveChatBans

liveChatBan リソースは、YouTube ユーザーと、そのユーザーが参加を禁止されている YouTube ライブチャットを識別します。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/youtube/v3 を基準とする URI
delete DELETE /liveChat/bans 特定のユーザーがチャットに投稿できないようにする禁止を解除し、そのユーザーがチャットに参加できるようにします。API リクエストは、チャンネル所有者または禁止に関連するチャットのモデレーターによって承認されている必要があります。
insert POST /liveChat/bans 特定のユーザーがチャットに参加できないようにします。API リクエストは、チャンネル所有者または禁止に関連するチャットのモデレーターによって承認されている必要があります。

LiveChatMessages

liveChatMessage リソースは、YouTube ライブチャットのチャット メッセージを表します。このリソースには、新しく投稿されたテキスト メッセージやファンディング イベントなど、複数の種類のメッセージに関する詳細情報が含まれます。

チャット機能はライブ配信でデフォルトで有効になっており、ライブイベントがアクティブな間は使用できます。（イベント終了後は、そのイベントのライブ チャットはご利用いただけなくなります）。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/youtube/v3 を基準とする URI
delete DELETE /liveChat/messages チャット メッセージを削除します。API リクエストは、チャンネル所有者または禁止に関連するチャットのモデレーターによって承認されている必要があります。
insert POST /liveChat/messages チャットにメッセージを追加します。
list GET /liveChat/messages 特定のチャットのチャット メッセージを一覧表示します。

LiveChatModerators

liveChatModerator リソースは、YouTube ライブチャットのモデレーターを表します。チャット モデレーターは、チャットからユーザーをブロックまたはブロック解除したり、メッセージを削除したり、チャットに関するその他の管理操作を行ったりできます。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/youtube/v3 を基準とする URI
delete DELETE /liveChat/moderators チャット モデレーターを削除します。リクエストは、ライブ配信のチャンネルの所有者によって承認されている必要があります。
insert POST /liveChat/moderators チャットに新しいモデレーターを追加します。リクエストは、ライブ配信のチャンネルの所有者によって承認されている必要があります。
list GET /liveChat/moderators チャットのモデレーターを一覧表示します。リクエストは、ライブ配信のチャンネルの所有者によって承認されている必要があります。

LiveStreams

liveStream リソースには、YouTube に送信する動画ストリームに関する情報が含まれます。ストリームは、YouTube ユーザーにブロードキャストされるコンテンツを提供します。作成した liveStream リソースは、1 つ以上の liveBroadcast リソースにバインドできます。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/youtube/v3 を基準とする URI
delete DELETE /liveStreams 動画ストリームを削除します。
insert POST /liveStreams 動画ストリームを作成します。ストリーミングを使用すると、動画を YouTube に送信して、視聴者に動画をブロードキャストできます。
list GET /liveStreams API リクエスト パラメータに一致する動画ストリームのリストを返します。
update PUT /liveStreams 動画ストリームを更新します。変更するプロパティを更新できない場合は、適切な設定で新しいストリームを作成する必要があります。

SuperChatEvents

superChatEvent リソースは、YouTube ライブ配信中にファンが購入した Super Chat メッセージを表します。YouTube のチャット ストリームでは、Super Chat が他のメッセージより目立つ理由は 2 つあります。

  • Super Chat は色付きでハイライト表示されます。
  • Super Chat は、一定時間ティッカー内に固定表示されます。

Super Chat の色、ティッカーに固定される時間、メッセージの最大長はすべて、購入金額によって決まります。Super Chat について詳しくは、YouTube ヘルプセンターをご覧ください。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/youtube/v3 を基準とする URI
list GET /superChatEvents 過去 30 日間のチャンネルのライブ配信の Super Chat イベントを一覧表示します。

サポートが終了したリソースタイプ

FanFundingEvents

fanFundingEvent リソースは、YouTube チャンネルの視聴者ファンディング イベントを表します。視聴者ファンディングは、YouTube クリエイターを金銭的にサポートする方法です。ファンディング イベントは、ユーザーがチャンネルに 1 回限りの任意の支払いを行うときに発生します。ファンディングについて詳しくは、YouTube ヘルプセンターをご覧ください。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/youtube/v3 を基準とする URI
list GET /fanFundingEvents チャンネルの視聴者ファンディング イベントを一覧表示します。API リクエストはチャンネル所有者によって承認されている必要があります。

LiveCuepoints

liveCuepoint リソースは、ブロードキャスト動画ストリームでミッドロール挿入点を開始します。

注: キューポイントを制御する API コマンドは、実際には YouTube Content ID API の一部であり、liveBroadcast リソースと liveStream リソースを管理するリクエストとは異なる認可要件があります。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/ を基準とする URI
insert POST /liveCuepoints ライブ配信にキューポイントを挿入します。現在、このメソッドへのリクエストは、YouTube コンテンツ所有者に関連付けられているアカウントによって承認される必要があります。

スポンサー

sponsor リソースは、YouTube チャンネルのスポンサーを表します。スポンサーは、定期的な金銭的支援（定期購入やメンバーシップ料金など）をクリエイターに提供し、特別な特典を受け取ります。たとえば、クリエイターがチャットのスポンサー限定モードをオンにすると、スポンサーはチャットに参加できるようになります。

このリソースの詳細については、リソース表現およびプロパティ一覧をご覧ください。

メソッド HTTP リクエスト 説明
https://www.googleapis.com/youtube/v3 を基準とする URI
list GET /sponsors チャンネルのスポンサーを一覧表示します。API リクエストはチャンネル所有者によって承認されている必要があります。