Playlists: list

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

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

Примеры использования

Запрос

HTTP-запрос

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

Параметры

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

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

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

Ниже перечислены названия part, которые можно включить в значение параметра.
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Фильтры (укажите ровно один из следующих параметров)
channelId string
Это значение указывает, что API должен возвращать только плейлисты указанного канала.
id string
Параметр id содержит список идентификаторов плейлистов YouTube, разделенных запятыми. В ресурсе playlist свойство id указывает на идентификатор плейлиста на YouTube.
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 указывает, что учетные данные, которые используются для авторизации запроса, идентифицируют пользователя системы управления контентом YouTube, действующего от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для партнеров YouTube, которым принадлежит множество каналов. Владельцы контента могут пройти аутентификацию один раз и получить доступ к данным всех своих видео и каналов. Аккаунт CMS, с помощью которого пользователь проходит аутентификацию, должен быть связан с указанным владельцем контента YouTube.
onBehalfOfContentOwnerChannel string
Этот параметр можно использовать только в авторизованном запросе. Примечание. Этот параметр предназначен исключительно для партнеров YouTube.

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

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

Тело запроса

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

Ответ

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

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

Свойства

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

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

Ошибки

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

Тип ошибки Сведения об ошибке Описание
forbidden (403) channelClosed Канал, указанный в параметре channelId, закрыт.
forbidden (403) channelSuspended Канал, указанный в параметре channelId, заблокирован.
forbidden (403) playlistForbidden Плейлист, указанный в параметре id, не поддерживает запрос, или запрос не авторизован должным образом.
notFound (404) channelNotFound Не удалось найти канал, указанный в параметре channelId.
notFound (404) playlistNotFound Не удалось найти плейлист, указанный в параметре id запроса.
invalidValue (400) playlistOperationUnsupported API не поддерживает возможность просмотра указанного плейлиста. Например, вы не можете получить список "Смотреть позже".

Попробовать

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