Playlists: list

Gibt eine Sammlung von Playlists zurück, die den API-Anfrageparametern entsprechen. Du kannst beispielsweise alle Playlists abrufen, die dem authentifizierten Nutzer gehören, oder eine oder mehrere Playlists anhand ihrer eindeutigen IDs.

Kontingentauswirkung: Ein Aufruf dieser Methode hat Kontingentkosten von 1 Einheit.

Gängige Anwendungsfälle

Anfragen

HTTP-Anfrage

GET https://www.googleapis.com/youtube/v3/playlists

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
part string
Mit dem Parameter part wird eine durch Kommas getrennte Liste mit einem oder mehreren playlist-Ressourcenattributen angegeben, die in der API-Antwort enthalten sein werden.

Bezeichnet der Parameter eine Property, die untergeordnete Properties enthält, werden die untergeordneten Attribute in die Antwort aufgenommen. Beispielsweise enthält das Attribut snippet in einer playlist-Ressource Attribute wie author, title, description und timeCreated. Wenn du also part=snippet festlegst, enthält die API-Antwort alle diese Eigenschaften.

Die folgende Liste enthält die part-Namen, die du in den Parameterwert aufnehmen kannst:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filter (geben Sie genau einen der folgenden Parameter an)
channelId string
Dieser Wert gibt an, dass die API nur die Playlists des angegebenen Kanals zurückgeben soll.
id string
Der Parameter id gibt eine durch Kommas getrennte Liste der YouTube-Playlist-IDs für die abgerufene Ressource an. In einer playlist-Ressource gibt die Eigenschaft id die YouTube-Playlist-ID der Playlist an.
mine boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setze den Wert dieses Parameters auf true, um die API anzuweisen, nur Playlists zurückzugeben, die dem authentifizierten Nutzer gehören.
Optionale Parameter
hl string
Mit dem Parameter hl wird die API angewiesen, lokalisierte Ressourcenmetadaten für eine bestimmte Anwendungssprache abzurufen, die von der YouTube-Website unterstützt wird. Der Parameterwert muss ein Sprachcode sein, der in der Liste enthalten ist, die von der i18nLanguages.list-Methode zurückgegeben wird.

Wenn in dieser Sprache lokalisierte Ressourcendetails verfügbar sind, enthält das snippet.localized-Objekt der Ressource die lokalisierten Werte. Wenn jedoch keine lokalisierten Details verfügbar sind, enthält das snippet.localized-Objekt Ressourcendetails in der Standardsprache der Ressource.
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die in der Ergebnismenge zurückgegeben werden sollen. Zulässige Werte sind 0 bis 50 (einschließlich). Der Standardwert ist 5.
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen.

Der Parameter onBehalfOfContentOwner gibt an, dass durch die Autorisierungsanmeldedaten der Anfrage ein YouTube CMS-Nutzer identifiziert wird, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich nur einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen. Das CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.
onBehalfOfContentOwnerChannel string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen.

Der Parameter onBehalfOfContentOwnerChannel gibt die YouTube-Kanal-ID des Kanals an, zu dem ein Video hinzugefügt wird. Dieser Parameter ist erforderlich, wenn in einer Anfrage ein Wert für den Parameter onBehalfOfContentOwner angegeben wird, und kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem muss die Anfrage über ein CMS-Konto autorisiert werden, das mit dem Rechteinhaber verknüpft ist, der im onBehalfOfContentOwner-Parameter angegeben ist. Schließlich muss der Kanal, den der Parameterwert onBehalfOfContentOwnerChannel angibt, mit dem Rechteinhaber verknüpft sein, der durch den Parameter onBehalfOfContentOwner angegeben wird.

Dieser Parameter ist für YouTube-Contentpartner gedacht, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Damit können sich Rechteinhaber einmal authentifizieren und Aktionen für den im Parameterwert angegebenen Kanal ausführen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben zu müssen.
pageToken string
Der pageToken-Parameter gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Attribute nextPageToken und prevPageToken andere Seiten, die abgerufen werden könnten.

Anfragetext

Geben Sie beim Aufrufen dieser Methode keinen Anfragetext an.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "youtube#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist Resource
  ]
}

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#playlistListResponse.
etag etag
Das ETag dieser Ressource.
nextPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite in der Ergebnismenge abzurufen.
prevPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite in der Ergebnismenge abzurufen.
pageInfo object
Das Objekt pageInfo enthält Seiteninformationen für den Ergebnissatz.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse im Ergebnissatz.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind.
items[] list
Eine Liste der Playlists, die den Anfragekriterien entsprechen.

Fehler

In der folgenden Tabelle finden Sie Fehlermeldungen, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
forbidden (403) channelClosed Der im Parameter channelId angegebene Kanal wurde geschlossen.
forbidden (403) channelSuspended Der im Parameter channelId angegebene Kanal wurde gesperrt.
forbidden (403) playlistForbidden Die Playlist, die durch den Parameter id der Anfrage identifiziert wird, unterstützt die Anfrage nicht oder die Anfrage ist nicht ordnungsgemäß autorisiert.
notFound (404) channelNotFound Der im channelId-Parameter angegebene Kanal wurde nicht gefunden.
notFound (404) playlistNotFound Die mit dem Parameter id der Anfrage identifizierte Playlist wurde nicht gefunden.
invalidValue (400) playlistOperationUnsupported Die API unterstützt die Möglichkeit zum Auflisten der angegebenen Playlist nicht. Du kannst beispielsweise nicht die Playlist „Später ansehen“ hinzufügen.

Jetzt testen

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.