Eine playlist-Ressource stellt eine YouTube-Playlist dar. Eine Playlist ist eine Sammlung von Videos, die nacheinander abgespielt und mit anderen Nutzern geteilt werden können. Playlists sind standardmäßig öffentlich sichtbar, können aber auch öffentlich oder privat sein.
YouTube verwendet Playlists auch, um spezielle Sammlungen von Videos für einen Kanal zu identifizieren, z. B.:
- hochgeladene Videos
- Videos, die positiv bewertet wurden (mit „Mag ich“ markiert)
channel resource für einen bestimmten Kanal abrufen.Anschließend können Sie mit der Methode
playlistItems.list eine dieser Listen abrufen. Sie können auch Elemente zu diesen Listen hinzufügen oder daraus entfernen, indem Sie die Methoden playlistItems.insert und playlistItems.delete aufrufen.
Methoden
Die API unterstützt die folgenden Methoden für playlists-Ressourcen:
- list
- Gibt eine Sammlung von Playlists zurück, die den API-Anfrageparametern entsprechen. Sie können beispielsweise alle Playlists abrufen, die dem authentifizierten Nutzer gehören, oder eine oder mehrere Playlists anhand ihrer eindeutigen IDs abrufen. Hier kannst du die Funktion ausprobieren.
- insert
- Erstellt eine Playlist. Hier kannst du die Funktion ausprobieren.
- Aktualisieren
- Ändert eine Playlist. Du kannst beispielsweise den Titel, die Beschreibung oder den Datenschutzstatus einer Playlist ändern. Hier kannst du die Funktion ausprobieren.
- Delete
- Löscht eine Playlist. Hier kannst du die Funktion ausprobieren.
Ressourcendarstellung
Die folgende JSON-Struktur zeigt das Format einer playlists-Ressource:
{
"kind": "youtube#playlist",
"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,
"defaultLanguage": string,
"localized": {
"title": string,
"description": string
}
},
"status": {
"privacyStatus": string,
"podcastStatus": enum
},
"contentDetails": {
"itemCount": unsigned integer
},
"player": {
"embedHtml": string
},
"localizations": {
(key): {
"title": string,
"description": string
}
}
}Attribute
In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource enthalten sind:
| Attribute | |
|---|---|
kind |
stringGibt den Typ der API-Ressource an. Der Wert ist youtube#playlist. |
etag |
etagDas ETag dieser Ressource. |
id |
stringDie ID, die YouTube verwendet, um die Playlist eindeutig zu identifizieren. |
snippet |
objectDas snippet-Objekt enthält grundlegende Details zur Playlist, z. B. den Titel und die Beschreibung. |
snippet.publishedAt |
datetimeDatum und Uhrzeit der Erstellung der Playlist. Der Wert wird im ISO 8601-Format angegeben. |
snippet.channelId |
stringDie ID, die YouTube verwendet, um den Kanal, auf dem die Playlist veröffentlicht wurde, eindeutig zu identifizieren. |
snippet.title |
stringDer Titel der Playlist. |
snippet.description |
stringDie Beschreibung der Playlist. |
snippet.thumbnails |
objectEine Karte mit Miniaturansichten, die mit der Playlist verknüpft 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) |
objectGültige Schlüsselwerte sind:
|
snippet.thumbnails.(key).url |
stringDie URL des Bildes. |
snippet.thumbnails.(key).width |
unsigned integerDie Breite des Bildes. |
snippet.thumbnails.(key).height |
unsigned integerDie Höhe des Bildes. |
snippet.channelTitle |
stringDer Kanaltitel des Kanals, zu dem das Video gehört. |
snippet.tags[] |
listDieses Attribut wird nicht mehr unterstützt. Keyword-Tags, die mit der Playlist verknüpft sind. |
snippet.defaultLanguage |
stringDie Sprache des Texts in den Attributen snippet.title und snippet.description der playlist-Ressource. |
snippet.localized |
objectDas snippet.localized-Objekt enthält entweder einen lokalisierten Titel und eine lokalisierte Beschreibung für die Playlist oder den Titel in der Standardsprache für die Metadaten der Playlist.
localizations-Objekt können Sie lokalisierte Titel hinzufügen, aktualisieren oder löschen. |
snippet.localized.title |
stringDer lokalisierte Playlist-Titel. |
snippet.localized.description |
stringDie lokalisierte Playlist-Beschreibung. |
status |
objectDas status-Objekt enthält Statusinformationen für die Playlist. |
status.privacyStatus |
stringDer Datenschutzstatus der Playlist. Gültige Werte für dieses Attribut sind:
|
status.podcastStatus |
stringDer Podcast-Status der Playlist. Wenn der Wert enabled ist, wird die Playlist als Podcast-Show gekennzeichnet. Damit der Podcast-Status einer Playlist auf enabled gesetzt werden kann, muss die Playlist ein Playlist-Bild haben.Gültige Werte für diese Property sind:
|
contentDetails |
objectDas contentDetails-Objekt enthält Informationen zum Inhalt der Playlist, einschließlich der Anzahl der Videos in der Playlist. |
contentDetails.itemCount |
unsigned integerDie Anzahl der Videos in der Playlist. |
player |
objectDas player-Objekt enthält Informationen, die Sie zum Abspielen der Playlist in einem eingebetteten Player benötigen. |
player.embedHtml |
stringEin <iframe>-Tag, das einen Player einbettet, der die Playlist abspielt. |
localizations |
objectDas localizations-Objekt enthält Übersetzungen der Metadaten der Playlist. |
localizations.(key) |
objectDie Sprache des lokalisierten Texts, der dem Schlüsselwert zugeordnet ist. Der Wert ist ein String, der einen BCP-47-Sprachcode enthält. |
localizations.(key).title |
stringDer lokalisierte Playlist-Titel. |
localizations.(key).description |
stringDie lokalisierte Playlist-Beschreibung. |