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 указывает, что учётные данные запроса идентифицируют пользователя 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#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
Список изображений плейлиста, соответствующих критериям запроса.