Ресурс playlist представляет плейлист 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 |
stringURL изображения. |
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Локализованное описание плейлиста. |