LiveBroadcasts: list

Zwraca listę transmisji z YouTube, które pasują do parametrów żądania do interfejsu API.

Częste zastosowania

Żądanie

Żądanie HTTP

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

Autoryzacja

To żądanie wymaga autoryzacji z co najmniej jednym z poniższych zakresów. Aby dowiedzieć się więcej o uwierzytelnianiu i autoryzowaniu, przeczytaj artykuł Wdrażanie uwierzytelniania OAuth 2.0.

Zakres
https://www.googleapis.com/auth/youtube.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parametry

W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa rozdzieloną przecinkami listę właściwości zasobu liveBroadcast, które będzie zawierać odpowiedź interfejsu API. Nazwy part, które możesz uwzględnić w wartości parametru, to id, snippet, contentDetails, monetizationDetails i status.
Filtry (określ dokładnie jeden z następujących parametrów)
broadcastStatus string
Parametr broadcastStatus filtruje odpowiedź interfejsu API, aby uwzględniała tylko transmisje o określonym stanie.

Akceptowane wartości to:
    .
  • active – wyświetla bieżące transmisje na żywo.
  • all – zwraca wszystkie komunikaty.
  • completed – zwróci transmisje, które już się zakończyły.
  • upcoming – zwraca transmisje, które jeszcze się nie rozpoczęły.
id string
Parametr id zawiera rozdzieloną przecinkami listę identyfikatorów transmisji YouTube, które identyfikują pobierane transmisje. W zasobie liveBroadcast właściwość id określa identyfikator transmisji.
mine boolean
Parametr mine może służyć do tego, aby instruować interfejs API, aby zwracał tylko komunikaty należące do uwierzytelnionego użytkownika. Aby pobierać tylko własne komunikaty, ustaw wartość parametru na true.
Parametry opcjonalne
broadcastType string
Parametr broadcastType filtruje odpowiedź interfejsu API, aby uwzględniała tylko transmisje określonego typu. Tego parametru należy używać w żądaniach, które ustawiają parametr mine na true lub używają parametru broadcastStatus. Wartość domyślna to event.

Akceptowane wartości to:
  • all – zwraca wszystkie komunikaty.
  • event – wyświetlanie tylko zaplanowanych transmisji z wydarzeń.
  • persistent – zwraca tylko trwałe komunikaty.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny być zwracane w zestawie wyników. Akceptowane wartości to od 0 do 50 włącznie. Wartością domyślną jest 5.
onBehalfOfContentOwner string
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu.
Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające żądania wskazują użytkownika systemu zarządzania treścią w YouTube (CMS), który działa w imieniu właściciela treści określonego w wartości parametru. Ten parametr jest przeznaczony dla dostawców treści w YouTube, którzy są właścicielami wielu różnych kanałów w YouTube i nimi zarządzają. Dzięki niej właściciele treści mogą dokonać uwierzytelnienia raz i uzyskać dostęp do wszystkich danych dotyczących filmów i kanału bez konieczności podawania danych uwierzytelniających dla każdego kanału. Konto CMS, za pomocą którego użytkownik się uwierzytelnia, musi być połączone z określonym właścicielem treści YouTube.
onBehalfOfContentOwnerChannel string
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu.
Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwnerChannel określa identyfikator kanału YouTube, do którego dodajesz film. Ten parametr jest wymagany, gdy żądanie określa wartość parametru onBehalfOfContentOwner i można go używać tylko w połączeniu z tym parametrem. Dodatkowo żądanie musi być autoryzowane za pomocą konta CMS połączonego z właścicielem treści określonym w parametrze onBehalfOfContentOwner. Na koniec kanał określony przez wartość parametru onBehalfOfContentOwnerChannel musi być połączony z właścicielem treści określonym w parametrze onBehalfOfContentOwner.

Ten parametr jest przeznaczony dla dostawców treści w YouTube, którzy są właścicielami wielu różnych kanałów w YouTube i nimi zarządzają. Umożliwia właścicielom treści jednorazowe uwierzytelnianie i wykonywanie działań w imieniu kanału określonego w wartości parametru bez konieczności podawania danych uwierzytelniających dla każdego kanału.
pageToken string
Parametr pageToken określa w zestawie wyników konkretną stronę, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken wskazują inne strony, które można pobrać.

Treść żądania

Nie podawaj treści żądania przy wywoływaniu tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

Właściwości

Tabela poniżej zawiera właściwości widoczne w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość wyniesie youtube#liveBroadcastListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, którego można używać jako wartość parametru pageToken do pobierania następnej strony w zestawie wyników.
prevPageToken string
Token, którego można używać jako wartość parametru pageToken do pobierania poprzedniej strony zbioru wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu dla zbioru wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zestawie wyników.
pageInfo.resultsPerPage integer
Liczba wyników zawartych w odpowiedzi interfejsu API.
items[] list
Lista transmisji spełniających kryteria żądania.

Błędy

W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tę metodę. Więcej informacji znajdziesz w komunikatie o błędzie.

Typ błędu Szczegóły błędu Opis
insufficientPermissions insufficientLivePermissions Żądanie nie ma uprawnień do pobrania transmisji na żywo.
insufficientPermissions liveStreamingNotEnabled Użytkownik, który autoryzował żądanie, nie może transmitować obrazu na żywo w YouTube. Więcej informacji znajdziesz w artykule Dostęp do funkcji.

Wypróbuj

Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie i odpowiedź interfejsu API.