Список участников (ранее известных как «спонсоры») канала. Запрос 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. Установите значение параметра на одно из следующих значений:
| |
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 каналов. |