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
Этаг этого ресурса.
nextPageToken string
Токен, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в наборе результатов.
pageInfo object
Объект pageInfo инкапсулирует информацию о подкачке для набора результатов.
pageInfo. totalResults integer
Общее количество результатов в наборе результатов.
pageInfo. resultsPerPage integer
Количество результатов, включенных в ответ API.
items[] list
Список покупок в Суперчате, соответствующих критериям запроса.

Ошибки

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

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

Попробуйте!

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