Subscriptions: list

Возвращает ресурсы подписки, соответствующие критериям запроса API.

Влияние квоты: вызов этого метода имеет стоимость квоты , равную 1 единице.

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

Запрос

HTTP-запрос

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

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part указывает разделенный запятыми список одного или нескольких свойств ресурсов subscription , которые будут включены в ответ API.

Если параметр определяет свойство, содержащее дочерние свойства, дочерние свойства будут включены в ответ. Например, в ресурсе subscription свойство snippet содержит другие свойства, такие как отображаемый заголовок подписки. Если вы установите part=snippet , ответ API также будет содержать все эти вложенные свойства.

Следующий список содержит названия part , которые можно включить в значение параметра:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Фильтры (укажите ровно один из следующих параметров)
channelId string
Параметр channelId указывает идентификатор канала YouTube. API вернет только подписки этого канала.
id string
Параметр id указывает разделенный запятыми список идентификаторов подписки YouTube для извлекаемых ресурсов. В ресурсе subscription свойство id указывает идентификатор подписки YouTube.
mine boolean
Этот параметр можно использовать только в должным образом авторизованном запросе . Установите для этого параметра значение true чтобы получить канал подписок прошедшего проверку подлинности пользователя.
myRecentSubscribers boolean
Этот параметр можно использовать только в должным образом авторизованном запросе . Установите для этого параметра значение true чтобы получить ленту подписчиков аутентифицированного пользователя в обратном хронологическом порядке (сначала самые новые).

Обратите внимание, что максимальное количество подписчиков, возвращаемых через этот API, может быть ограничено.
mySubscribers boolean
Этот параметр можно использовать только в должным образом авторизованном запросе . Установите для этого параметра значение true чтобы получить канал подписчиков аутентифицированного пользователя в произвольном порядке. Обратите внимание, что максимальное количество подписчиков, возвращаемых через этот API, может быть ограничено.
Дополнительные параметры
forChannelId string
Параметр forChannelId указывает список идентификаторов каналов, разделенных запятыми. Тогда ответ API будет содержать только подписки, соответствующие этим каналам.
maxResults unsigned integer
Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в наборе результатов. Допустимые значения: от 0 до 50 включительно. Значение по умолчанию — 5 .
onBehalfOfContentOwner string
Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube.

Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube.
onBehalfOfContentOwnerChannel string
Этот параметр можно использовать только в должным образом авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube.

Параметр onBehalfOfContentOwnerChannel указывает идентификатор канала YouTube, на который добавляется видео. Этот параметр является обязательным, если в запросе указано значение параметра onBehalfOfContentOwner , и его можно использовать только вместе с этим параметром. Кроме того, запрос должен быть авторизован с использованием учетной записи CMS, связанной с владельцем контента, указанным в параметре onBehalfOfContentOwner . Наконец, канал, указанный в значении параметра onBehalfOfContentOwnerChannel , должен быть связан с владельцем контента, указанным в параметре onBehalfOfContentOwner .

Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Он позволяет владельцам контента один раз пройти аутентификацию и выполнять действия от имени канала, указанного в значении параметра, без необходимости предоставления учетных данных аутентификации для каждого отдельного канала.
order string
Параметр order указывает метод, который будет использоваться для сортировки ресурсов в ответе API. Значение по умолчанию — SUBSCRIPTION_ORDER_RELEVANCE .

Приемлемые значения:
  • alphabetical – сортировка по алфавиту.
  • relevance – сортировка по релевантности.
  • unread — сортировка по порядку активности.
pageToken string
Параметр pageToken идентифицирует конкретную страницу в наборе результатов, которая должна быть возвращена. В ответе API свойства nextPageToken и prevPageToken идентифицируют другие страницы, которые можно получить.

Тело запроса

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

Ответ

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

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

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

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

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

Ошибки

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

Тип ошибки Детализация ошибки Описание
forbidden (403) accountClosed Подписки не удалось получить, поскольку учетная запись подписчика закрыта.
forbidden (403) accountSuspended Не удалось получить подписку, поскольку учетная запись подписчика заблокирована.
forbidden (403) subscriptionForbidden Запрашивающей стороне не разрешен доступ к запрошенным подпискам.
notFound (404) subscriberNotFound Абонент, указанный в запросе, не найден.

Попробуй это!

Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.