LiveChatMessages: list

Возвращает список сообщений в определенном чате.

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

Влияние на квоту. Вызов этого метода расходует 5 единиц квоты.

Примеры использования

Запрос

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.

Первоначальный запрос, выполненный без токена продолжения, будет содержать только последние сообщения. Если оно указано, то может быть меньше maxResults.

API не извлекает сообщения, которые старше тех, что были возвращены в исходном запросе без токена продолжения.
pageToken string
Параметр pageToken определяет конкретную страницу в наборе результатов, которую необходимо вернуть. В ответе API свойство nextPageToken позволяет определить другие страницы, которые можно получить.
profileImageSize unsigned integer
Параметр profileImageSize задает размер фото профиля пользователя, которые должны быть возвращены в наборе результатов. Изображения квадратные. Значение по умолчанию – 88, то есть размер изображений будет 88 x 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
Тег 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 и ответ.