ChannelSections: list

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

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

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

Запрос

HTTP-запрос

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

Параметры

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

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

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

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

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

Тело запроса

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

Ответ

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

{
  "kind": "youtube#channelSectionListResponse",
  "etag": etag,
  "items": [
    channelSection Resource
  ]
}

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

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

Характеристики
kind string
Идентифицирует тип ресурса API. Значением будет youtube#channelSectionListResponse .
etag etag
Этаг этого ресурса.
items[] list
Список ChannelSections, соответствующих критериям запроса.

Ошибки

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

Тип ошибки Детализация ошибки Описание
forbidden (403) channelSectionForbidden Запрашивающему не разрешен доступ к запрошенным разделам канала.
invalidValue (400) idInvalid В запросе указан неверный идентификатор раздела канала.
invalidValue (400) invalidCriteria Запрос не удалось выполнить, поскольку критерии фильтра недействительны.
notFound (404) channelNotFound Канал, связанный с запросом, не найден.
notFound (404) channelSectionNotFound Раздел канала, связанный с запросом, не найден.

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

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