この 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 |
特定のチャットのチャット メッセージの一覧を取得します。 |
streamList |
特定のチャットのチャット メッセージを低遅延で受信するためのサーバー ストリーミング接続を有効にします。 | |
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 リクエストはチャンネル所有者によって承認される必要があります。 |