LiveChatMessages: list

Выводит список сообщений чата для определенного чата.

При первом запросе на получение сообщений чата API возвращает часть или всю историю чата, в зависимости от её длины. Сообщения в ответе упорядочены от самых старых к самым новым.
  • nextPageToken в ответе предоставляет токен, который в вашем следующем запросе будет определять следующий набор результатов, которые должен получить ваш клиент API.
  • Свойство pollingIntervalMillis указывает, как долго ваш API-клиент должен ждать, прежде чем запросить дополнительные результаты.
При запросе дополнительных результатов вы устанавливаете параметр pageToken равным значению nextPageToken , и API-сервер возвращает дополнительные сообщения чата, если они доступны. В этом наборе результатов сообщения сортируются от самых старых к самым новым.

Распространенные варианты использования

Запрос

HTTP-запрос 

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

Параметры

В следующей таблице перечислены параметры, поддерживаемые этим запросом. Все перечисленные параметры являются параметрами запроса.

Параметры
Обязательные параметры
liveChatId string
Параметр liveChatId указывает идентификатор чата, сообщения которого будут возвращены. Идентификатор чата, связанного с трансляцией, возвращается в свойстве snippet.liveChatId ресурса liveBroadcast .
part string
Параметр part определяет части ресурса liveChatMessage , которые будут включены в ответ API. Поддерживаемые значения: id , snippet и authorDetails .
Необязательные параметры
hl string
Параметр hl указывает API получить локализованную строку отображения валюты для конкретного языка приложения, поддерживаемого сайтом YouTube . Например, на английском языке валюта будет отображаться как $1.50 , а на французском — как 1,50$ .

Значение параметра должно быть кодом языка, включенным в список, возвращаемый методом i18nLanguages.list .
maxResults unsigned integer
Параметр maxResults определяет максимальное количество сообщений, которые должны быть возвращены в наборе результатов. Допустимые значения — от 200 до 2000 включительно. Значение по умолчанию — 500 .
pageToken string
Параметр pageToken идентифицирует конкретную страницу в наборе результатов, которую необходимо вернуть. В ответе API свойство nextPageToken идентифицирует другие страницы, которые можно получить.
profileImageSize unsigned integer
Параметр profileImageSize определяет размер изображений профиля пользователя , которые должны быть возвращены в результирующем наборе. Изображения имеют квадратную форму. Значение по умолчанию — 88 , то есть изображения будут иметь размер 88x88 пикселей. Допустимые значения находятся в диапазоне 16 до 720 включительно.

Текст запроса

Не указывайте тело запроса при вызове этого метода.

Ответ

В случае успеха этот метод возвращает тело ответа со следующей структурой:

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage Resource
}

Характеристики

В следующей таблице определены свойства, которые отображаются в этом ресурсе:

Характеристики
kind string
Определяет тип ресурса API. Значение будет youtube#liveChatMessageListResponse .
etag etag
Etag этого ресурса.
nextPageToken string
Токен, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в наборе результатов.
pollingIntervalMillis unsigned integer
Количество времени (в миллисекундах), которое клиент должен ждать, прежде чем снова начать опрос на предмет новых сообщений в чате.
offlineAt datetime
Дата и время, когда трансляция была отключена. Это свойство присутствует только в том случае, если трансляция уже отключена. Значение указывается в формате ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ).
pageInfo object
Объект pageInfo инкапсулирует информацию о страницах для набора результатов.
pageInfo. totalResults integer
Общее количество результатов в наборе результатов.
pageInfo. resultsPerPage integer
Количество результатов, включенных в ответ API.
items[] list
Список сообщений. Каждый элемент списка — это ресурс liveChatMessage .
activePollItem object
Данные опроса в сообщении. Каждый опрос — это ресурс liveChatMessage с типом pollEvent , представляющим активный опрос. В одном чате может быть только один опрос.

Ошибки

В следующей таблице перечислены сообщения об ошибках, которые API может вернуть в ответ на вызов этого метода. Подробнее см. в документации по сообщениям об ошибках .

Тип ошибки Подробности ошибки Описание
forbidden (403) forbidden У вас нет разрешений, необходимых для получения сообщений для указанного чата.
forbidden (403) liveChatDisabled Онлайн-чат не включен для указанной трансляции.
forbidden (403) liveChatEnded Указанный чат больше не активен.
notFound (404) liveChatNotFound Онлайн-чат, который вы пытаетесь получить, не найден. Проверьте значение параметра liveChatId в запросе, чтобы убедиться в его корректности.
rateLimitExceeded rateLimitExceeded Запрос был отправлен слишком быстро после предыдущего запроса. Эта ошибка возникает, когда запросы API на получение сообщений отправляются чаще, чем частота обновления YouTube, что приводит к неоправданной трате полосы пропускания.

Попробуйте!

Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.