Members

Hinweis: Seit dem 31. März 2020 ersetzt der Endpunkt members den Endpunkt sponsors. Dieser wurde verworfen und 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.

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 steht für ein Mitglied eines YouTube-Kanals. Ein Mitglied unterstützt einen Creator regelmäßig und erhält besondere Vorteile. Mitglieder können beispielsweise chatten, wenn der Creator den „Nur für Mitglieder“-Modus für einen Chat aktiviert.

Methoden

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

list
Listet Mitglieder (früher „Unterstützer“) eines Kanals 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 zu dem YouTube-Kanal, der für die Mitgliedschaft bezahlt.

Hinweis: Es kann vorkommen, dass die Mitglieder eines Kanals keine Profildaten haben. Das ist beispielsweise bei Mitgliedern der Fall, die ihre Kanäle gelöscht haben, aber weiterhin für die Kanalmitgliedschaft bezahlen. Diese Mitglieder haben aber weiterhin Zugriff auf ihre Mitgliedschaftsvorteile.

API-Antworten enthalten Ressourcen für diese Mitglieder, um eine genaue Zählung zu gewährleisten, auch wenn die Profildetails im memberDetails-Objekt nicht festgelegt sind. Die membershipsDetails werden diesen Mitgliedern weiterhin zur Verfügung gestellt.
snippet.memberDetails.channelId string
YouTube-Kanal-ID des Mitgliedskanals. In diesem Fall kann die Kanal-ID auch als eindeutige Kennung für das Mitglied behandelt werden. Wenn sie nicht festgelegt ist, kann das Mitglied nicht eindeutig identifiziert werden. Die Ressource überträgt aber trotzdem Mitgliedschaftsdetails wie die Mitgliedschaftsstufen, auf die das Mitglied zugreifen kann, und die Dauer seiner Mitgliedschaft.
snippet.memberDetails.channelUrl string
Die URL des Kanals.
snippet.memberDetails.displayName string
Anzeigename des Kanals
snippet.memberDetails.profileImageUrl string
Die Avatar-URL des Kanals.
snippet.membershipsDetails object
Dieses Objekt enthält Details zur Mitgliedschaft für den Mitgliedskanal.
snippet.membershipsDetails.highestAccessibleLevel string
Die ID der höchsten Mitgliedschaftsstufe, auf die der Kanalmitglied derzeit Zugriff hat. Der Wert entspricht dem Attributwert id in einer membershipsLevel-Ressource.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Der Name der höchsten Mitgliedschaftsstufe, auf die der Kanalmitglied derzeit Zugriff hat. Der Wert entspricht dem Attributwert displayName in einer membershipsLevel-Ressource.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Eine Liste mit IDs für alle Mitgliedschaftsstufen, auf die der Nutzer derzeit zugreifen kann. Die Liste enthält die derzeit aktive Ebene und alle darunter liegenden Ebenen.
snippet.membershipsDuration object
Dieses Objekt enthält Informationen zur Gesamtdauer der Mitgliedschaft des aktuellen Mitglieds ohne Berücksichtigung der Preisstufen. Das Attribut snippet.membershipsDetails.membershipsDurationAtLevel[] enthält dann eine Liste von Objekten mit Details zu einem Zeitraum der Mitgliedschaft, in dem 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 Mitgliedschaftsstufe 1 und hat diese bis März. Im April und Mai hat das Mitglied keine Mitgliedschaft. Im Juni wird die Mitgliedschaft dann wieder auf Stufe 1 fortgesetzt. Im August wird die Mitgliedschaft dann auf Stufe 2 umgestellt. Bei einem API-Aufruf im Oktober würde die Ressource member also Folgendes enthalten: 
"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 des Beginns der aktuellen Mitgliedschaft des Mitglieds. Mit anderen Worten: Das Mitglied hat seit diesem Datum und dieser Uhrzeit kontinuierlich eine Mitgliedschaft. Es kann allerdings sein, dass unterschiedliche Zeiträume auf unterschiedlichen Mitgliedschaftsstufen ausgegeben wurden.
snippet.membershipsDuration.memberTotalDurationMonths integer
Die Anzahl der Monate, abgerundet auf die nächste Ganzzahl, wann der Nutzer Mitglied war. Der Wert spiegelt die Anzahl der vollständigen Monate wider, in denen das Mitglied eine Mitgliedschaft innehatte. Diese Zahl bedeutet jedoch nicht, dass das Mitglied seit diesem Zeitraum kontinuierlich eine Mitgliedschaft hat.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Eine Liste von Objekten, in der jedes Objekt Details zu einem Zeitraum der Mitgliedschaft enthält, in dem das Mitglied Zugriff auf eine bestimmte Mitgliedschaftsstufe hatte. Die Liste enthält für jede Mitgliedschaftsstufe, auf die das Mitglied derzeit zugreifen kann, ein Objekt.
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
Der Zeitpunkt (Datum und Uhrzeit), ab dem das Mitglied Zugriff auf die angegebene Mitgliedschaftsstufe hatte. Mit anderen Worten: Das Mitglied hatte seit diesem Datum und dieser Uhrzeit kontinuierlich Zugriff auf die Stufe. Es kann sein, dass zu unterschiedlichen Zeiträumen die Mitgliedschaft bei einer höheren Mitgliedschaftsstufe verbraucht wurde.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Die Anzahl der Monate, abgerundet auf die nächste Ganzzahl, in der der Nutzer Zugriff auf die angegebene Ebene hatte. Der Wert spiegelt die Anzahl der vollständigen Monate wider, in denen das Mitglied Zugriff auf die Stufe hatte. Die Zahl bedeutet jedoch nicht, dass das Mitglied seit so vielen Monaten ununterbrochen eine Mitgliedschaft hat.