LiveChatMessages: list

Wyświetla wiadomości na czacie na żywo w przypadku 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.
  • W odpowiedzi parametr nextPageToken zawiera token, który w następnym żądaniu będzie identyfikować kolejny zestaw wyników, które powinien pobrać klient interfejsu API.
  • 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 zestawie wyników wiadomości są ponownie uporządkowane od najstarszych do najnowszych.

Wpływ na limit: wywołanie tej metody kosztuje 5 jednostek limitu.

Częste zastosowania

Żą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 są parametrami zapytania.

Parametry
Parametry wymagane
liveChatId string
Parametr liveChatId określa identyfikator czatu, którego wiadomości zostaną zwrócone. 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 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 instruuje interfejs API, aby pobrał zlokalizowany ciąg znaków wyświetlający walutę w określonym języku aplikacji obsługiwanym przez witrynę YouTube. Na przykład w języku angielskim waluta będzie wyświetlana jako $1.50, ale w języku francuskim jako 1,50$.

Wartość parametru musi być kodem języka zawartym na liście 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.

Pierwsze żądanie wysłane bez tokena kontynuacji będzie zawierać tylko najnowsze wiadomości. Jeśli podasz wartość maxResults, może ona być mniejsza.

Interfejs API nie pobiera wiadomości starszych niż te, które zostały zwrócone w pierwszym żądaniu wysłanym bez tokena kontynuacji.
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 powinny zostać zwrócone w zestawie wyników. Obrazy są kwadratowe. Wartością domyślną jest 88, co oznacza, że zdjęcia będą miały wymiary 88 x 88 pikseli. Akceptowane wartości mieszczą się w zakresie od 16 do 720 włącznie.

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#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

W tabeli poniżej znajdziesz 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#liveChatMessageListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, który można użyć jako wartość parametru pageToken, aby pobrać następną stronę w zestawie wyników.
pollingIntervalMillis unsigned integer
Czas w milisekundach, przez który klient powinien czekać przed ponownym sprawdzeniem, czy są nowe wiadomości na czacie na żywo.
offlineAt datetime
Data i godzina, kiedy podstawowa transmisja na żywo została wyłączona. Ta właściwość jest obecna tylko wtedy, gdy transmisja jest już offline. Wartość jest podana w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
pageInfo object
Obiekt pageInfo zawiera informacje o podziale na strony w zestawie wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zestawie 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 jest zasobem liveChatMessage.
activePollItem object
Dane ankiety w wiadomości. Każda ankieta jest zasobem liveChatMessage o typie pollEvent, który reprezentuje aktywną ankietę. Na czacie może być 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 komunikatów o błędach.

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 pobrać. 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 do interfejsu API dotyczące pobierania wiadomości są wysyłane częściej niż częstotliwość odświeżania YouTube, co niepotrzebnie zużywa przepustowość.

Wypróbuj

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