LiveBroadcasts: list

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

Typowe przypadki użycia

Prośba

Żądanie HTTP

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

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 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ę zawierającą co najmniej 1 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 tych parametrów)
broadcastStatus string
Parametr broadcastStatus filtruje odpowiedź interfejsu API, aby uwzględniała tylko transmisje o określonym stanie.

Akceptowane wartości:
  • active – zwraca bieżące transmisje na żywo.
  • all – zwraca wszystkie transmisje.
  • completed – powrotne transmisje, które już się zakończyły.
  • upcoming – transmisje zwrotne, które jeszcze się nie rozpoczęły.
id string
Parametr id określa 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 informowania interfejsu API, aby zwracał tylko transmisje należące do uwierzytelnionego użytkownika. Aby pobierać tylko własne transmisje, ustaw ten parametr na true.
Parametry opcjonalne
broadcastType string
Parametr broadcastType filtruje odpowiedź interfejsu API, aby uwzględniała tylko transmisje określonego typu. Parametr powinien być używany w żądaniach, które ustawiają parametr mine na true lub korzystają z parametru broadcastStatus. Wartością domyślną jest event.

Akceptowane wartości:
  • all – zwraca wszystkie transmisje.
  • event – zwraca tylko zaplanowane transmisje.
  • persistent – zwracane są tylko trwałe transmisje.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny 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 dostawców treści w YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające żądanie identyfikują użytkownika YouTube CMS działającego w imieniu właściciela treści określonego w wartości parametru. Jest on przeznaczony dla dostawców treści w YouTube, którzy są właścicielami wielu różnych kanałów w YouTube i zarządzają nimi. Pozwala właścicielom treści raz uwierzytelnić się i uzyskać dostęp do wszystkich swoich filmów i danych kanału bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Konto CMS, za pomocą którego użytkownik uwierzytelnia się, musi być powiązane z określonym właścicielem treści YouTube.
onBehalfOfContentOwnerChannel string
Ten parametr może być używany tylko w prawidłowo autoryzowanym żądaniu. 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 jest dodawany film. Ten parametr jest wymagany, gdy w żądaniu określono 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. I wreszcie, 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 YouTube i nimi zarządzają. Dzięki temu właściciele treści mogą raz uwierzytelnić się i wykonywać działania 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 w zestawie wyników konkretną stronę, 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

Nie podawaj treści żądania podczas wywoływania tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci treść odpowiedzi w 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

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

Właściwości
kind string
Określa typ zasobu API. Wartością będzie youtube#liveBroadcastListResponse.
etag etag
Tag ETag tego zasobu.
nextPageToken string
Token, który może być używany jako wartość parametru pageToken w celu pobrania następnej strony w zestawie wyników.
prevPageToken string
Token, który może być używany jako wartość parametru pageToken do pobierania poprzedniej strony w zestawie wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu 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 tej metody. Więcej szczegółów znajdziesz w dokumentacji komunikatów o błędach.

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 ma uprawnień do transmitowania na żywo w YouTube. Więcej informacji użytkownik może znaleźć na stronie https://www.youtube.com/features.

Wypróbuj

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