Gibt eine Sammlung von Playlists zurück, die den API-Anfrageparametern entsprechen. Du kannst beispielsweise alle Playlists abrufen, deren Inhaber der authentifizierte Nutzer ist, oder eine oder mehrere Playlists anhand ihrer eindeutigen IDs abrufen.
Auswirkungen auf Kontingente: Bei einem Aufruf dieser Methode fallen Kontingentkosten von 1 Einheit an.
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 Der Parameter part gibt eine durch Kommas getrennte Liste mit einer oder mehreren playlist -Ressourceneigenschaften an, die in der API-Antwort enthalten sein werden.Wenn der Parameter eine Property mit untergeordneten Properties angibt, werden die untergeordneten Properties in die Antwort aufgenommen. In einer playlist -Ressource enthält das Attribut snippet beispielsweise Attribute wie author , title , description und timeCreated . Wenn Sie part=snippet festlegen, enthält die API-Antwort daher alle diese Attribute.Die folgende Liste enthält die part -Namen, die Sie in den Parameterwert aufnehmen können:
|
|
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 abgerufenen Ressourcen an. In einer playlist -Ressource gibt die id -Property die YouTube-Playlist-ID der Playlist an. |
|
mine |
boolean Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setzen Sie den Wert dieses Parameters auf true , um die API anzuweisen, nur Playlists zurückzugeben, die dem authentifizierten Nutzer gehören. |
|
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 in der Liste sein, die von der Methode i18nLanguages.list zurückgegeben wird.Wenn lokalisierte Ressourcendetails in dieser Sprache 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 Objekt snippet.localized 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 . 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 Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsanmeldedaten der Anfrage einen YouTube CMS-Nutzer identifizieren, 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 einmalig authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung 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 nur für YouTube-Content-Partner 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 ist. Er kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem muss die Anfrage über ein CMS-Konto autorisiert werden, das mit dem im onBehalfOfContentOwner -Parameter angegebenen Rechteinhaber verknüpft ist. Schließlich muss der Kanalwert, den der Parameterwert onBehalfOfContentOwnerChannel angibt, mit dem Rechteinhaber verknüpft sein, den der Parameter onBehalfOfContentOwner angibt.Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die zahlreiche verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich einmalig 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 Parameter pageToken gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Attribute 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 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 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 pageInfo -Objekt enthält Seiteninformationen für die Ergebnismenge. |
pageInfo.totalResults |
integer Die Gesamtzahl der Ergebnisse in der Ergebnismenge. |
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 sind Fehlermeldungen aufgeführt, die von der API möglicherweise als Antwort auf einen Aufruf dieser Methode zurückgegeben werden. 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 mit dem Parameter id der Anfrage identifiziert wird, unterstützt die Anfrage nicht oder sie ist nicht ordnungsgemäß autorisiert. |
notFound (404) |
channelNotFound |
Der im Parameter channelId angegebene Kanal wurde nicht gefunden. |
notFound (404) |
playlistNotFound |
Die Playlist, die mit dem Parameter id der Anfrage identifiziert wurde, kann nicht gefunden werden. |
invalidValue (400) |
playlistOperationUnsupported |
Die API unterstützt das Auflisten der angegebenen Playlist nicht. Du kannst die Playlist „Später ansehen“ beispielsweise nicht auflisten. |
Testen!
Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.