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
  ]
}

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

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

Характеристики
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 .

Ошибки

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

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

Попробуй это!

Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.