Dokumentacja API

W tym artykule znajdziesz informacje o tym, jak planować transmisje na żywo i transmisje w YouTube za pomocą interfejsu YouTube Live Streaming API.

Typy zasobów

Transmisje na żywo

Zasób liveBroadcast reprezentuje wydarzenie, które będzie transmitowane na żywo w YouTube.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind Łączy transmisję w YouTube z transmisją lub usuwa istniejące powiązanie między transmisją. Transmisja może być powiązana tylko z 1 strumieniem wideo, chociaż może być powiązana z więcej niż 1 strumieniem wideo.
delete DELETE /liveBroadcasts Usuwa transmisję.
insert POST /liveBroadcasts Tworzy transmisję.
list GET /liveBroadcasts Zwraca listę komunikatów YouTube, które pasują do parametrów żądania do interfejsu API.
transition POST /liveBroadcasts/transition Zmienia stan transmisji na żywo w YouTube i uruchamia procesy powiązane z nowym stanem. Gdy na przykład zmienisz stan transmisji na testing, YouTube zacznie przesyłać wideo do strumienia monitorowania tej transmisji. Zanim wywołasz tę metodę, sprawdź, czy wartość właściwości status.streamStatus strumienia przypisanego do transmisji wynosi active.
update PUT /liveBroadcasts Aktualizuje transmisję. Możesz na przykład zmienić ustawienia komunikatów zdefiniowane w obiekcie contentDetails zasobu liveBroadcast.
cuepoint POST /liveBroadcasts/cuepoint Powoduje wstawienie punktu wstawienia do transmisji na żywo. Punkt wstawienia reklamy może powodować przerwę w reklamie.

Ograniczenia czatu na żywo

Zasób liveChatBan identyfikuje użytkownika YouTube i czat na żywo w YouTube, w przypadku których dany użytkownik nie może uczestniczyć.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans Zniesie blokadę, co uniemożliwia konkretnemu użytkownikowi udział w czacie na żywo, a tym samym umożliwia ponowne dołączenie do czatu. Żądanie interfejsu API musi zostać autoryzowane przez właściciela kanału lub moderatora czatu na żywo powiązanego z banem.
insert POST /liveChat/bans Zablokowanie konkretnego użytkownika, który nie może brać udziału w czacie na żywo. Żądanie interfejsu API musi zostać autoryzowane przez właściciela kanału lub moderatora czatu na żywo powiązanego z banem.

Wiadomości z czatu na żywo

Zasób liveChatMessage reprezentuje wiadomość czatu na czacie na żywo w YouTube. Zasób może zawierać szczegółowe informacje dotyczące kilku typów wiadomości, w tym nowo opublikowanych wiadomości tekstowych lub wydarzeń finansowania przez fanów.

Funkcja czatu na żywo jest domyślnie włączona w przypadku transmisji na żywo i jest dostępna w czasie, gdy jest aktywna. (po zakończeniu wydarzenia czat na żywo nie będzie już dostępny).

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages Usuwa wiadomość czatu. Żądanie interfejsu API musi zostać autoryzowane przez właściciela kanału lub moderatora czatu na żywo powiązanego z banem.
insert POST /liveChat/messages Dodaje wiadomość do czatu na żywo.
list GET /liveChat/messages Wyświetla listę wiadomości czatu konkretnego czatu.

Moderatorzy czatu na żywo

Zasób liveChatModerator reprezentuje moderatora czatu na żywo w YouTube. Moderator czatu może blokować i blokować użytkowników, usuwać wiadomości oraz wykonywać inne czynności administracyjne na czacie na żywo.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators Usunięcie moderatora czatu. Prośba musi zostać zatwierdzona przez właściciela kanału transmisji na żywo.
insert POST /liveChat/moderators Dodaje nowego moderatora czatu. Prośba musi zostać zatwierdzona przez właściciela kanału transmisji na żywo.
list GET /liveChat/moderators Lista moderatorów czatu na żywo. Prośba musi zostać zatwierdzona przez właściciela kanału transmisji na żywo.

Transmisje na żywo

Zasób liveStream zawiera informacje o strumieniu wideo, który przesyłasz do YouTube. Strumień zawiera treści, które będą udostępniane użytkownikom YouTube. Po utworzeniu zasób liveStream może być powiązany z co najmniej jednym zasobem liveBroadcast.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams Usuwa strumień wideo.
insert POST /liveStreams Tworzy strumień wideo. Strumień umożliwia wysłanie filmu do YouTube, który może następnie przekazać go widzom.
list GET /liveStreams Zwraca listę strumieni wideo pasujących do parametrów żądania do interfejsu API.
update PUT /liveStreams Aktualizuje strumień wideo. Jeśli nie możesz zaktualizować właściwości, które chcesz zmienić, musisz utworzyć nowy strumień o odpowiednich ustawieniach.

Sponsorzy

Zasób sponsor reprezentuje sponsora kanału YouTube. Sponsor zapewnia twórcom cykliczne wsparcie finansowe, takie jak subskrypcja lub opłata członkowska, oraz dostęp do specjalnych korzyści. Sponsorzy mogą na przykład rozmawiać na czacie, gdy twórca włączy tryb tylko dla sponsorów.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://www.googleapis.com/youtube/v3
list GET /sponsors Wyświetla listę sponsorów kanału. Żądanie do interfejsu API musi zostać autoryzowane przez właściciela kanału.

Superczaty

Zasób superChatEvent reprezentuje wiadomość superczatu wykupioną przez fana podczas transmisji na żywo w YouTube. Superczaty w YouTube transmitowane na żywo wyróżniają się na dwa sposoby:

  • Superczaty są wyróżnione kolorem.
  • Superczaty są widoczne na pasku aktywności przez określony czas.

Kolor superczatu, czas, przez jaki jest on widoczny na pasku aktywności, oraz maksymalna długość wiadomości zależą od kwoty zakupu. Aby dowiedzieć się więcej o superczacie, zajrzyj do Centrum pomocy YouTube.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://www.googleapis.com/youtube/v3
list GET /superChatEvents Wymień superczaty z transmisji na żywo na kanale z ostatnich 30 dni.

Wycofane typy zasobów

Wydarzenia związane z FundingFing

Zasób fanFundingEvent reprezentuje zdarzenie finansowania przez fanów na kanale YouTube. Finansowanie przez fanów to sposób na zarabianie pieniędzy dla twórców YouTube. Zdarzenie finansowania przez fanów ma miejsce, gdy użytkownik dokona jednorazowej, dobrowolnej wpłaty na rzecz kanału. Więcej informacji o finansowaniu przez fanów znajdziesz w Centrum pomocy YouTube.

Aby dowiedzieć się więcej o tym zasobie, zobacz jego reprezentowanie zasobu i listę właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI w stosunku do: https://www.googleapis.com/youtube/v3
list GET /fanFundingEvents Wyświetla listę zdarzeń finansowania przez fanów na kanale. Żądanie do interfejsu API musi zostać autoryzowane przez właściciela kanału.