Members

Hinweis: Ab dem 31. März 2020 ersetzt der Endpunkt members den Endpunkt sponsors, der inzwischen eingestellt ist und am oder nach dem 30. September 2020 nicht mehr unterstützt wird. API-Clients sollten Aufrufe der Methode sponsors.list so aktualisieren, dass stattdessen die Methode members.list verwendet wird.

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.

Eine member-Ressource repräsentiert ein Kanalmitglied für einen YouTube-Kanal. Ein Mitglied bietet einem Creator regelmäßig finanzielle Unterstützung und erhält spezielle Vorteile. Mitglieder können beispielsweise chatten, wenn der Creator den Modus nur für Mitglieder für einen Chat aktiviert.

Methoden

Die API unterstützt die folgenden Methoden für member-Ressourcen:

list
Listet Mitglieder (früher „Unterstützer“) für einen Kanal auf. Die API-Anfrage muss vom Kanalinhaber autorisiert werden.

Ressourcendarstellung

Die folgende JSON-Struktur zeigt das Format einer member-Ressource:

{
  "kind": "youtube#member",
  "etag": etag,
  "snippet": {
    "creatorChannelId": string,
    "memberDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "membershipsDetails": {
      "highestAccessibleLevel": string,
      "highestAccessibleLevelDisplayName": string,
      "accessibleLevels": [
        string
      ],
      "membershipsDuration": {
        "memberSince": datetime,
        "memberTotalDurationMonths": integer,
      },
      "membershipsDurationAtLevel": [
        {
          "level": string,
          "memberSince": datetime,
          "memberTotalDurationMonths": integer,
        }
      ]
    }
  }
}

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#member.
etag etag
Das ETag dieser Ressource.
snippet object
Das Objekt snippet enthält Details zum Mitglied.
snippet.creatorChannelId string
Die YouTube-Kanal-ID des Creators, der die Kanalmitgliedschaft anbietet
snippet.memberDetails object
Dieses Objekt enthält Profildaten zum YouTube-Kanal, über den die Mitgliedschaft bezahlt wird.

Hinweis: Ein Kanal kann auch Mitglieder mit nicht verfügbaren Profildaten haben. Das ist zum Beispiel der Fall, wenn Mitglieder ihren Kanal gelöscht haben, aber immer noch für die Kanalmitgliedschaft zahlen. Beachte, dass diese Mitglieder weiterhin von den Vorteilen der Mitgliedschaft profitieren können.

API-Antworten enthalten Ressourcen für diese Mitglieder, um genaue Zählungen zu ermöglichen, auch wenn die Profildetails im memberDetails-Objekt nicht festgelegt sind. Die membershipsDetails werden für solche Mitglieder weiterhin bereitgestellt.
snippet.memberDetails.channelId string
Die YouTube-Kanal-ID des Mitgliedskanals. Wenn sie festgelegt ist, kann die Kanal-ID auch als eindeutige Kennung für das Mitglied behandelt werden. Wenn dies nicht festgelegt ist, kann das Mitglied nicht eindeutig identifiziert werden, aber die Ressource vermittelt trotzdem Mitgliedschaftsdetails wie die Stufen, auf die das Mitglied zugreifen kann, und die Dauer seiner Mitgliedschaft.
snippet.memberDetails.channelUrl string
Die URL des Kanals
snippet.memberDetails.displayName string
Der Anzeigename des Kanals.
snippet.memberDetails.profileImageUrl string
Die Avatar-URL des Kanals.
snippet.membershipsDetails object
Dieses Objekt enthält Mitgliedschaftsdetails für den Kanal des Mitglieds.
snippet.membershipsDetails.highestAccessibleLevel string
Die ID der höchsten Mitgliedschaftsstufe, auf die der Mitgliedskanal aktuell Zugriff hat. Der Wert entspricht dem Attributwert id in einer Ressource vom Typ membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Der Name der höchsten Mitgliedschaftsstufe, auf die der Mitgliedskanal aktuell Zugriff hat. Der Wert entspricht dem Attributwert displayName in einer Ressource vom Typ membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Eine Liste der IDs für alle Mitgliedschaftsstufen, auf die der Nutzer derzeit zugreifen kann. Die Liste enthält die aktuell aktive Ebene und alle darunter liegenden Ebenen.
snippet.membershipsDuration object
Dieses Objekt enthält Informationen zur Gesamtdauer der Mitgliedschaft des aktuellen Mitglieds, unabhängig von den Preisstufen. Die Property snippet.membershipsDetails.membershipsDurationAtLevel[] enthält dann eine Liste von Objekten mit Details zu einer bestimmten Mitgliedschaftsdauer, in der das Mitglied Zugriff auf eine bestimmte Mitgliedschaftsstufe hatte.

