SuperChatEvents: list

Показывает события Суперчата из трансляций канала за последние 30 дней.

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

Запрос

HTTP-запрос

GET https://www.googleapis.com/youtube/v3/superChatEvents

Авторизация

Для этого запроса требуется авторизация по крайней мере с одной из следующих областей действия. Подробнее об аутентификации и авторизации можно узнать в статье Как реализовать аутентификацию OAuth 2.0.

Область действия
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part определяет, какие части ресурса superChatEvent будут включены в ответ API. Допустимые значения: id (да) и snippet (нет).
Необязательные параметры
hl string
Параметр hl указывает серверу API, что значение свойства snippet.displayString, в котором указана сумма заказа и валюта Суперчата, нужно отформатировать в соответствии с правилами определенного языка. Значение параметра должно быть кодом языка из списка, возвращаемого методом i18nLanguages.list. Значение по умолчанию – en. Это означает, что режим работы по умолчанию – форматирование отображаемых строк так, как они использовались бы в английском языке. Например, по умолчанию строка форматируется как $1.00, а не $1,00.
maxResults unsigned integer
Параметр maxResults задает максимальное количество объектов, которые должны быть возвращены в наборе результатов. Допустимые значения: от 1 до 50 включительно. Значение по умолчанию: 5.
pageToken string
Параметр pageToken определяет конкретную страницу в наборе результатов, которую необходимо вернуть. В ответе API свойства nextPageToken и prevPageToken указывают на другие страницы, которые можно получить.

Тело запроса

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

Ответ

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

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

Свойства

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

Свойства
kind string
Определяет тип ресурса API. Значение будет youtube#superChatEventListResponse.
etag etag
Тег ETag этого ресурса.
nextPageToken string
Токен, который можно использовать в качестве значения параметра pageToken, чтобы получить следующую страницу результатов.
pageInfo object
Объект pageInfo содержит информацию о постраничной организации набора результатов.
pageInfo.totalResults integer
Общее количество результатов в наборе.
pageInfo.resultsPerPage integer
Количество результатов, включенных в ответ API.
items[] list
Список покупок в Суперчате, соответствующих критериям запроса.

Ошибки

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

Тип ошибки Сведения об ошибке Описание
forbidden (403) insufficientPermissions У запроса нет разрешения на получение событий Суперчата.

Попробовать

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