Список событий Суперчата из прямых трансляций канала за предыдущие 30 дней.
Общие варианты использования
Запрос
HTTP-запрос
GET https://www.googleapis.com/youtube/v3/superChatEvents
Авторизация
Этот запрос требует авторизации по крайней мере в одной из следующих областей ( подробнее об аутентификации и авторизации ).
Объем |
---|
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 | Запрос не авторизован должным образом для получения событий Super Chat. |
Попробуй это!
Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.
Список событий Суперчата из прямых трансляций канала за предыдущие 30 дней.
Общие варианты использования
Запрос
HTTP-запрос
GET https://www.googleapis.com/youtube/v3/superChatEvents
Авторизация
Этот запрос требует авторизации по крайней мере в одной из следующих областей ( подробнее об аутентификации и авторизации ).
Объем |
---|
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 | Запрос не авторизован должным образом для получения событий Super Chat. |
Попробуй это!
Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.