LiveChatMessages: list

Wyświetla listę wiadomości z czatu na żywo na konkretnym czacie.

Gdy po raz pierwszy poprosisz o pobranie wiadomości z czatu, interfejs API zwróci część lub całość historii czatu, w zależności od jej długości. Wiadomości w odpowiedzi są uporządkowane od najstarszego do najnowszego.
  • nextPageToken w odpowiedzi zawiera token, który w następnym żądaniu zidentyfikuje następny zestaw wyników, które powinien pobrać klient interfejsu API.
  • Właściwość pollingIntervalMillis wskazuje, jak długo klient interfejsu API powinien czekać, zanim poprosi o dodatkowe wyniki.
Gdy prosisz o dodatkowe wyniki, ustawiasz parametr pageToken na wartość nextPageToken, a serwer API zwraca dodatkowe wiadomości czatu, jeśli są dostępne. W tym zestawie wyników wiadomości są uporządkowane od najstarszego do najnowszego.

Częste zastosowania

Żądanie

Żądanie HTTP

GET https://www.googleapis.com/youtube/v3/liveChat/messages

Parametry

Tabela poniżej zawiera listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
liveChatId string
Parametr liveChatId określa identyfikator czatu, z którego będą zwracane wiadomości. Identyfikator czatu na żywo powiązany z transmisją jest zwracany we właściwości snippet.liveChatId zasobu liveBroadcast.
part string
Parametr part określa części zasobów liveChatMessage, które będzie uwzględniać odpowiedź interfejsu API. Obsługiwane wartości to id, snippet oraz authorDetails.
Parametry opcjonalne
hl string
Parametr hl informuje interfejs API, aby pobrać wyświetlany ciąg znaków w zlokalizowanej walucie dla określonego języka aplikacji obsługiwanego przez witrynę YouTube. Na przykład w języku angielskim waluta będzie wyświetlana jako $1.50, a w języku francuskim – jako 1,50$.

Wartość parametru musi być kodem języka uwzględnionego na liście zwracanej przez metodę i18nLanguages.list.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę wiadomości, które powinny być zwracane w zestawie wyników. Akceptowane wartości to od 200 do 2000 włącznie. Wartością domyślną jest 500.
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ść nextPageToken wskazuje inne strony, które można pobrać.
profileImageSize unsigned integer
Parametr profileImageSize określa rozmiar zdjęć profilowych użytkownika, które mają być zwracane w zestawie wyników. Obrazy są kwadratowe. Wartość domyślna to 88, co oznacza, że obraz ma rozmiar 88 x 88 pikseli. Akceptowane wartości mieszczą się w zakresie od 16 do 720 włącznie.

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#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage 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#liveChatMessageListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, którego można użyć jako wartość parametru pageToken do pobrania następnej strony w zestawie wyników.
pollingIntervalMillis unsigned integer
Czas (w milisekundach), przez jaki klient powinien czekać przed ponownym odpytywaniem w poszukiwaniu nowych wiadomości na czacie na żywo.
offlineAt datetime
Data i godzina przejścia do trybu offline powiązanej transmisji na żywo. Ta właściwość jest dostępna tylko wtedy, gdy strumień jest już offline. Wartość jest podana w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
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 wiadomości. Każda pozycja na liście to zasób liveChatMessage.
activePollItem object
Dane ankiety w wiadomości. Każda ankieta to zasób liveChatMessage typu pollEvent, który reprezentuje aktywną ankietę. Na każdy czat może przypadać tylko 1 ankieta.

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 komunikatu o błędzie.

Typ błędu Szczegóły błędu Opis
forbidden (403) forbidden Nie masz uprawnień do pobierania wiadomości z podanego czatu na żywo.
forbidden (403) liveChatDisabled Czat na żywo nie jest włączony w przypadku określonej transmisji.
forbidden (403) liveChatEnded Podany czat na żywo nie jest już aktywny.
notFound (404) liveChatNotFound Nie można znaleźć czatu na żywo, który próbujesz pobrać. Sprawdź, czy wartość parametru liveChatId żądania jest prawidłowa.
rateLimitExceeded rateLimitExceeded Prośba została wysłana zbyt szybko po poprzedniej prośbie. Ten błąd występuje, gdy żądania pobrania wiadomości do interfejsu API są wysyłane częściej niż częstotliwość odświeżania YouTube, co niepotrzebnie zużywa przepustowość.

Wypróbuj

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