API-Referenz

In dieser API-Referenz wird beschrieben, wie du mit der YouTube Live Streaming API Livestreams und Videostreams auf YouTube planen kannst.

Ressourcentypen

LiveBroadcasts

Eine liveBroadcast-Ressource steht für eine Veranstaltung, die per Livestream auf YouTube übertragen wird.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind Verknüpft eine YouTube-Übertragung mit einem Stream oder entfernt eine vorhandene Verknüpfung zwischen einer Übertragung und einem Stream. Eine Übertragung kann nur mit einem Videostream verknüpft sein. Ein Videostream kann jedoch mit mehreren Übertragungen verknüpft sein.
delete DELETE /liveBroadcasts Löscht eine Übertragung.
insert POST /liveBroadcasts Erstellt eine Übertragung.
list GET /liveBroadcasts Gibt eine Liste von YouTube-Übertragungen zurück, die den API-Anfrageparametern entsprechen.
transition POST /liveBroadcasts/transition Ändert den Status einer YouTube-Liveübertragung und initiiert alle mit dem neuen Status verbundenen Prozesse. Wenn du den Status einer Übertragung beispielsweise auf testing umstellst, beginnt YouTube, Video an den Monitorstream dieser Übertragung zu übertragen. Bevor du diese Methode aufrufst, solltest du prüfen, ob der Wert der Property status.streamStatus für den Stream, der mit deiner Übertragung verknüpft ist, active ist.
update PUT /liveBroadcasts Aktualisiert eine Übertragung. Sie können beispielsweise die Übertragungseinstellungen ändern, die im contentDetails-Objekt der liveBroadcast-Ressource definiert sind.
cuepoint POST /liveBroadcasts/cuepoint Ein Cue-Punkt wird in eine Liveübertragung eingefügt. Der Cue-Punkt kann eine Werbeunterbrechung auslösen.

LiveChatBans

Eine liveChatBan-Ressource identifiziert einen YouTube-Nutzer und einen YouTube-Livechat, an dem der Nutzer nicht teilnehmen darf.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans Hiermit wird eine Sperrung aufgehoben, die einen bestimmten Nutzer daran hindert, in einem Livechat mitzuwirken. Der Nutzer kann dann wieder am Chat teilnehmen. Die API-Anfrage muss vom Kanalinhaber oder einem Moderator des Livechats autorisiert werden, der mit der Sperrung verknüpft ist.
insert POST /liveChat/bans Ein bestimmter Nutzer wird vom Livechat ausgeschlossen. Die API-Anfrage muss vom Kanalinhaber oder einem Moderator des Livechats autorisiert werden, der mit der Sperrung verknüpft ist.

LiveChatMessages

Eine liveChatMessage-Ressource steht für eine Chatnachricht in einem YouTube-Livechat. Die Ressource kann Details zu verschiedenen Arten von Nachrichten enthalten, z. B. zu einer neu geposteten SMS oder zu einem Fan-Funding-Ereignis.

Die Livechat-Funktion ist für Livestreams standardmäßig aktiviert und verfügbar, solange die Live-Veranstaltung aktiv ist. Nach dem Ende der Veranstaltung ist der Livechat für diese Veranstaltung nicht mehr verfügbar.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages Löscht eine Chatnachricht. Die API-Anfrage muss vom Kanalinhaber oder einem Moderator des Livechats autorisiert werden, der mit der Sperrung verknüpft ist.
insert POST /liveChat/messages Fügt einem Livechat eine Nachricht hinzu.
list GET /liveChat/messages Hier werden die Nachrichten im Livechat für einen bestimmten Chat aufgelistet.

LiveChatModerators

Eine liveChatModerator-Ressource steht für einen Moderator eines YouTube-Livechats. Chatmoderatoren können Nutzer in einem Chat sperren oder die Sperrung aufheben, Nachrichten entfernen und andere administrative Aktionen für den Livechat ausführen.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators Entfernt einen Chatmoderator. Der Antrag muss vom Inhaber des Kanals der Livestreams genehmigt werden.
insert POST /liveChat/moderators Fügt dem Chat einen neuen Moderator hinzu. Der Antrag muss vom Inhaber des Kanals der Livestreams genehmigt werden.
list GET /liveChat/moderators Listet die Moderatoren für einen Livechat auf. Der Antrag muss vom Inhaber des Kanals der Livestreams genehmigt werden.

