Ресурс playlist
представляет собой плейлист YouTube. Плейлист — это набор видео, которые можно просматривать последовательно и делиться ими с другими пользователями. По умолчанию плейлисты доступны для просмотра другим пользователям, но могут быть как общедоступными, так и закрытыми.
YouTube также использует плейлисты для определения специальных подборок видео для канала, например:
- загруженные видео
- положительно оцененные (понравившиеся) видео
channel resource
для конкретного канала.Затем вы можете использовать метод
playlistItems.list
для получения любого из этих списков. Вы также можете добавлять или удалять элементы из этих списков, вызывая методы playlistItems.insert
и playlistItems.delete
.Методы
API поддерживает следующие методы для ресурсов playlists
:
- list
- Возвращает коллекцию плейлистов, соответствующих параметрам запроса API. Например, вы можете получить все плейлисты, принадлежащие аутентифицированному пользователю, или один или несколько плейлистов по их уникальным идентификаторам. Попробуйте прямо сейчас .
- insert
- Создаёт плейлист. Попробуйте прямо сейчас .
- update
- Изменяет плейлист. Например, вы можете изменить название, описание или статус конфиденциальности плейлиста. Попробуйте прямо сейчас .
- delete
- Удаляет плейлист. Попробуйте сейчас .
Представление ресурсов
Следующая структура JSON показывает формат ресурса playlists
:
{ "kind": "youtube#playlist", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "defaultLanguage": string, "localized": { "title": string, "description": string } }, "status": { "privacyStatus": string, "podcastStatus": enum }, "contentDetails": { "itemCount": unsigned integer }, "player": { "embedHtml": string }, "localizations": { (key): { "title": string, "description": string } } }
Характеристики
В следующей таблице определены свойства, которые отображаются в этом ресурсе:
Характеристики | |
---|---|
kind | string Определяет тип ресурса API. Значение будет youtube#playlist . |
etag | etag Etag этого ресурса. |
id | string Идентификатор, который YouTube использует для уникальной идентификации плейлиста. |
snippet | object Объект snippet содержит основные сведения о плейлисте, такие как его название и описание. |
snippet. publishedAt | datetime Дата и время создания плейлиста. Значение указывается в формате ISO 8601 . |
snippet. channelId | string Идентификатор, который YouTube использует для уникальной идентификации канала, опубликовавшего плейлист. |
snippet. title | string Название плейлиста. |
snippet. description | string Описание плейлиста. |
snippet. thumbnails | object Карта миниатюр, связанных с плейлистом. Для каждого объекта на карте ключ — это имя миниатюры, а значение — объект, содержащий дополнительную информацию об этой миниатюре. |
snippet.thumbnails. (key) | object Допустимые значения ключа:
|
snippet.thumbnails.(key). url | string URL-адрес изображения. |
snippet.thumbnails.(key). width | unsigned integer Ширина изображения. |
snippet.thumbnails.(key). height | unsigned integer Высота изображения. |
snippet. channelTitle | string Название канала, которому принадлежит видео. |
snippet. tags[] | list Это свойство устарело. Ключевые теги, связанные с плейлистом. |
snippet. defaultLanguage | string Язык текста в свойствах snippet.title и snippet.description ресурса playlist . |
snippet. localized | object Объект snippet.localized содержит либо локализованное название и описание плейлиста, либо название на языке по умолчанию для метаданных плейлиста.
localizations для добавления, обновления или удаления локализованных заголовков. |
snippet.localized. title | string Локализованное название плейлиста. |
snippet.localized. description | string Локализованное описание плейлиста. |
status | object Объект status содержит информацию о статусе плейлиста. |
status. privacyStatus | string Статус конфиденциальности плейлиста. Допустимые значения для этого свойства:
|
status. podcastStatus | string Статус подкаста в плейлисте. Если значение — enabled , плейлист помечается как подкаст-шоу. Чтобы статус подкаста в плейлисте был enabled , у него должно быть изображение плейлиста .Допустимые значения для этого свойства:
|
contentDetails | object Объект contentDetails содержит информацию о содержимом плейлиста, включая количество видео в плейлисте. |
contentDetails. itemCount | unsigned integer Количество видео в плейлисте. |
player | object Объект player содержит информацию, которую можно использовать для воспроизведения списка воспроизведения во встроенном проигрывателе. |
player. embedHtml | string Тег <iframe> , в который встраивается проигрыватель, воспроизводящий плейлист. |
localizations | object Объект localizations инкапсулирует переводы метаданных плейлиста. |
localizations. (key) | object Язык локализованного текста, связанного со значением ключа. Значение представляет собой строку, содержащую код языка BCP-47 . |
localizations.(key). title | string Локализованное название плейлиста. |
localizations.(key). description | string Локализованное описание плейлиста. |