LiveStreams: list

Zwraca listę strumieni wideo, które pasują do parametrów żądania do interfejsu API.

Częste zastosowania

Żądanie

Żądanie HTTP

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

Autoryzacja

To żądanie wymaga autoryzacji z co najmniej jednym z tych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).

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ę co najmniej 1 właściwości zasobu liveStream, które mają być uwzględnione w odpowiedzi interfejsu API. Nazwy part które możesz uwzględnić w wartości parametru, to id, snippet, cdn i status.
Filtry (określ dokładnie 1 z tych parametrów)
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów strumieni YouTube, które identyfikują pobierane strumienie. W zasobie liveStream właściwość id określa identyfikator strumienia.
mine boolean
Ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu. Parametr mine może służyć do instruowania interfejsu API, aby zwracał tylko strumienie należące do uwierzytelnionego użytkownika. Aby pobrać tylko własne strumienie, ustaw wartość parametru na true.
Parametry opcjonalne
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które mają być zwracane 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żna używać 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 logowania do autoryzacji żądania identyfikują użytkownika systemu YouTube CMS, 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 jednorazowe 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 użytkownik się uwierzytelnia, musi być połączone z określonym właścicielem treści w YouTube.
onBehalfOfContentOwnerChannel string
Ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu. Ten parametr można używać 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żna go używać 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 jednorazowe 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 identyfikują 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#liveStreamListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveStream Resource
  ]
}

Właściwości

W tabeli poniżej znajdziesz definicje właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość to youtube#liveStreamListResponse.
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 na żywo, które pasują do kryteriów żą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 tej metody. Więcej informacji znajdziesz w dokumentacji komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
insufficientPermissions insufficientLivePermissions Żądanie nie jest autoryzowane do pobierania określonej 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 na stronie https://www.youtube.com/features.

Wypróbuj

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