Gdy po raz pierwszy poprosisz o pobranie wiadomości czatu, interfejs API zwróci część lub całość historii czatu, w zależności od długości tej historii. Wiadomości w odpowiedzi są uporządkowane od najnowszych do najstarszych.
nextPageToken
w odpowiedzi zawiera token, który w kolejnym żądaniu wskaże kolejny zestaw wyników, które klient API powinien pobrać.- Właściwość
pollingIntervalMillis
określa, jak długo klient interfejsu API powinien czekać na żądanie dodatkowych wyników.
pageToken
na wartość nextPageToken
, a serwer API zwróci dodatkowe wiadomości czatu, jeśli będą dostępne. W tym zestawie wyników wiadomości są uporządkowane od najstarszego do najnowszego.Typowe przypadki użycia
Żądanie
Żądanie HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/messages
Parametry
W poniższej tabeli podano 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 będą zwracane. 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 liveChatMessage części zasobów, 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 pobrać zlokalizowany ciąg znaków waluty dla konkretnego języka aplikacji obsługiwanego przez stronę YouTube. Na przykład w języku angielskim waluta będzie widoczna jako $1.50 , ale w języku francuskim będzie widoczna jako 1,50$ .Wartość parametru musi być kodem języka znajdującym się na liście zwróconej 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 200 –2000 (włącznie). Wartością domyślną jest 500 . |
|
pageToken |
string Parametr pageToken wskazuje 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ęć profilu użytkownika, które powinny zostać zwrócone w zestawie wyników. Obrazy są kwadratowe. Wartość domyślna to 88 , co oznacza, że obrazy będą miały 88 na 88 pikseli. Akceptowane wartości należą do zakresu od 16 do 720 (włącznie). |
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#liveChatMessageListResponse", "etag": etag, "nextPageToken": string, "pollingIntervalMillis": unsigned integer, "offlineAt": datetime, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatMessage 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#liveChatMessageListResponse . |
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. |
pollingIntervalMillis |
unsigned integer Okres (w milisekundach), przez jaki klient powinien odczekać, aż ponownie nastąpi ankieta, aby uzyskać nowe wiadomości na czacie na żywo. |
offlineAt |
datetime Data i godzina rozpoczęcia transmisji na żywo w trybie offline. Ta właściwość jest dostępna tylko wtedy, gdy strumień jest już offline. Wartość ma format ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
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 wiadomości na czacie na żywo. Każda pozycja na liście to zasób liveChatMessage . |
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ń do pobierania wiadomości z określonego czatu na żywo. |
forbidden (403) |
liveChatDisabled |
Czat na żywo jest wyłączony w określonej transmisji. |
forbidden (403) |
liveChatEnded |
Wybrany 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 |
Żądanie zostało wysłane za szybko po poprzedniej prośbie. Ten błąd występuje, gdy żądania API dotyczące pobierania wiadomości są wysyłane częściej niż częstotliwość odświeżania w YouTube, co niepotrzebnie marnuje przepustowość. |
Wypróbuj
Użyj APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.