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 リクエストはチャンネル所有者の承認を得る必要があります。