Eine playlistItem
-Ressource identifiziert eine andere Ressource, z. B. ein Video, das in einer Playlist enthalten ist. Außerdem enthält die playlistItem
-Ressource Details zur enthaltenen Ressource, die sich speziell auf die Verwendung dieser Ressource in der Playlist beziehen.
YouTube verwendet auch eine Playlist, um die Liste der hochgeladenen Videos eines Kanals zu identifizieren. Jede playlistItem
in dieser Liste steht für ein hochgeladenes Video. Die Wiedergabelisten-ID für diese Liste kannst du aus der channel
-Ressource für einen bestimmten Kanal abrufen. Sie können dann die Methode playlistItems.list
auf die Liste anwenden.
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.
- aktualisieren
- Ändert ein Playlist-Element. Du kannst beispielsweise die Position des Artikels in der Playlist aktualisieren. Hier kannst du die Funktion ausprobieren.
- Delete
- Löst 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 sind die Eigenschaften aufgeführt, 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, mit der YouTube das Playlist-Element eindeutig identifiziert. |
snippet |
object Das snippet -Objekt enthält grundlegende Details zum Playlist-Element, z. B. seinen Titel und seine Position in der Playlist. |
snippet.publishedAt |
datetime Das Datum und die Uhrzeit, zu der der Artikel der Playlist hinzugefügt wurde. Der Wert wird im ISO 8601-Format angegeben. |
snippet.channelId |
string Die ID, mit der YouTube den Nutzer eindeutig identifiziert, der den Artikel der Playlist hinzugefügt hat. |
snippet.title |
string Der Titel des Artikels. |
snippet.description |
string Die Beschreibung des Artikels. |
snippet.thumbnails |
object Eine Karte mit Miniaturansichten, die mit dem Playlist-Element verknüpft sind. Für jedes Objekt in der Karte ist der Schlüssel der Name des Thumbnail-Bilds und der Wert ist ein Objekt, das weitere Informationen zum Thumbnail enthält. |
snippet.thumbnails.(key) |
object Gültige Schlüsselwerte:
|
snippet.thumbnails.(key).url |
string Die URL des Bildes. |
snippet.thumbnails.(key).width |
unsigned integer Die Breite des Bilds. |
snippet.thumbnails.(key).height |
unsigned integer Die Höhe des Bilds. |
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, auf den dieses Video hochgeladen wurde. |
snippet.playlistId |
string Die ID, mit der YouTube die Playlist eindeutig identifiziert, in der sich das Playlist-Element befindet. |
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 sich die Ressource, die in der Playlist enthalten ist, eindeutig als Playlist-Element identifizieren lässt. |
snippet.resourceId.kind |
string Die Art oder der Typ der referenzierten Ressource. |
snippet.resourceId.videoId |
string Wenn der Wert der Property snippet.resourceId.kind 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 Das contentDetails -Objekt ist in der Ressource enthalten, wenn es sich bei dem enthaltenen Element um ein YouTube-Video handelt. Das Objekt enthält zusätzliche Informationen zum Video. |
contentDetails.videoId |
string Die ID, mit der YouTube ein Video eindeutig identifiziert. Wenn du die Ressource video abrufen möchtest, setze den Abfrageparameter id in deiner API-Anfrage auf diesen Wert. |
contentDetails.startAt |
string Hinweis:Diese Property wurde eingestellt. Wenn sie festgelegt ist, wird ihr Wert ignoriert. Die Zeit, gemessen in Sekunden ab Beginn des Videos, zu der die Wiedergabe des Videos beginnen soll. Der Inhaber der Playlist kann angeben, wann das Video gestartet und beendet werden soll, wenn es im Kontext der Playlist wiedergegeben wird. Der Standardwert ist 0 . |
contentDetails.endAt |
string Hinweis:Diese Property wurde eingestellt. Wenn sie festgelegt ist, wird ihr Wert ignoriert. Die Zeit, gemessen in Sekunden ab Beginn des Videos, nach der die Wiedergabe des Videos beendet werden soll. Der Inhaber der Playlist kann angeben, wann das Video gestartet und beendet werden soll, wenn es im Kontext der Playlist wiedergegeben wird. Standardmäßig wird davon ausgegangen, dass video.endTime das Ende des Videos ist. |
contentDetails.note |
string Eine von Nutzern erstellte Notiz zu diesem Artikel. Der Attributwert darf maximal 280 Zeichen lang sein. |
contentDetails.videoPublishedAt |
datetime Das Datum und die Uhrzeit, an dem das Video auf YouTube veröffentlicht wurde. Der Wert wird im ISO 8601-Format angegeben. |
status |
object Das status -Objekt enthält Informationen zum Datenschutzstatus des Playlist-Elements. |
status.privacyStatus |
string Der Datenschutzstatus des Playlist-Elements. Der Kanal, auf dem das Video hochgeladen wurde, das dem Playlist-Element entspricht, kann diesen Wert entweder mit der Methode videos.insert oder videos.update festlegen. |