LiveStreams: list

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

Typowe przypadki użycia

Żądanie

Żądanie HTTP

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

Upoważnienie

To żądanie wymaga autoryzacji z co najmniej jednym z poniższych 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 poniższej tabeli podano 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 jednej właściwości zasobu liveStream, która będzie uwzględniona w odpowiedzi interfejsu API. Nazwy parametrów part, które możesz umieszczać w wartościach parametrów, to id, snippet, cdn i status.
Filtry (podaj jeden z tych parametrów)
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów strumienia YouTube, które identyfikują pobierane strumienie. W zasobie liveStream właściwość id określa identyfikator strumienia.
mine boolean
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Parametr mine może służyć do informowania interfejsu API, że ma on 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 powinny zostać zwrócone w zestawie wyników. Akceptowane wartości to 0–50 (włącznie). Wartością domyślną jest 5.
onBehalfOfContentOwner string
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów w sieci reklamowej YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane logowania żądania autoryzacji to użytkownik 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 w sieci reklamowej YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Umożliwia właścicielom treści uwierzytelnianie tylko raz oraz dostęp do wszystkich filmów i kanałów bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Konto CMS, za pomocą którego użytkownik się uwierzytelni, 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 poprawnie autoryzowanym żądaniu. Tego parametru można używać tylko w odpowiednim autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony tylko dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwnerChannel określa identyfikator kanału YouTube, do którego jest dodawany 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, które jest określone w parametrze onBehalfOfContentOwner. Na koniec kanał, który określa parametr onBehalfOfContentOwnerChannel, musi być powiązany z właścicielem treści, który jest określony przez parametr onBehalfOfContentOwner.

Ten parametr jest przeznaczony dla partnerów w sieci reklamowej YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Umożliwia właścicielom treści uwierzytelnianie raz 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 z osobna.
pageToken string
Parametr pageToken wskazuje konkretną stronę w zestawie wyników, 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

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

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź w następującym formacie:

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

Usługi

Poniższa tabela określa właściwości, które pojawiają się w tym zasobie:

Usługi
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#liveStreamListResponse.
etag etag
Otagowanie tego zasobu.
nextPageToken string
Token, który może zostać użyty jako wartość parametru pageToken, by pobrać następną stronę z zestawu wyników.
prevPageToken string
Token, którego można użyć jako wartości parametru pageToken w celu pobrania poprzedniej strony z zestawu wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu dla zestawu 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 na żywo, które spełniają 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 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 ma uprawnień do pobrania określonej transmisji na żywo.
insufficientPermissions liveStreamingNotEnabled Użytkownik, który autoryzował żądanie, nie ma dostępu do transmisji na żywo w YouTube. Więcej informacji użytkownik może znaleźć na stronie https://www.youtube.com/features.

Wypróbuj

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