Eine playlistItem
-Ressource bezeichnet eine andere Ressource, wie etwa ein Video, die in einer Playlist enthalten ist. Darüber hinaus enthält die playlistItem
-Ressource Details zur enthaltenen Ressource, die speziell auf die Verwendung dieser Ressource in dieser Playlist zutreffen.
YouTube verwendet auch eine Playlist, um die Liste der hochgeladenen Videos eines Kanals zu identifizieren, wobei jedes playlistItem
in dieser Liste ein hochgeladenes Video darstellt. Du kannst die Playlist-ID für diese Liste von der channel resource
für einen bestimmten Kanal 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.
- Einfügen
- Fügt einer Playlist eine Ressource hinzu. Hier kannst du die Funktion ausprobieren.
- Aktualisieren
- Damit wird ein Playlist-Inhalt geändert. Du kannst beispielsweise die Position des Elements in der Playlist aktualisieren. Hier kannst du die Funktion ausprobieren.
- Delete
- Damit wird ein Playlist-Element gelöscht. 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 Titel der Playlist, z. B. den Titel und die Position in der Playlist. |
snippet.publishedAt |
datetime Das Datum und die Uhrzeit, zu der das Element zur Playlist hinzugefügt wurde. Der Wert wird im ISO 8601-Format angegeben. |
snippet.channelId |
string Die ID, mit der YouTube den Nutzer, der das Element zur Playlist hinzugefügt hat, eindeutig identifiziert. |
snippet.title |
string Der Titel des Elements. |
snippet.description |
string Die Beschreibung des Elements. |
snippet.thumbnails |
object Eine Zuordnung von Thumbnails zu dem Playlist-Element. Für jedes Objekt auf der Karte ist der Schlüssel der Name der Miniaturansicht und der Wert 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 Bild-URL. |
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 die Playlist gehört. |
snippet.videoOwnerChannelTitle |
string Der Kanaltitel des Kanals, der dieses Video hochgeladen hat. |
snippet.videoOwnerChannelId |
string Die Kanal-ID des Kanals, der dieses Video hochgeladen hat |
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, also hat das erste Element eine Position von 0 , das zweite Element eine Position von 1 usw. |
snippet.resourceId |
object Das id -Objekt enthält Informationen, mit denen die Ressource, die in der Playlist enthalten ist, eindeutig als Playlist-Element angegeben werden kann. |
snippet.resourceId.kind |
string Die Art oder der Typ der Verweisressource. |
snippet.resourceId.videoId |
string Wenn der Wert der snippet.resourceId.kind -Property youtube#video lautet, 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 das enthaltene Element ein YouTube-Video ist. Das Objekt enthält zusätzliche Informationen zum Video. |
contentDetails.videoId |
string Die ID, die YouTube verwendet, um ein Video eindeutig zu identifizieren. 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 verworfen. Falls Sie einen Wert festgelegt haben, wird er ignoriert. Die Zeit in Sekunden ab Beginn des Videos, ab der das Video wiedergegeben werden soll. Der Inhaber der Playlist kann angeben, wann das Video gestartet und gestoppt werden soll, wenn es im Kontext der Playlist abgespielt wird. Der Standardwert ist 0 . |
contentDetails.endAt |
string Hinweis:Diese Property wurde verworfen. Falls Sie einen Wert festgelegt haben, wird er ignoriert. Die Zeit in Sekunden ab Beginn des Videos, ab der das Video nicht mehr wiedergegeben werden soll. Der Inhaber der Playlist kann angeben, wann das Video gestartet und gestoppt werden soll, wenn es im Kontext der Playlist abgespielt wird. Standardmäßig wird davon ausgegangen, dass video.endTime das Ende des Videos ist. |
contentDetails.note |
string Ein vom Nutzer erstellter Hinweis für dieses Element. 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 status -Objekt enthält Informationen zum Datenschutzstatus des Playlist-Elements. |
status.privacyStatus |
string Der Datenschutzstatus des Playlist-Elements. Der Kanal, der das Video hochgeladen hat, für das das Playlist-Element steht, kann diesen Wert entweder mit der Methode videos.insert oder videos.update festlegen. |