FanFundingEvents: list

Примечание. Это объявление об устаревании.

Поддержка функции Fan Funding устарела, а 28 февраля 2017 года API Fan Funding будет отключен. Это объявление об устаревании совпадает с выпуском новой функции Super Chat на YouTube.

Список мероприятий по финансированию канала фанатами. Запрос API должен быть авторизован владельцем канала.

Запрос

HTTP-запрос

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

Авторизация

Этот запрос требует авторизации по крайней мере в одной из следующих областей ( подробнее об аутентификации и авторизации ).

Объем
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part указывает части ресурса fanFundingEvent , которые будут включены в ответ API. Поддерживаемые значения: id и snippet .
Дополнительные параметры
hl string
Параметр hl дает указание API получить строку отображения локализованной валюты для определенного языка приложения, поддерживаемого веб-сайтом YouTube . Например, на английском языке валюта будет отображаться как $1.50 , а на французском — как 1,50$ .

Значение параметра должно быть кодом языка, включенным в список, возвращаемый методом i18nLanguages.list .
maxResults unsigned integer
Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в результирующем наборе. Допустимые значения: от 0 до 50 включительно. Значение по умолчанию — 5 .
pageToken string
Параметр pageToken определяет конкретную страницу в результирующем наборе, которую серверу API предлагается вернуть. В ответе API свойство nextPageToken определяет следующую страницу результатов для запроса.

Тело запроса

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

Ответ

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

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

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

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

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

Ошибки

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

Тип ошибки Сведения об ошибке Описание
forbidden (403) insufficientPermissions У вас недостаточно прав для просмотра мероприятий по сбору средств от фанатов на канале.
invalidValue (400) fanFundingNotEnabledForChannelId На канале не включено финансирование от фанатов.