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