Sponsors: list

Примечание. Этот метод устарел с 31 марта 2020 г. Он был заменен members.list . Информацию об этом методе можно найти в документации API данных YouTube.

Метод sponsors.list перестанет поддерживаться 30 сентября 2020 г. или после этой даты. Клиентам API следует обновить вызовы метода sponsors.list , чтобы вместо него использовать members.list .

Перечисляет участников (ранее известных как «спонсоры») канала. Запрос API должен быть авторизован владельцем канала.

Распространенные случаи использования

Запрос

HTTP-запрос

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

Авторизация

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

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

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part указывает части ресурсов sponsor , которые будут включены в ответ API. Поддерживаемые значения: id и snippet .
Дополнительные параметры
filter string
Параметр filter указывает, спонсоров какого канала следует возвращать. Значение по умолчанию — newest .

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

Тело запроса

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

Ответ

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

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

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

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

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

Ошибки

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

Тип ошибки Детализация ошибки Описание
forbidden (403) insufficientPermissions У вас нет необходимых разрешений для просмотра спонсоров канала.
invalidValue (400) invalidValueInRequest Запрос содержит недопустимое значение.
invalidValue (400) sponsorshipNotEnabledForChannelId На канале не включена спонсорская поддержка.