PlaylistImages: list

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

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

Запрос

HTTP-запрос

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

Авторизация

Для выполнения этого запроса требуется авторизация как минимум в одной из следующих областей доступа. Подробнее…

Область действия
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Параметры

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

Параметры
Обязательные параметры
part	string Параметр part представляет собой список (разделенный запятыми) одного или нескольких свойств ресурса playlistImage, которые будут включены в ответ API. Если параметр определяет свойство, содержащее дочерние свойства, они также будут включены в ответ.
Фильтры (укажите ровно один из следующих параметров)
id	string Параметр id указывает список уникальных идентификаторов изображений плейлиста, разделенных запятыми.
playlistId	string Параметр playlistId указывает уникальный идентификатор плейлиста, для которого вы хотите получить изображения. Обратите внимание, что, хотя этот параметр является необязательным, в каждом запросе на получение изображений плейлистов должно быть указано значение параметра id или playlistId.
Необязательные параметры
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#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages Resource
          ]
        }

Свойства

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

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