Channels: list

Примечание. Значение свойства statistics.subscriberCount ресурса channel было обновлено, чтобы отразить изменение политики YouTube, влияющее на способ отображения количества подписчиков. Дополнительную информацию см. в истории изменений или в Справочном центре YouTube .

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

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

Общие варианты использования

Запрос

HTTP-запрос

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

Авторизация

Запрос, извлекающий часть auditDetails для ресурса channel , должен предоставить токен авторизации, содержащий область https://www.googleapis.com/auth/youtubepartner-channel-audit . Кроме того, любой токен, который использует эту область, должен быть отозван, когда MCN решает принять или отклонить канал или в течение двух недель с даты выпуска токена.

Параметры

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

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

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

Следующий список содержит имена part , которые можно включить в значение параметра:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Фильтры (укажите ровно один из следующих параметров)
categoryId string
Этот параметр устарел. Параметр categoryId указывает категорию гида YouTube и может использоваться для запроса каналов YouTube, связанных с этой категорией.
forUsername string
Параметр forUsername указывает имя пользователя YouTube, тем самым запрашивая канал, связанный с этим именем пользователя.
id string
Параметр id указывает разделенный запятыми список идентификаторов каналов YouTube для извлекаемых ресурсов. В ресурсе channel свойство id указывает идентификатор канала YouTube.
managedByMe boolean
Этот параметр можно использовать только в правильно авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube.

Установите для этого параметра значение true , чтобы API возвращал только те каналы, которыми управляет владелец контента, указанный в параметре onBehalfOfContentOwner . Пользователь должен быть аутентифицирован как учетная запись CMS, связанная с указанным владельцем контента, и должен быть указан onBehalfOfContentOwner .
mine boolean
Этот параметр можно использовать только в правильно авторизованном запросе . Установите для этого параметра значение true , чтобы API возвращал только каналы, принадлежащие аутентифицированному пользователю.
Дополнительные параметры
hl string
Параметр hl дает указание API получить метаданные локализованных ресурсов для определенного языка приложения, поддерживаемого веб-сайтом YouTube . Значение параметра должно быть кодом языка, включенным в список, возвращаемый методом i18nLanguages.list .

Если сведения о локализованных ресурсах доступны на этом языке, объект snippet.localized ресурса будет содержать локализованные значения. Однако если локализованные сведения недоступны, объект snippet.localized будет содержать сведения о ресурсе на языке ресурса по умолчанию .
maxResults unsigned integer
Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в результирующем наборе. Допустимые значения: от 0 до 50 включительно. Значение по умолчанию — 5 .
onBehalfOfContentOwner string
Этот параметр можно использовать только в правильно авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube.

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

Тело запроса

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

Ответ

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

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

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

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

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

Ошибки

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

Тип ошибки Сведения об ошибке Описание
badRequest (400) invalidCriteria Можно указать максимум один из следующих фильтров: id , categoryId , mine , managedByMe , forUsername . В случае аутентификации владельца контента через параметр onBehalfOfContentOwner можно указать только id или managedByMe .
forbidden (403) channelForbidden Канал, указанный параметром id , не поддерживает запрос или запрос не авторизован должным образом.
notFound (404) categoryNotFound Категория, идентифицированная параметром categoryId , не может быть найдена. Используйте метод guideCategories.list для получения списка допустимых значений.
notFound (404) channelNotFound Канал, указанный в параметре id не найден.

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

Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.