Das folgende Beispiel zeigt, wie diese Properties funktionieren: Ein Mitglied kauft im Januar eine neue Mitgliedschaft auf Ebene 1 und hat diese bis März. Im April und Mai hat das Mitglied keine Mitgliedschaft. Im Juni hat das Mitglied seine Mitgliedschaft wieder auf Ebene 1 fortgesetzt. Im August aktualisiert das Mitglied seine Mitgliedschaft auf Stufe 2. Wenn ein API-Aufruf im Oktober erfolgt, enthält die Ressource member Folgendes: 
"membershipsDetails": {
  "membershipsDuration": {
    "memberSince": "2020-06-01T12:00:00",
    "memberTotalDurationMonths": 7,
  },
  "membershipsDurationAtLevel": [
    {
      "level": "level_1_ID",
      "memberSince": "2020-06-01T12:00:00",
      "memberTotalDurationMonths": 7
    },
    {
      "level": "level_2_ID",
      "memberSince": "2020-08-01T12:00:00",
      "memberTotalDurationMonths": 2
    },
  ]
}
snippet.membershipsDuration.memberSince datetime
Datum und Uhrzeit der aktuellen Mitgliedschaft des Mitglieds. Mit anderen Worten: Das Mitglied hatte seit diesem Datum und dieser Uhrzeit kontinuierlich eine Mitgliedschaft. Es kann sein, dass für verschiedene Mitgliedschaftszeiträume unterschiedliche Mitgliedschaftsstufen berechnet wurden.
snippet.membershipsDuration.memberTotalDurationMonths integer
Die Anzahl der Monate, die auf die nächste Ganzzahl abgerundet sind, in der der Nutzer Mitglied ist. Der Wert gibt die Anzahl der vollständigen Monate an, in denen das Mitglied eine Mitgliedschaft hat, aber die Zahl deutet nicht darauf hin, dass das Mitglied seit vielen Monaten kontinuierlich Mitglied ist.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Eine Liste von Objekten, in der jedes Objekt Details zu einer Mitgliedschaftsdauer enthält, in der das Mitglied Zugriff auf eine bestimmte Mitgliedschaftsstufe hatte. Die Liste enthält ein Objekt für jede Mitgliedschaftsstufe, auf die das Mitglied derzeit zugreifen kann.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
Die ID der Mitgliedschaftsstufe. Der Wert entspricht dem Attributwert id in einer Ressource vom Typ membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
Das Datum und die Uhrzeit, ab der bzw. zu der das Mitglied Zugriff auf die angegebene Mitgliedschaftsstufe hatte. Das Mitglied hatte also seit diesem Datum fortlaufend Zugriff auf die Stufe. Es kann sein, dass für längere Mitgliedschaftsstufen höhere Mitgliedschaftsstufen aufgewendet wurden.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Die auf die nächste Ganzzahl abgerundete Anzahl von Monaten, die der Nutzer Zugriff auf die angegebene Ebene hatte. Der Wert gibt die Anzahl der vollständigen Monate an, in denen das Mitglied Zugriff auf die Stufe hatte. Die Zahl deutet jedoch nicht darauf hin, dass das Mitglied seit vielen Monaten kontinuierlich Mitglied ist.