Members: list

Hinweis: Dieser Endpunkt kann nur von einzelnen Creatorn verwendet werden, um Anfragen für einen eigenen YouTube-Kanal mit aktivierter Kanalmitgliedschaft zu stellen. Wende dich an deinen Google- oder YouTube-Ansprechpartner, um Zugriff anzufordern.

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

Kontingentauswirkung: Ein Aufruf dieser Methode hat Kontingentkosten von 2 Einheiten.

Anfragen

HTTP-Anfrage

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

Autorisierung

Für diese Anfrage ist eine Autorisierung mit folgendem Bereich erforderlich:

Bereich
https://www.googleapis.com/auth/youtube.channel-memberships.creator

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 Attribute der member-Ressource an, die die API-Antwort enthalten soll. Legen Sie den Parameterwert auf snippet fest.
Optionale Parameter
mode	string Der Parameter mode gibt an, welche Mitglieder in die API-Antwort aufgenommen werden. Legen Sie den Parameterwert auf einen der folgenden Werte fest: all_current (Standard): Die aktuellen Mitglieder werden von neu nach alt aufgelistet. Wenn dieser Wert verwendet wird, ist das Ende der Liste erreicht, wenn die API-Antwort kein nextPageToken enthält. updates: Listet nur Mitglieder auf, die seit dem letzten API-Aufruf hinzugefügt oder ein Upgrade durchgeführt haben. Der erste Aufruf startet einen neuen Stream von Updates, gibt aber keine Mitglieder zurück. Zum Abrufen der Mitgliedschaftsaktualisierungen müssen Sie den Endpunkt mit der gewünschten Häufigkeit mit nextPageToken abfragen. Hinweis: Wenn dieser Wert verwendet wird, enthält die API-Antwort immer eine nextPageToken.
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 1000 (einschließlich). Der Standardwert ist 5.
pageToken	string Der pageToken-Parameter gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. Das Token ist spezifisch für das mode, das mit der ursprünglichen API-Anfrage verwendet wurde. Sie können also kein mit einem Modus abgerufenes Seitentoken verwenden, um anschließend in einen anderen Modus zu wechseln.
hasAccessToLevel	string Der Parameterwert hasAccessToLevel ist eine Ebenen-ID, die die Mindestebene für Mitglieder der Ergebnismenge angibt.
filterByMemberChannelId	string Der Parameter filterByMemberChannelId enthält eine durch Kommas getrennte Liste von Kanal-IDs, mit denen der Mitgliedsstatus bestimmter Nutzer geprüft werden kann. Beispiel: UC_1,UC_2,UC_3. Pro Anruf können maximal 100 Kanäle angegeben werden.

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#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member 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#memberListResponse.
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. Seitentokens können ablaufen. In diesem Fall sollte Ihre Anwendung das Token löschen und die API ohne pageToken aufrufen, um eine neue Anfrage zu starten.
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 Mitglieder, die den Anfragekriterien 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
badRequest (400)	channelMembershipsNotEnabled	Für den Creator-Kanal, der die Anfrage autorisiert, ist die Kanalmitgliedschaft nicht aktiviert.
badRequest (400)	invalidMode	Der Parameterwert mode ist ungültig. Dieser Fehler kann auftreten, wenn der Parameter pageToken ein Token angibt, das mit einem anderen Modus als dem angegebenen abgerufen wurde.
badRequest (400)	invalidPageToken	Der Parameterwert pageToken ist ungültig. Dieser Fehler kann auftreten, wenn das in der Anfrage verwendete Seitentoken abgelaufen ist oder nicht erkannt wird.
badRequest (400)	invalidHasAccessToLevel	Der Parameterwert hasAccessToLevel ist ungültig. Es gibt keine Ebene mit dem angegebenen id.
badRequest (400)	invalidFilterByMemberChannelId	Der Parameterwert filterByMemberChannelId ist ungültig. Dieser Fehler tritt auf, wenn der Parameterwert filterByMemberChannelId mehr als 100 Kanäle angibt.