Members: list

Примечание. Эту конечную точку могут использовать только отдельные авторы для отправки запросов на собственный канал YouTube с поддержкой членства. Обратитесь к своему представителю 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 каналов.