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

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