Ресурс playlistItem идентифицирует другой ресурс, например видео, который включен в плейлист. Кроме того, ресурс playlistItem содержит подробную информацию о включенном ресурсе, которая относится непосредственно к тому, как этот ресурс используется в данном плейлисте.
YouTube также использует плейлист для идентификации списка загруженных видео канала, при этом каждый playlistItem в этом списке представляет собой одно загруженное видео. Вы можете получить идентификатор плейлиста для этого списка из ресурса channel для данного канала. Затем вы можете использовать метод playlistItems.list для доступа к этому списку.
Методы
API поддерживает следующие методы для ресурсов playlistItems :
- list
- Возвращает коллекцию элементов плейлиста, соответствующих параметрам запроса 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 | etagEtag этого ресурса. |
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 . |