Dokumentacja API

Ten przewodnik po interfejsie API wyjaśnia, jak zaplanować transmisje na żywo i strumienie wideo w YouTube za pomocą interfejsu YouTube Live Streaming API.

Typy zasobów

LiveBroadcasts

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

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne do https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind Wiąże transmisję YouTube ze strumieniem lub usuwa istniejące powiązanie między transmisją a strumieniem. Transmisja może być powiązana tylko z 1 strumieniem wideo, ale strumień wideo może być powiązany z wieloma transmisjami.
delete DELETE /liveBroadcasts Usuwanie transmisji.
insert POST /liveBroadcasts tworzy transmisję.
list GET /liveBroadcasts Zwraca listę transmisji YouTube, które pasują do parametrów żądania interfejsu API.
transition POST /liveBroadcasts/transition Zmienia stan transmisji na żywo w YouTube i inicjuje wszelkie procesy związane z nowym stanem. Gdy na przykład zmienisz stan transmisji na testing, YouTube zacznie przesyłać film do strumienia monitorowania tej transmisji. Przed wywołaniem tej metody musisz potwierdzić, że wartość właściwości status.streamStatus dla strumienia powiązanego z Twoim przekazem wynosi active.
update PUT /liveBroadcasts Aktualizuje transmisję. Możesz na przykład zmodyfikować ustawienia transmisji zdefiniowane w obiekcie contentDetails zasobu liveBroadcast.
cuepoint POST /liveBroadcasts/cuepoint Wstawia punkt cue w transmisji na żywo. Sygnał może wywołać przerwę na reklamę.

LiveChatBans

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

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne do https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans Usunięcie zakazu, który uniemożliwia konkretnemu użytkownikowi udział w czacie na żywo, co umożliwia mu ponowne dołączenie do czatu. Żądanie wywołania interfejsu API musi zostać autoryzowane przez właściciela kanału lub moderatora czatu na żywo powiązanego z zablokowaniem.
insert POST /liveChat/bans Uniemożliwia konkretnemu użytkownikowi udział w czacie na żywo. Żądanie wywołania interfejsu API musi być autoryzowane przez właściciela kanału lub moderatora czatu na żywo powiązanego z zablokowaniem.

LiveChatMessages

Zasób liveChatMessage reprezentuje wiadomość na czacie na żywo w YouTube. Zasób może zawierać szczegóły dotyczące kilku typów wiadomości, w tym nowo opublikowanej wiadomości tekstowej lub wydarzenia dotyczącego finansowania przez fanów.

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

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

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

LiveChatModerators

Zasób liveChatModerator reprezentuje moderatora czatu na żywo w YouTube. Moderator czatu może banować i odbanować użytkowników, usuwać wiadomości oraz wykonywać inne działania administracyjne dotyczące czatu na żywo.

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne do https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators Usuwa moderatora czatu. Prośba musi być autoryzowana przez właściciela kanału, na którym odbywa się transmisja na żywo.
insert POST /liveChat/moderators Dodaje nowego moderatora czatu. Prośba musi być autoryzowana przez właściciela kanału, na którym odbywa się transmisja na żywo.
list GET /liveChat/moderators Wyświetla listę moderatorów czatu na żywo. Prośba musi być autoryzowana przez właściciela kanału, na którym odbywa się transmisja na żywo.

LiveStreams

Zasób liveStream zawiera informacje o strumieniu wideo, który przesyłasz do YouTube. Transmisja zawiera treści, które będą transmitowane użytkownikom YouTube. Po utworzeniu zasób liveStream może być powiązany z jednym lub większą liczbą zasobów liveBroadcast.

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne do https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams Usuwa strumień wideo.
insert POST /liveStreams Tworzy strumień wideo. Dzięki strumieniowi możesz wysłać film do YouTube, który może go następnie transmitować odbiorcom.
list GET /liveStreams Zwraca listę strumieni wideo, które pasują do parametrów żądania interfejsu API.
update PUT /liveStreams Aktualizuje strumień wideo. Jeśli właściwości, które chcesz zmienić, nie można zaktualizować, musisz utworzyć nowy strumień z odpowiednimi ustawieniami.

SuperChatEvents

Zasób superChatEvent reprezentuje wiadomość superczatu kupioną przez fana podczas transmisji na żywo w YouTube. W czacie na żywo w YouTube superczaty wyróżniają się na tle innych wiadomości w 2 sposoby:

  • Superczaty są wyróżnione kolorem.
  • Superczaty pozostają przypięte na pasku aktywności przez określony czas.

Kolor superczatu, czas, przez jaki jest widoczny na pasku aktywności, oraz maksymalna długość wiadomości zależą od kwoty zakupu. Więcej informacji o superczacie znajdziesz w Centrum pomocy YouTube.

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu i na liście właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne do https://www.googleapis.com/youtube/v3
list GET /superChatEvents Lista wydarzeń związanych z superczatem z transmisji na żywo na kanale z ostatnich 30 dni.

Wycofane typy zasobów

FanFundingEvents

Zasób fanFundingEvent reprezentuje zdarzenie finansowania przez fanów na kanale w YouTube. Finansowanie przez fanów to sposób na wsparcie finansowe twórców YouTube. Zdarzenie fan funding występuje, gdy użytkownik dokona jednorazowej dobrowolnej płatności na rzecz kanału. Więcej informacji o finansowaniu przez fanów znajdziesz w Centrum pomocy YouTube.

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

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

LiveCuepoints

Zasób liveCuepoint uruchamia przerwę na reklamę w strumieniu wideo transmisji.

Uwaga: polecenie interfejsu API służące do kontrolowania punktów cuepoint jest częścią interfejsu API Content ID w YouTube i ma inne wymagania dotyczące autoryzacji niż prośby o zarządzanie zasobami liveBroadcast i liveStream.

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu i na liście właściwości.

Metoda Żądanie HTTP Opis
Identyfikatory URI względne do https://www.googleapis.com/
insert POST /liveCuepoints Wstawia punkt cue w transmisji na żywo. Obecnie żądania wysyłane za pomocą tej metody muszą być autoryzowane przez konto powiązane z właścicielem treści w YouTube.

Sponsorzy

Zasób sponsor reprezentuje sponsora kanału w YouTube. Sponsor zapewnia twórcy cykliczne wsparcie finansowe, np. w formie opłaty za subskrypcję lub członkostwo, i otrzymuje specjalne korzyści. Na przykład sponsorzy mogą korzystać z czatu, gdy twórca włączy tryb tylko dla sponsorów.

Więcej informacji o tym zasobie znajdziesz w sekcji reprezentacja zasobu oraz w liście właściwości.

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