Ta strona została przetłumaczona przez Cloud Translation API.

LiveChatMessages: list

Wyświetla listę wiadomości czatu na żywo z określonego czatu.

Gdy wyślesz pierwsze żądanie pobrania 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 najstarszego do najnowszego.

nextPageToken w odpowiedzi udostępnia token, który w kolejnym żądaniu wskaże następny zestaw wyników, który powinien pobrać klient interfejsu API.
Właściwość pollingIntervalMillis wskazuje, jak długo klient interfejsu API ma czekać, zanim zażąda dodatkowych wyników.

Po wysłaniu prośby o dodatkowe wyniki ustawiasz parametr pageToken na wartość nextPageToken, a serwer interfejsu API zwraca (jeśli są dostępne) dodatkowe wiadomości czatu. W tym zbiorze wyników wiadomości są uporządkowane od najstarszych do najnowszych.

Typowe przypadki użycia

Prośba

Żą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, z 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 części zasobów `liveChatMessage`, które będzie zawierać odpowiedź interfejsu API. Obsługiwane wartości to `id`, `snippet` i `authorDetails`.
Parametry opcjonalne
`hl`	`string` Parametr `hl` powoduje, że interfejs API pobiera ciąg znaków wyświetlany w zlokalizowanej walucie dla konkretnego 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 znajdującym się 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 zbiorze wyników. Akceptowane wartości to od `200` do `2000` (włącznie). Wartością domyślną jest `500`.
`pageToken`	`string` Parametr `pageToken` wskazuje w zestawie wyników konkretną stronę, która ma 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 zbiorze wyników. Obrazy są kwadratowe. Wartość domyślna to `88`, co oznacza, że zdjęcia mają wymiary 88 x 88 pikseli. Akceptowane wartości mieszczą się w przedziale od `16` do `720` (włącznie).

Treść żądania

Nie podawaj treści żądania podczas wywoływania 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
  ]
}

Właściwości

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

Właściwości
`kind`	`string` Określa typ zasobu interfejsu API. Wartością będzie `youtube#liveChatMessageListResponse`.
`etag`	`etag` 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.
`pollingIntervalMillis`	`unsigned integer` Czas (w milisekundach), przez jaki klient powinien czekać przed ponownym sondowaniem w poszukiwaniu nowych wiadomości z czatu na żywo.
`offlineAt`	`datetime` Data i godzina, kiedy transmisja na żywo przestała być dostępna. Ta usługa jest dostępna tylko wtedy, gdy strumień jest już offline. Wartość należy podać w formacie ISO 8601 (`YYYY-MM-DDThh:mm:ss.sZ`).
`pageInfo`	`object` Obiekt `pageInfo` zawiera informacje o stronicowaniu zbioru wyników.
`pageInfo.totalResults`	`integer` Łączna liczba wyników w zestawie.
`pageInfo.resultsPerPage`	`integer` Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
`items[]`	`list` Lista wiadomości na czacie na żywo. Każda pozycja na liście jest zasobem `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 szczegółów 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 nie jest włączony dla określonej transmisji.
`forbidden (403)`	`liveChatEnded`	Wybrany czat na żywo nie jest już aktywny.
`notFound (404)`	`liveChatNotFound`	Nie udało się znaleźć czatu na żywo, który próbujesz odzyskać. Sprawdź, czy wartość parametru `liveChatId` żądania jest prawidłowa.
`rateLimitExceeded`	`rateLimitExceeded`	Prośba została wysłana zbyt szybko po poprzednim żądaniu. Ten błąd występuje, gdy żądania do interfejsu API pobierania wiadomości 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 oraz odpowiedź interfejsu API.