Playlists: list

Gibt eine Sammlung von Playlists zurück, die den Parametern der API-Anfrage entsprechen. Sie können beispielsweise alle Playlists abrufen, deren Inhaber der authentifizierte Nutzer ist, oder eine oder mehrere Playlists anhand ihrer eindeutigen IDs abrufen.

Auswirkungen auf das Kontingent:Ein Aufruf dieser Methode kostet 1 Kontingenteinheit.

Gängige Anwendungsfälle

Anfrage

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
Der Parameter part gibt eine durch Kommas getrennte Liste mit mindestens einer Property der Ressource playlist an, die in der API-Antwort enthalten sein soll.

Wenn der Parameter eine Property identifiziert, die untergeordnete Properties enthält, werden diese untergeordneten Properties in die Antwort aufgenommen. In einer playlist-Ressource enthält die Property snippet beispielsweise Properties wie author, title, description und timeCreated. Wenn Sie also part=snippet festlegen, enthält die API-Antwort alle diese Properties.

Die folgende Liste enthält die part Namen, die Sie in den Parameterwert aufnehmen können:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filter (genau einen der folgenden Parameter angeben)
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 abzurufenden Ressourcen an. In einer playlist-Ressource gibt die Property id die YouTube-Playlist-ID der Playlist an.
mine boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie den Wert dieses Parameters auf true fest, damit die API nur Playlists zurückgibt, deren Inhaber der authentifizierte Nutzer ist.
Optionale Parameter
hl string
Der Parameter hl weist die API an, 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 lokalisierte Ressourcendetails in dieser Sprache verfügbar sind, enthält das Objekt snippet.localized der Ressource die lokalisierten Werte. Wenn 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 der Elemente an, die im Ergebnissatz 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-Content-Partner vorgesehen.

Der onBehalfOfContentOwner Parameter gibt an, dass die Autorisierungsnachweise der Anfrage einen YouTube-CMS-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen Content-Inhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können Rechteinhaber sich 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-Content-Partner vorgesehen.

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

Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können Rechteinhaber sich einmal authentifizieren und im Namen des im Parameterwert angegebenen Kanals Aktionen ausführen, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen.
pageToken string
Der pageToken Parameter gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Properties nextPageToken und prevPageToken andere Seiten, die abgerufen werden können.

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 sind die Attribute definiert, die in dieser Ressource angezeigt werden:

Attribute
kind string
Gibt den Typ der API-Ressource an. 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 im Ergebnissatz abzurufen.
prevPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen.
pageInfo object
Das Objekt pageInfo enthält Informationen zur Paginierung 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 von Playlists, die den Kriterien der Anfrage entsprechen.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetail 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 mit dem Parameter id der Anfrage identifizierte Playlist unterstützt die Anfrage nicht oder die Anfrage ist nicht ordnungsgemäß autorisiert.
notFound (404) channelNotFound Der im Parameter channelId 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 nicht die Möglichkeit, die angegebene Playlist aufzulisten. Sie können beispielsweise Ihre Playlist „Später ansehen“ nicht auflisten.

Testen!

Mit dem APIs Explorer können Sie diese API aufrufen und sich die API-Anfrage und -Antwort ansehen.