API リファレンス

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

リソースタイプ

ライブ配信

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

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

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

チャット バン

liveChatBan リソースは、YouTube ユーザーと、ユーザーの参加が禁止されている YouTube チャットを特定します。

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

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

チャット メッセージ

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

チャット機能はデフォルトで有効になっており、ライブイベントが有効になっている間利用できます。（イベントが終了すると、チャットでそのチャットは利用できなくなります）。

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

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

チャット モデレーター

liveChatModerator リソースは、YouTube チャットのモデレーターを表します。チャット モデレーターは、チャットに対するユーザーの参加禁止または停止解除、メッセージの削除、その他の管理操作を行うことができます。

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

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

ライブ配信

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 動画ストリームを更新します。変更するプロパティを更新できない場合は、適切な設定で新しいストリームを作成する必要があります。

スポンサー

sponsor リソースは、YouTube チャンネルのスポンサーを表します。スポンサーは、定期購入やメンバーシップ料金など、クリエイターに継続的に金銭的なサポートを提供し、特別な特典を利用します。たとえば、チャットのスポンサー専用モードをオンにすると、スポンサーはチャットできるようになります。

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

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

スーパー イベント

superChatEvent リソースは、YouTube ライブ配信中にファンが購入した Super Chat メッセージを表します。YouTube チャット ストリームでは、次の 2 つの方法で Super Chat を目立たせることができます。

  • Super Chat は色でハイライト表示されます。
  • Super Chat はティッカーに固定期間表示されます。

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

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

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

非推奨のリソースタイプ

ファン ファンディング イベント

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

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

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