Ресурс playlistItem идентифицирует другой ресурс, например видео, включенное в плейлист. Кроме того, ресурс playlistItem содержит сведения о включенном ресурсе, которые относятся к тому, как он используется в плейлисте.
На YouTube плейлисты также используются для того, чтобы показывать список загруженных видео на канале. Каждое playlistItem в этом списке представляет собой одно загруженное видео. Идентификатор плейлиста для этого списка можно получить из ресурса channel для определенного канала. Затем вы можете использовать метод playlistItems.list для списка.
Методы
API поддерживает следующие методы для ресурсов playlistItems:
- list
- Возвращает коллекцию объектов playlistItem, соответствующих параметрам запроса к API. Вы можете получить все элементы из определенного плейлиста или один или несколько элементов по их уникальным идентификаторам. Перейти
- insert
- Добавляет ресурс в плейлист. Перейти
- update
- Изменяет элемент плейлиста. Например, вы можете изменить позицию объекта в плейлисте. Перейти
- delete
- Удаляет элемент плейлиста. Перейти
Представление ресурса
Ниже показана структура JSON для ресурса playlistItems.
{
"kind": "youtube#playlistItem",
"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,
"videoOwnerChannelTitle": string,
"videoOwnerChannelId": string,
"playlistId": string,
"position": unsigned integer,
"resourceId": {
"kind": string,
"videoId": string,
}
},
"contentDetails": {
"videoId": string,
"startAt": string,
"endAt": string,
"note": string,
"videoPublishedAt": datetime
},
"status": {
"privacyStatus": string
}
}Свойства
В таблице ниже приведены свойства, которые используются в этом ресурсе.
| Свойства | |
|---|---|
kind |
stringОпределяет тип ресурса API. Значение будет youtube#playlistItem. |
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.videoOwnerChannelTitle |
stringНазвание канала, на который загружено видео. |
snippet.videoOwnerChannelId |
stringИдентификатор канала, на который загружено видео. |
snippet.playlistId |
stringИдентификатор, который YouTube использует для уникальной идентификации плейлиста, в котором находится элемент плейлиста. |
snippet.position |
unsigned integerПорядок, в котором элемент появляется в плейлисте. Значение представляет собой индекс, начинающийся с нуля. Таким образом, первый элемент имеет позицию 0, второй – 1 и т. д. |
snippet.resourceId |
objectОбъект id содержит информацию, которая позволяет однозначно идентифицировать ресурс, включенный в плейлист в качестве элемента плейлиста. |
snippet.resourceId.kind |
stringТип ресурса, на который ссылается объект. |
snippet.resourceId.videoId |
stringЕсли значение свойства snippet.resourceId.kind – youtube#video, то это свойство будет присутствовать, а его значение будет содержать идентификатор, который YouTube использует для уникальной идентификации видео в плейлисте. |
contentDetails |
objectОбъект contentDetails включается в ресурс, если добавленный элемент является видео YouTube. Объект содержит дополнительную информацию о видео. |
contentDetails.videoId |
stringИдентификатор, который YouTube использует для уникальной идентификации видео. Чтобы получить ресурс video, задайте для параметра запроса id это значение в запросе к API. |
contentDetails.startAt |
stringПримечание. Это свойство устарело, и если оно задано, его значение игнорируется. Время в секундах с начала видео, когда оно должно начать воспроизводиться. Владелец плейлиста может указать, с какого момента должно начинаться воспроизведение видео и на каком моменте оно должно заканчиваться. Значение по умолчанию: 0. |
contentDetails.endAt |
stringПримечание. Это свойство устарело, и если оно задано, его значение игнорируется. Время в секундах с начала видео, когда оно должно остановиться. Владелец плейлиста может указать, с какого момента должно начинаться воспроизведение видео и на каком моменте оно должно заканчиваться. По умолчанию считается, что video.endTime – это конец видео. |
contentDetails.note |
stringПримечание, созданное пользователем для этого объекта. Максимальная длина значения свойства – 280 символов. |
contentDetails.videoPublishedAt |
datetimeДата и время публикации видео на YouTube. Значение указывается в формате ISO 8601. |
status |
objectОбъект status содержит информацию о статусе конфиденциальности элемента плейлиста. |
status.privacyStatus |
stringСтатус конфиденциальности элемента плейлиста. Владелец канала, на который загружено видео, может задать это значение с помощью метода videos.insert или videos.update. |