LiveBroadcasts: list

Zwraca listę transmisji w 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 użyciem co najmniej jednego z tych zakresów. Więcej informacji o uwierzytelnianiu i autoryzacji znajdziesz w artykule Implementowanie 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 tej tabeli znajdziesz listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa rozdzieloną przecinkami listę co najmniej 1 właściwości zasobu liveBroadcast, które mają być uwzględnione w odpowiedzi interfejsu API. Nazwy part części, które możesz uwzględnić w wartości parametru, to id, snippet, contentDetails, monetizationDetails i status.
Filtry (określ dokładnie 1 z tych parametrów)
broadcastStatus string
Parametr broadcastStatus filtruje odpowiedź interfejsu API, aby zawierała tylko transmisje o określonym stanie.

Akceptowane wartości:
  • active – zwraca bieżące transmisje na żywo.
  • all – zwraca wszystkie transmisje.
  • completed – zwraca transmisje, które już się zakończyły.
  • upcoming – zwraca transmisje, które jeszcze się nie rozpoczęły.
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów transmisji w YouTube, które mają zostać pobrane. W zasobie liveBroadcast właściwość id określa identyfikator transmisji.
mine boolean
Parametr mine może służyć do instruowania interfejsu API, aby zwracał tylko transmisje należące do uwierzytelnionego użytkownika. Aby pobrać tylko własne transmisje, ustaw wartość parametru na true.
Parametry opcjonalne
broadcastType string
Parametr broadcastType filtruje odpowiedź interfejsu API, aby zawierała tylko transmisje o określonym typie. Ten parametr należy stosować w żądaniach, w których parametr mine jest ustawiony na true lub w których używany jest parametr broadcastStatus. Wartością domyślną jest event.

Akceptowane wartości:
  • all – zwraca wszystkie transmisje.
  • event – zwraca tylko zaplanowane transmisje wydarzeń.
  • persistent – zwraca tylko transmisje trwałe.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które mają zostać zwrócone w zbiorze wyników. Akceptowane wartości to od 0 do 50 włącznie. Wartością domyślną jest 5.
onBehalfOfContentOwner string
Ten parametr może być używany tylko w prawidłowo autoryzowanym żądaniu.
Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów YouTube zajmujących się treściami.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające żądania identyfikują użytkownika systemu zarządzania treścią (CMS) w YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Ten parametr jest przeznaczony dla partnerów YouTube zajmujących się treściami, którzy są właścicielami wielu różnych kanałów YouTube i nimi zarządzają. Umożliwia on właścicielom treści jednokrotne uwierzytelnienie i uzyskanie dostępu do wszystkich danych o filmach i kanałach bez konieczności podawania danych uwierzytelniających dla każdego kanału. Konto CMS, za pomocą którego uwierzytelnia się użytkownik, musi być połączone z określonym właścicielem treści w YouTube.
onBehalfOfContentOwnerChannel string
Ten parametr może być używany tylko w prawidłowo autoryzowanym żądaniu.
Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów YouTube zajmujących się treściami.

Parametr onBehalfOfContentOwnerChannel określa identyfikator kanału YouTube, do którego dodawany jest film. Ten parametr jest wymagany, gdy żądanie określa wartość parametru onBehalfOfContentOwner, i może być używany tylko w połączeniu z tym parametrem. Ponadto żą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 w wartości parametru onBehalfOfContentOwnerChannel musi być połączony z właścicielem treści określonym w parametrze onBehalfOfContentOwner.

Ten parametr jest przeznaczony dla partnerów YouTube zajmujących się treściami, którzy są właścicielami wielu różnych kanałów YouTube i nimi zarządzają. Umożliwia on właścicielom treści jednokrotne uwierzytelnienie 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 konkretną stronę w zbiorze wyników, która ma zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken określają inne strony, które można pobrać.

Treść żądania

Podczas wywoływania tej metody nie podawaj treści żądania.

Odpowiedź

Jeśli operacja się uda, ta metoda zwróci treść odpowiedzi o tej strukturze:

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

Właściwości

W tej tabeli znajdziesz definicje właściwości, które występują w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość to youtube#liveBroadcastListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać następną stronę w zbiorze wyników.
prevPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać poprzednią stronę w zbiorze wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zbiorze wyników.
pageInfo.resultsPerPage integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
items[] list
Lista transmisji, które pasują do kryteriów żądania.

Błędy

W tej tabeli znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej informacji znajdziesz w komunikacie o błędzie.

Typ błędu Szczegóły błędu Opis
insufficientPermissions insufficientLivePermissions Żądanie nie jest autoryzowane do pobierania transmisji na żywo.
insufficientPermissions liveStreamingNotEnabled Użytkownik, który autoryzował żądanie, nie ma uprawnień do przesyłania transmisji na żywo w YouTube. Więcej informacji znajdziesz w artykule Dostęp do funkcji.

Wypróbuj

Aby wywołać ten interfejs API i zobaczyć żądanie do interfejsu API oraz odpowiedź, użyj APIs Explorer.