Eine playlistItem
-Ressource identifiziert eine andere Ressource, z. B. ein Video, die in einer Playlist enthalten ist. Darüber hinaus enthält die Ressource playlistItem
Details zur enthaltenen Ressource, die sich speziell darauf beziehen, wie diese Ressource in dieser Playlist verwendet wird.
YouTube verwendet außerdem eine Playlist, um die Liste der hochgeladenen Videos eines Kanals zu ermitteln, wobei jede playlistItem
in dieser Liste für ein hochgeladenes Video steht. Du kannst die Playlist-ID für diese Liste aus dem channel resource
des jeweiligen Kanals abrufen. Sie können dann die Methode playlistItems.list
für die Liste verwenden.
Methoden
Die API unterstützt die folgenden Methoden für playlistItems
-Ressourcen:
- list
- Gibt eine Sammlung von Playlist-Elementen zurück, die den API-Anfrageparametern entsprechen. Du kannst alle Playlist-Elemente in einer bestimmten Playlist oder ein oder mehrere Playlist-Elemente anhand ihrer eindeutigen IDs abrufen. Hier kannst du die Funktion ausprobieren.
- insert
- Fügt einer Playlist eine Ressource hinzu. Hier kannst du die Funktion ausprobieren.
- Update
- Ändert ein Playlist-Element. Du könntest zum Beispiel die Position des jeweiligen Elements in der Playlist aktualisieren. Hier kannst du die Funktion ausprobieren.
- delete
- Löscht ein Playlist-Element. Hier kannst du die Funktion ausprobieren.
Ressourcendarstellung
Die folgende JSON-Struktur zeigt das Format einer playlistItems
-Ressource:
{ "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 } }
Attribute
In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource angezeigt werden:
Attribute | |
---|---|
kind |
string Identifiziert den Typ der API-Ressource. Der Wert ist youtube#playlistItem . |
etag |
etag Das ETag dieser Ressource. |
id |
string Die ID, die YouTube verwendet, um das Playlist-Element eindeutig zu identifizieren. |
snippet |
object Das snippet -Objekt enthält grundlegende Details zum Playlist-Element, z. B. den Titel und die Position in der Playlist. |
snippet.publishedAt |
datetime Das Datum und die Uhrzeit, zu der das Element der Playlist hinzugefügt wurde. Der Wert wird im ISO 8601-Format angegeben. |
snippet.channelId |
string Die ID, mit der YouTube eindeutig den Nutzer identifiziert, der den Artikel der Playlist hinzugefügt hat. |
snippet.title |
string Der Titel des Elements. |
snippet.description |
string Die Beschreibung des Elements. |
snippet.thumbnails |
object Eine Übersicht mit Thumbnail-Bildern, die mit dem Playlist-Element verknüpft sind. Bei jedem Objekt auf der Karte ist der Schlüssel der Name der Miniaturansicht. Der Wert ist ein Objekt, das weitere Informationen zur Miniaturansicht enthält. |
snippet.thumbnails.(key) |
object Gültige Schlüssel/Wert-Paare sind:
|
snippet.thumbnails.(key).url |
string Die URL des Bildes. |
snippet.thumbnails.(key).width |
unsigned integer Die Breite des Bildes. |
snippet.thumbnails.(key).height |
unsigned integer Die Höhe des Bildes. |
snippet.channelTitle |
string Der Kanaltitel des Kanals, zu dem das Playlist-Element gehört. |
snippet.videoOwnerChannelTitle |
string Der Kanaltitel des Kanals, auf dem dieses Video hochgeladen wurde. |
snippet.videoOwnerChannelId |
string Die Kanal-ID des Kanals, über den das Video hochgeladen wurde. |
snippet.playlistId |
string Die ID, mit der YouTube die Playlist, in der sich das Playlist-Element befindet, eindeutig identifiziert. |
snippet.position |
unsigned integer Die Reihenfolge, in der das Element in der Playlist angezeigt wird. Der Wert verwendet einen nullbasierten Index. Das erste Element hat also die Position 0 , das zweite Element die Position 1 usw. |
snippet.resourceId |
object Das id -Objekt enthält Informationen, mit denen die in der Playlist als Playlist-Element enthaltene Ressource eindeutig identifiziert werden kann. |
snippet.resourceId.kind |
string Die Art oder der Typ der verweisenden Ressource. |
snippet.resourceId.videoId |
string Wenn der Wert der snippet.resourceId.kind -Property youtube#video ist, ist diese Property vorhanden und ihr Wert enthält die ID, mit der YouTube das Video in der Playlist eindeutig identifiziert. |
contentDetails |
object Wenn das enthaltene Element ein YouTube-Video ist, ist das Objekt contentDetails in der Ressource enthalten. Das Objekt enthält zusätzliche Informationen zum Video. |
contentDetails.videoId |
string Die ID, mit der YouTube ein Video eindeutig identifiziert. Zum Abrufen der Ressource video legen Sie den Abfrageparameter id in Ihrer API-Anfrage auf diesen Wert fest. |
contentDetails.startAt |
string Hinweis:Diese Property wurde eingestellt. Wenn sie festgelegt wurde, wird ihr Wert ignoriert. Die Zeit (in Sekunden ab Beginn des Videos, zu der die Wiedergabe des Videos beginnen soll), gemessen. Der Eigentümer der Playlist kann die Zeiten festlegen, zu denen die Videowiedergabe gestartet und beendet werden soll, wenn das Video im Kontext der Playlist abgespielt wird. Der Standardwert ist 0 . |
contentDetails.endAt |
string Hinweis:Diese Eigenschaft wurde eingestellt. Wenn sie konfiguriert ist, wird ihr Wert ignoriert. Die Zeit in Sekunden ab Beginn des Videos, zu der die Wiedergabe des Videos beendet werden soll. Der Eigentümer der Playlist kann die Zeiten festlegen, zu denen die Videowiedergabe gestartet und beendet werden soll, wenn das Video im Kontext der Playlist abgespielt wird. Standardmäßig wird davon ausgegangen, dass video.endTime das Ende des Videos ist. |
contentDetails.note |
string Eine vom Nutzer erstellte Notiz zu diesem Artikel. Der Attributwert darf maximal 280 Zeichen lang sein. |
contentDetails.videoPublishedAt |
datetime Datum und Uhrzeit der Veröffentlichung des Videos auf YouTube. Der Wert wird im ISO 8601-Format angegeben. |
status |
object Das Objekt status enthält Informationen zum Datenschutzstatus des Playlist-Elements. |
status.privacyStatus |
string Datenschutzstatus des Playlist-Elements. Der Kanal, der das Video hochgeladen hat, das das Playlist-Element darstellt, kann diesen Wert mithilfe der Methode videos.insert oder videos.update festlegen. |