Members: list

Hinweis: Dieser Endpunkt kann nur von einzelnen Creatorn verwendet werden, um Anfragen für ihren eigenen YouTube-Kanal zu stellen, für den die Kanalmitgliedschaft aktiviert ist. Wende dich an deinen Google oder YouTube-Ansprechpartner, um Zugriff zu beantragen.

Listet Mitglieder (früher „Sponsoren“) für einen Kanal auf. Die API-Anfrage muss von dem Kanalinhaber autorisiert werden.

Auswirkungen auf das Kontingent: Ein Aufruf dieser Methode hat einen Kontingentkosten von 2 Einheiten.

Anfrage

HTTP-Anfrage

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

Autorisierung

Für diese Anfrage ist eine Autorisierung mit dem folgenden 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
Mit dem Parameter part werden die Eigenschaften der Ressource member angegeben, die in der API-Antwort enthalten sein sollen. Lege den Parameterwert auf snippet fest.
Optionale Parameter
mode string
Mit dem Parameter mode wird angegeben, welche Mitglieder in die API-Antwort aufgenommen werden. Lege den Parameterwert auf einen der folgenden Werte fest:
  • all_current (Standard) – Listet aktuelle Mitglieder vom neuesten zum ältesten auf. 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 beigetreten sind oder ein Upgrade durchgeführt haben. Beachte, dass beim ersten Aufruf ein neuer Stream von Updates gestartet wird, aber keine Mitglieder zurückgegeben werden. Wenn du die Mitgliedschafts-Updates abrufen möchtest, musst du den Endpunkt mit dem nextPageToken in der gewünschten Häufigkeit abfragen.

    Wenn dieser Wert verwendet wird, enthält die API-Antwort immer ein nextPageToken.
maxResults unsigned integer
Mit dem Parameter maxResults wird die maximale Anzahl der Elemente angegeben, die im Ergebnissatz zurückgegeben werden sollen. Zulässige Werte sind 0 bis 1000 (einschließlich). Der Standardwert ist 5.
pageToken string
Mit dem Parameter pageToken wird eine bestimmte Seite im Ergebnis satz angegeben, die zurückgegeben werden soll. Das Token ist spezifisch für den mode der mit der ursprünglichen API-Anfrage verwendet wurde. Du kannst also kein Seitentoken verwenden, das mit einem Modus abgerufen wurde, um anschließend zu einem anderen Modus zu wechseln.
hasAccessToLevel string
Der Parameterwert hasAccessToLevel ist eine Level-ID, die das Mindestlevel angibt, das Mitglieder im Ergebnissatz haben sollten.
filterByMemberChannelId string
Mit dem Parameter filterByMemberChannelId wird eine durch Kommas getrennte Liste von Kanal-IDs angegeben, mit denen der Mitgliedsstatus bestimmter Nutzer überprüft werden kann. Beispiel: UC_1,UC_2,UC_3. Pro Aufruf können maximal 100 Kanäle angegeben werden.

Anfragetext

Gib 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 sind die Attribute definiert, die in dieser Ressource enthalten sind:

Attribute
kind string
Gibt den Typ der API-Ressource an. Der Wert ist youtube#memberListResponse.
etag etag
Das ETag dieser Ressource.
nextPageToken string
Das Token, das als Wert des pageToken Parameters verwendet werden kann, um die nächste Seite im Ergebnissatz abzurufen. Seitentokens können ablaufen. Deine Anwendung sollte das Token löschen und die API ohne pageToken aufrufen, um eine neue Anfrage zu starten.
pageInfo object
Das Objekt pageInfo enthält Paging-Informationen 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 Suchkriterien entsprechen.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen findest du in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
badRequest (400) channelMembershipsNotEnabled Für den Creator-Kanal, der die Anfrage autorisiert, ist die Kanal mitgliedschaft nicht aktiviert.
badRequest (400) invalidMode Der Wert des Parameters 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 Wert des Parameters 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 kein Level mit der angegebenen id.
badRequest (400) invalidFilterByMemberChannelId Der Parameterwert filterByMemberChannelId ist ungültig. Dieser Fehler tritt auf, wenn der filterByMemberChannelId Parameterwert mehr als 100 Kanäle angibt.