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