Возвращает коллекцию изображений плейлиста, соответствующих параметрам запроса 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 Параметр | |
Фильтры (укажите ровно один из следующих параметров) | ||
id | string Параметр id указывает список, разделенный запятыми, из одного или нескольких уникальных идентификаторов изображений списка воспроизведения. | |
playlistId | string Параметр playlistId указывает уникальный идентификатор списка воспроизведения, для которого вы хотите получить изображения списка воспроизведения. Обратите внимание: хотя это необязательный параметр, каждый запрос на получение изображений списка воспроизведения должен указывать значение либо для параметра id , либо для параметра playlistId . | |
Дополнительные параметры | ||
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#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 Список изображений плейлиста, соответствующих критериям запроса. |