Gibt eine Sammlung von Playlist-Bildern zurück, die den API-Anfrageparametern entsprechen. Du kannst das Playlist-Bild einer bestimmten Playlist oder ein oder mehrere Playlist-Bilder anhand ihrer eindeutigen ID abrufen.
Auswirkungen auf das Kontingent: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 Der Parameter |
|
Filter (bitte genau einen der folgenden Parameter angeben) | ||
id |
string Der Parameter id gibt eine durch Kommas getrennte Liste einer oder mehrerer eindeutiger IDs von Playlist-Images an. |
|
playlistId |
string Der playlistId -Parameter gibt die eindeutige ID der Playlist an, für die du Playlist-Bilder abrufen möchtest. Auch wenn dies ein optionaler Parameter ist, muss bei jeder Anfrage zum Abrufen von Playlist-Bildern ein Wert für den Parameter id oder 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 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 die Anmeldedaten für die Autorisierung 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 nur einmal authentifizieren und erhalten Zugriff auf alle ihre Video- und Kanaldaten, ohne dass sie für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben 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-Inhaltspartner vorgesehen. Die onBehalfOfContentOwnerChannel -Parameter
gibt die YouTube-Kanal-ID des Kanals an, auf dem ein Video wiedergegeben wird.
hinzugefügt. Dieser Parameter ist erforderlich, wenn in einer Anfrage ein Wert für die Methode
onBehalfOfContentOwner -Parameter und kann nur in
in Verbindung mit diesem Parameter. Außerdem muss der Antrag
die über ein CMS-Konto autorisiert wurden, das mit dem Rechteinhaber verknüpft ist,
wird durch den Parameter onBehalfOfContentOwner angegeben. Die Funktion
Kanal, den der Wert des Parameters onBehalfOfContentOwnerChannel
mit dem Rechteinhaber verknüpft sein muss,
wird durch den Parameter onBehalfOfContentOwner angegeben.Dies ist für YouTube-Content-Partner vorgesehen, die viele verschiedenen YouTube-Kanälen. Rechteinhaber können sich einmalig authentifizieren. und Aktionen für den im Parameter angegebenen Kanal ausführen. ohne Anmeldedaten für die Authentifizierung angeben zu müssen, einen separaten Kanal. |
|
pageToken |
string Der pageToken -Parameter gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort geben die Eigenschaften nextPageToken und prevPageToken andere Seiten an, 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#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 angezeigt werden:
Attribute | |
---|---|
kind |
string Identifiziert den Typ der API-Ressource. Der Wert ist youtube#playlistImageListResponse . |
nextPageToken |
string Das Token, das als Wert des pageToken -Parameters verwendet werden kann, um die nächste Seite im Ergebnissatz abzurufen. |
prevPageToken |
string Das Token, das als Wert des pageToken -Parameters verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen. |
pageInfo |
object Das Objekt pageInfo kapselt Seiteninformationen für die Ergebnismenge. |
pageInfo.totalResults |
integer Die Gesamtzahl der Ergebnisse in der Ergebnismenge. |
pageInfo.resultsPerPage |
integer Die Anzahl der in der API-Antwort enthaltenen Ergebnisse. |
items[] |
list Eine Liste mit Playlist-Bildern, die den Anfragekriterien entsprechen. |