Gibt eine Sammlung von Playlistbildern zurück, die den API-Anfrageparametern entsprechen. Sie können das Playlistbild einer bestimmten Playlist oder ein oder mehrere Playlistbilder anhand ihrer eindeutigen IDs abrufen.
Kontingentbelastung:Ein Aufruf dieser Methode hat Kontingentkosten von 1 Einheit.
Anfrage
HTTP-Anfrage
GET https://www.googleapis.com/youtube/v3/playlistImages
Autorisierung
Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).
Umfang |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
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 |
|
Filter (genau einer der folgenden Parameter muss angegeben werden) | ||
id |
string Der Parameter id gibt eine durch Kommas getrennte Liste mit einer oder mehreren eindeutigen Playlist-Bild-IDs an. |
|
playlistId |
string Der Parameter playlistId gibt die eindeutige ID der Playlist an, für die Sie Playlistbilder abrufen möchten. Auch wenn dies ein optionaler Parameter ist, muss für jede Anfrage zum Abrufen von Playlistbildern ein Wert für den Parameter id oder den Parameter playlistId angegeben werden. |
|
Optionale Parameter | ||
maxResults |
unsigned integer Der Parameter maxResults gibt die maximale Anzahl von Bildern an, die im Ergebnissatz zurückgegeben werden sollen. Zulässige Werte sind 0 bis einschließlich 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-Inhaltspartner 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 gedacht, 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 Anmeldedaten 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. Mit dem Parameter onBehalfOfContentOwnerChannel wird die YouTube-Kanal-ID des Kanals angegeben, 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 Rechteinhaber verknüpft ist, der im Parameter onBehalfOfContentOwner angegeben ist. Schließlich muss der Kanal, der durch den Parameterwert onBehalfOfContentOwnerChannel angegeben wird, mit dem Rechteinhaber verknüpft sein, der durch den Parameter onBehalfOfContentOwner angegeben wird.Dieser Parameter ist für YouTube-Content-Partner gedacht, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können Rechteinhaber sich einmal authentifizieren und Aktionen im Namen des im Parameterwert angegebenen Kanals ausführen, ohne für jeden einzelnen Kanal Anmeldedaten 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 geben die Eigenschaften nextPageToken und prevPageToken andere Seiten an, 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#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages Resource ] }
Attribute
In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource enthalten sind:
Attribute | |
---|---|
kind |
string Gibt den Typ der API-Ressource an. Der Wert ist youtube#playlistImageListResponse . |
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 im Ergebnissatz abzurufen. |
pageInfo |
object Das pageInfo -Objekt enthält Paging-Informationen für das Ergebnis-Set. |
pageInfo.totalResults |
integer Die Gesamtzahl der Ergebnisse im Ergebnissatz. |
pageInfo.resultsPerPage |
integer Die Anzahl der in der API-Antwort enthaltenen Ergebnisse. |
items[] |
list Eine Liste der Playlistbilder, die den Anfragekriterien entsprechen. |