Sponsors: list

Hinweis: Diese Methode wird am 31. März 2020 eingestellt. Sie wurde durch die Methode members.list ersetzt. Informationen zu dieser Methode findest du in der Dokumentation zur YouTube Data API.

Die Methode sponsors.list wird ab dem 30. September 2020 nicht mehr unterstützt. API-Clients sollten Aufrufe an die Methode sponsors.list aktualisieren, um stattdessen die Methode members.list zu verwenden.

Listet die Mitglieder (früher „Unterstützer“) eines Kanals auf. Die API-Anfrage muss vom Kanalinhaber autorisiert werden.

Gängige Anwendungsfälle

Anfragen

HTTP-Anfrage

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

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

Bereich
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

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 die sponsor-Ressourcenteile an, die die API-Antwort enthalten soll. Unterstützte Werte sind id und snippet.
Optionale Parameter
filter string
Der Parameter filter gibt an, welche Kanal-Sponsors zurückgegeben werden sollen. Der Standardwert ist newest.

Zulässige Werte sind:
  • all: Gib alle Unterstützer zurück, von neu nach alt.
  • newest: Gib eine Seite mit den neuesten Unterstützern zurück. Nachfolgende Anfragen mit dem nextPageToken rufen neuere Abonnenten ab, wenn sie sich registrieren.
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.
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#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor 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#sponsorListResponse.
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.
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 Unterstützer, die den Kriterien der Anfrage 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) insufficientPermissions Du bist nicht berechtigt, die Unterstützer des Kanals aufzurufen.
invalidValue (400) invalidValueInRequest Die Anfrage enthält einen ungültigen Wert.
invalidValue (400) sponsorshipNotEnabledForChannelId Der Unterstützer-Status ist für diesen Kanal nicht aktiviert.

Jetzt testen

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