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 , что означает, что изображения будут иметь размер 88х88 пикселей. Допустимые значения находятся в диапазоне 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
Этаг этого ресурса.
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.