Эта страница переведена с помощью Cloud Translation API.

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` указывает, что учетные данные авторизации запроса идентифицируют пользователя CMS YouTube, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров 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` 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.