Members: list

Примечание. Этот конечный адрес может использоваться только авторами, чтобы отправлять запросы для своих каналов, на которых включено спонсорство. Чтобы запросить доступ, обратитесь к представителю Google или YouTube.

Возвращает список спонсоров канала. Запрос к API должен быть авторизован владельцем канала.

Влияние на квоту. Вызов этого метода имеет стоимость квоты в 2 единицы.

Запрос

HTTP-запрос

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

Авторизация

Для этого запроса требуется авторизация в указанной ниже области действия:

Область действия
https://www.googleapis.com/auth/youtube.channel-memberships.creator

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part определяет свойства ресурса member, которые будут включены в ответ API. Установите для параметра значение snippet.
Необязательные параметры
mode string
Параметр mode указывает, какие участники будут включены в ответ API. Установите для параметра одно из следующих значений:
  • all_current (по умолчанию) – список текущих участников, отсортированный от новых к старым. Если используется это значение, то конец списка достигается, когда ответ API не содержит nextPageToken.
  • updates – показывать только спонсоров, которые оформили или улучшили спонсорство после предыдущего вызова API. Обратите внимание, что первый вызов запускает новый поток обновлений, но не возвращает участников. Чтобы начать получать обновления, вам нужно отправлять запросы к конечной точке, используя метод nextPageToken, с нужной вам частотой.

    Обратите внимание, что при использовании этого значения ответ API всегда содержит nextPageToken.
maxResults unsigned integer
Параметр maxResults определяет максимальное количество элементов, которые должны быть возвращены в наборе результатов. Допустимые значения: от 0 до 1000 включительно. Значение по умолчанию: 5.
pageToken string
Параметр pageToken позволяет указать, какую страницу из набора результатов нужно вернуть. Токен связан с параметром mode, который использовался в исходном запросе к API, поэтому вы не можете использовать токен страницы, полученный в одном режиме, для последующего переключения в другой режим.
hasAccessToLevel string
Значение параметра hasAccessToLevel – это идентификатор уровня, который указывает минимальный уровень, который должны иметь участники в наборе результатов.
filterByMemberChannelId string
Параметр filterByMemberChannelId задает список идентификаторов каналов, разделенных запятыми, которые можно использовать для проверки статуса подписки определенных пользователей. Пример: UC_1,UC_2,UC_3. За один вызов можно указать не более 100 каналов.

Тело запроса

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

Ответ

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

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

Свойства

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

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

Ошибки

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

Тип ошибки Сведения об ошибке Описание
badRequest (400) channelMembershipsNotEnabled На канале автора, который авторизует запрос, не включено спонсорство.
badRequest (400) invalidMode Недопустимое значение параметра mode. Эта ошибка может возникнуть, если в параметре pageToken указан токен, полученный в режиме, отличном от заданного.
badRequest (400) invalidPageToken Недопустимое значение параметра pageToken. Эта ошибка может возникнуть, если токен страницы, используемый в запросе, недействителен или не распознан.
badRequest (400) invalidHasAccessToLevel Недопустимое значение параметра hasAccessToLevel. Уровня с указанным значением id не существует.
badRequest (400) invalidFilterByMemberChannelId Недопустимое значение параметра filterByMemberChannelId. Эта ошибка возникает, если в значении параметра filterByMemberChannelId указано более 100 каналов.