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 darauf beziehen, wie diese Ressource in der Playlist verwendet wird.
YouTube verwendet auch eine Playlist, um die Liste der hochgeladenen Videos eines Kanals zu identifizieren. Jedes playlistItem
in dieser Liste steht für ein hochgeladenes Video. Sie können die Playlist-ID für diese Liste aus der channel
-Ressource für einen bestimmten Kanal abrufen. Anschließend können Sie 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 Parametern der API-Anfrage entsprechen. Sie können 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. Sie könnten beispielsweise die Position des 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 enthalten sind:
Attribute | |
---|---|
kind |
string Gibt den Typ der API-Ressource an. Der Wert ist youtube#playlistItem . |
etag |
etag Das ETag dieser Ressource. |
id |
string Die ID, die YouTube zur eindeutigen Identifizierung des Playlist-Elements verwendet. |
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 der Artikel der Playlist hinzugefügt wurde. Der Wert wird im ISO 8601-Format angegeben. |
snippet.channelId |
string Die ID, die YouTube verwendet, um den Nutzer, der das Element der Playlist hinzugefügt hat, eindeutig zu identifizieren. |
snippet.title |
string Der Titel des Artikels. |
snippet.description |
string Die Beschreibung des Artikels. |
snippet.thumbnails |
object Eine Karte mit Miniaturansichten, die dem Playlist-Element zugeordnet sind. Für jedes Objekt auf der Karte ist der Schlüssel der Name des Vorschaubilds und der Wert ein Objekt, das weitere Informationen zum Vorschaubild enthält. |
snippet.thumbnails.(key) |
object Gültige Schlüsselwerte 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 Titel des Kanals, zu dem das Playlist-Element gehört. |
snippet.videoOwnerChannelTitle |
string Der Titel des Kanals, auf dem dieses Video hochgeladen wurde. |
snippet.videoOwnerChannelId |
string Die Kanal-ID des Kanals, auf dem dieses Video hochgeladen wurde. |
snippet.playlistId |
string Die ID, die YouTube zur eindeutigen Identifizierung der Playlist verwendet, 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 Objekt id enthält Informationen, mit denen die Ressource, die in der Playlist als Playlist-Element enthalten ist, eindeutig identifiziert werden kann. |
snippet.resourceId.kind |
string Die Art oder der Typ der referenzierten Ressource. |
snippet.resourceId.videoId |
string Wenn der Wert des Attributs snippet.resourceId.kind youtube#video ist, ist dieses Attribut vorhanden und sein Wert enthält die ID, die YouTube zur eindeutigen Identifizierung des Videos in der Playlist verwendet. |
contentDetails |
object Das contentDetails -Objekt ist in der Ressource enthalten, wenn das enthaltene Element ein YouTube-Video ist. Das Objekt enthält zusätzliche Informationen zum Video. |
contentDetails.videoId |
string Die ID, die YouTube zur eindeutigen Identifizierung eines Videos verwendet. Wenn Sie die Ressource video abrufen möchten, legen Sie den Abfrageparameter id in Ihrer API-Anfrage auf diesen Wert fest. |
contentDetails.startAt |
string Hinweis:Diese Eigenschaft ist veraltet und ihr Wert wird ignoriert, falls sie festgelegt ist. Die Zeit in Sekunden ab dem Beginn des Videos, zu der das Video abgespielt werden soll. Der Playlist-Inhaber kann die Zeiten angeben, zu denen die Videowiedergabe starten und enden soll, wenn das Video im Kontext der Playlist wiedergegeben wird. Der Standardwert ist 0 . |
contentDetails.endAt |
string Hinweis:Diese Eigenschaft ist veraltet und ihr Wert wird ignoriert, falls sie festgelegt ist. Die Zeit in Sekunden ab dem Beginn des Videos, zu der die Wiedergabe des Videos beendet werden soll. Der Playlist-Inhaber kann die Zeiten angeben, zu denen die Videowiedergabe starten und enden soll, wenn das Video im Kontext der Playlist wiedergegeben wird. Gehen Sie standardmäßig davon aus, dass video.endTime das Ende des Videos ist. |
contentDetails.note |
string Eine von Nutzern erstellte Notiz für diesen Artikel. Der Wert der Property darf maximal 280 Zeichen lang sein. |
contentDetails.videoPublishedAt |
datetime Das Datum und die Uhrzeit, zu der 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 das Playlist-Element repräsentiert, kann diesen Wert mit der Methode videos.insert oder videos.update festlegen. |