LiveStreams

Eine liveStream-Ressource enthält Informationen zum Videostream, den du an YouTube übermittelst. Der Stream enthält die Inhalte, die an YouTube-Nutzer gesendet werden. Nach dem Erstellen kann eine liveStream-Ressource einer oder mehreren liveBroadcast-Ressourcen zugeordnet werden.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams Löscht einen Videostream.
insert POST /liveStreams Erstellt einen Videostream. Über den Stream kannst du dein Video an YouTube senden, wo es dann für deine Zuschauer übertragen wird.
list GET /liveStreams Gibt eine Liste von Videostreams zurück, die den API-Anfrageparametern entsprechen.
update PUT /liveStreams Aktualisiert einen Videostream. Wenn die Eigenschaften, die Sie ändern möchten, nicht aktualisiert werden können, müssen Sie einen neuen Stream mit den richtigen Einstellungen erstellen.

SuperChatEvents

Eine superChatEvent-Ressource steht für eine Super Chat-Nachricht, die von einem Fan während eines YouTube-Livestreams gekauft wurde. Im YouTube-Livechat-Stream hebt sich ein Super Chat gleich doppelt von anderen Nachrichten ab:

  • Super Chats werden farblich hervorgehoben.
  • Super Chats bleiben für einen bestimmten Zeitraum im Ticker angepinnt.

Die Farbe des Super Chats, die Dauer, für die er im Ticker angepinnt bleibt, und die maximale Nachrichtenlänge werden vom Kaufbetrag bestimmt. Weitere Informationen zu Super Chats findest du in der YouTube-Hilfe.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/youtube/v3
list GET /superChatEvents Liste der Super Chat-Ereignisse aus den Livestreams eines Kanals in den letzten 30 Tagen.

Eingestellte Ressourcentypen

FanFundingEvents

Eine fanFundingEvent-Ressource steht für ein Fan-Funding-Ereignis auf einem YouTube-Kanal. Mit Fan-Funding können YouTube-Creator finanziell unterstützt werden. Ein Fan-Funding-Ereignis tritt auf, wenn ein Nutzer eine einmalige, freiwillige Zahlung an einen Kanal leistet. Weitere Informationen zu Fan-Funding findest du in der YouTube-Hilfe.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/youtube/v3
list GET /fanFundingEvents Listet Fan-Funding-Ereignisse für einen Kanal auf. Die API-Anfrage muss vom Kanalinhaber autorisiert werden.

LiveCuepoints

Mit einer liveCuepoint-Ressource wird eine Werbeunterbrechung im Videostream der Übertragung gestartet.

Hinweis:Der API-Befehl zum Steuern von Cuepoints ist Teil der YouTube Content ID API und unterliegt anderen Autorisierungsanforderungen als Anfragen zum Verwalten von liveBroadcast- und liveStream-Ressourcen.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/
insert POST /liveCuepoints Ein Cue-Punkt wird in eine Liveübertragung eingefügt. Derzeit müssen Anfragen für diese Methode von einem Konto autorisiert werden, das mit einem YouTube-Rechteinhaber verknüpft ist.

Sponsoren

Eine sponsor-Ressource stellt einen Sponsor für einen YouTube-Kanal dar. Ein Sponsor unterstützt einen Creator regelmäßig finanziell, z. B. durch eine Abo- oder Mitgliedschaftsgebühr, und erhält dafür besondere Vorteile. So können beispielsweise Unterstützer chatten, wenn der Creator den Modus „Nur-Unterstützer“ für einen Chat aktiviert.

Weitere Informationen zu dieser Ressource finden Sie in der Ressourcendarstellung und in der Liste der Properties.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/youtube/v3
list GET /sponsors Listet die Sponsoren eines Kanals auf. Die API-Anfrage muss vom Kanalinhaber autorisiert werden.