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