LiveChatMessages: list

Wyświetla wiadomości z czatu na żywo dla konkretnego czatu.

Gdy po raz pierwszy wyślesz żądanie pobrania wiadomości na czacie, interfejs API zwróci część lub całą historię czatu w zależności od jej długości. Wiadomości w odpowiedzi są uporządkowane od najstarszych do najnowszych.
  • Znak nextPageToken w odpowiedzi zawiera token, który w następnym żądaniu zidentyfikuje kolejny zestaw wyników, które klient interfejsu API powinien pobrać.
  • Właściwość pollingIntervalMillis wskazuje, jak długo klient interfejsu API powinien czekać przed wysłaniem żądania dodatkowych wyników.
Gdy poprosisz o dodatkowe wyniki, ustaw parametr pageToken na wartość nextPageToken, a serwer interfejsu API zwróci dodatkowe wiadomości na czacie, jeśli są dostępne. W tym zbiorze wyników wiadomości są uporządkowane od najstarszych do najnowszych.

Częste przypadki użycia

Żądanie

Żądanie HTTP

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

Parametry

W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry to parametry zapytania.

Parametry
Parametry wymagane
liveChatId string
Parametr liveChatId określa identyfikator czatu, którego wiadomości zostaną zwrócone. Identyfikator czatu na żywo powiązanego z transmisją jest zwracany we właściwości snippet.liveChatId zasobu liveBroadcast.
part string
Parametr part określa części zasobu liveChatMessage, które będą uwzględnione w odpowiedzi interfejsu API. Obsługiwane wartości to id, snippet i authorDetails.
Parametry opcjonalne
hl string
Parametr hl nakazuje interfejsowi API pobranie zlokalizowanego ciągu znaków wyświetlania waluty dla określonego języka aplikacji obsługiwanego przez witrynę YouTube. Na przykład w języku angielskim waluta jest wyświetlana jako $1.50, a w języku francuskim jako 1,50$.

Wartość parametru musi być kodem języka z listy zwracanej przez metodę i18nLanguages.list.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę wiadomości, które powinny zostać zwrócone w zestawie wyników. Akceptowane wartości to od 200 do 2000 włącznie. Wartością domyślną jest 500.
pageToken string
Parametr pageToken identyfikuje konkretną stronę w zestawie wyników, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwość nextPageToken identyfikuje inne strony, które można pobrać.
profileImageSize unsigned integer
Parametr profileImageSize określa rozmiar zdjęć profilowych użytkowników, które mają być zwracane w zestawie wyników. Obrazy są kwadratowe. Wartość domyślna to 88, co oznacza, że zdjęcia będą miały wymiary 88 x 88 pikseli. Akceptowane wartości należą do przedziału od 16 do 720 (obustronnie domkniętego).

Treść żądania

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

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź w poniższym formacie:

{
  "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

Poniższa tabela zawiera 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ść będzie wynosić youtube#liveChatMessageListResponse.
etag etag
Tag 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.
pollingIntervalMillis unsigned integer
Czas (w milisekundach), przez jaki klient powinien czekać przed ponownym wysłaniem zapytania o nowe wiadomości na czacie na żywo.
offlineAt datetime
Data i godzina przejścia transmisji na żywo w tryb offline. Ta właściwość jest obecna 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 zestawu 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 wiadomości. Każdy element na liście to zasób liveChatMessage.
activePollItem object
Dane ankiety w wiadomości. Każda ankieta jest zasobem liveChatMessage typu pollEvent, który reprezentuje aktywną ankietę. Na 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ń wymaganych do pobierania wiadomości z określonego czatu na żywo.
forbidden (403) liveChatDisabled Czat na żywo nie jest włączony w przypadku określonej transmisji.
forbidden (403) liveChatEnded Określony czat na żywo nie jest już aktywny.
notFound (404) liveChatNotFound Nie można znaleźć czatu na żywo, który próbujesz odzyskać. Sprawdź wartość parametru liveChatId żądania, aby upewnić się, że jest prawidłowa.
rateLimitExceeded rateLimitExceeded Żądanie zostało wysłane zbyt szybko po poprzednim żądaniu. Ten błąd występuje, gdy żądania API dotyczące pobierania wiadomości są wysyłane częściej niż częstotliwość odświeżania YouTube, co niepotrzebnie marnuje przepustowość.

Wypróbuj tę funkcję.

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