Ресурс 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 | 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. 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 . |