Members

Hinweis: Seit dem 31. März 2020 wird der Endpunkt members durch den Endpunkt sponsors ersetzt. Der Endpunkt sponsors wird eingestellt und ab dem 30. September 2020 nicht mehr unterstützt. API-Clients sollten Aufrufe der 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 ihren eigenen YouTube-Kanal zu stellen, auf dem Kanalmitgliedschaften aktiviert sind. Wenden Sie sich an Ihren Google- oder YouTube-Ansprechpartner, um Zugriff anzufordern.

Eine member-Ressource stellt ein Kanalmitglied für einen YouTube-Kanal dar. Ein Mitglied unterstützt einen Creator regelmäßig finanziell und erhält dafür besondere Vorteile. So können Mitglieder 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 als „Unterstützer“ bezeichnet) 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 sind die Eigenschaften aufgeführt, 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 snippet-Objekt enthält Details zum Mitglied.
snippet.creatorChannelId string
Die YouTube-Kanal-ID des Creators, der die Mitgliedschaft anbietet.
snippet.memberDetails object
Dieses Objekt enthält Profildaten zum YouTube-Kanal, der die Mitgliedschaft bezahlt.

Hinweis: Ein Kanal kann Mitglieder mit nicht verfügbaren Profildaten haben. Das ist beispielsweise der Fall bei Mitgliedern, die ihre Kanäle gelöscht haben, aber weiterhin für Mitgliedschaften bezahlen. Hinweis: Diese Mitglieder können weiterhin auf ihre Mitgliedschaftsvorteile zugreifen.

API-Antworten enthalten Ressourcen für diese Mitglieder, um eine korrekte Anzahl zu gewährleisten, auch wenn die Profildetails im memberDetails-Objekt nicht festgelegt sind. Die membershipsDetails werden für diese 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 verwendet werden. Ist der Wert nicht festgelegt, kann das Mitglied nicht eindeutig identifiziert werden. Die Ressource enthält jedoch weiterhin Mitgliedschaftsdetails wie die Ebenen, auf die das Mitglied zugreifen kann, und die Dauer der 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 Details zur Mitgliedschaft für den Mitgliedskanal.
snippet.membershipsDetails.highestAccessibleLevel string
Die ID der höchsten Mitgliedschaftsstufe, auf die der Mitgliedskanal derzeit zugreifen kann. Der Wert entspricht dem id-Attributwert in einer membershipsLevel-Ressource.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Der Name der höchsten Mitgliedschaftsstufe, auf die der Mitgliedskanal derzeit zugreifen kann. Der Wert entspricht dem displayName-Attributwert in einer membershipsLevel-Ressource.
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 derzeit 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. 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 Eigenschaften funktionieren: Ein Mitglied kauft im Januar eine neue Mitgliedschaft auf Mitgliedschaftsstufe 1 und hat diese Mitgliedschaft bis März. Im April und Mai hat das Mitglied keine Mitgliedschaft. Im Juni beginnt das Mitglied seine Mitgliedschaft wieder, wieder auf Stufe 1. Im August wechselt das Mitglied dann zu Stufe 2. Wenn also im Oktober ein API-Aufruf erfolgt, enthält die member-Ressource 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
Das Datum und die Uhrzeit, an dem die aktuelle Mitgliedschaft des Mitglieds begonnen hat. Mit anderen Worten: Das Mitglied ist seit diesem Datum und dieser Uhrzeit ununterbrochen Mitglied. Beachte, dass du die Mitgliedschaft möglicherweise in verschiedenen Mitgliedschaftsstufen abgeschlossen hast.
snippet.membershipsDuration.memberTotalDurationMonths integer
Die Anzahl der Monate, in denen der Nutzer Mitglied war, abgerundet auf die nächste ganze Zahl. Der Wert gibt die Anzahl der vollen Monate an, in denen das Mitglied eine Mitgliedschaft hatte. Die Zahl bedeutet jedoch nicht, dass das Mitglied während dieser vielen Monate ununterbrochen eine Mitgliedschaft hatte.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Eine Liste von Objekten, von denen jedes Details zu einem Zeitraum der Mitgliedschaft enthält, in dem das Mitglied Zugriff auf ein bestimmtes Mitgliedschaftslevel 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 id-Attributwert in einer membershipsLevel-Ressource.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
Das Datum und die Uhrzeit, ab dem das Mitglied Zugriff auf die angegebene Mitgliedschaftsstufe hat. Mit anderen Worten: Das Mitglied hat seit diesem Datum und dieser Uhrzeit kontinuierlich Zugriff auf das Level. Beachte, dass du in verschiedenen Zeiträumen der Mitgliedschaft möglicherweise eine höhere Mitgliedschaftsstufe hattest.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Die Anzahl der Monate, auf die der Nutzer Zugriff auf die angegebene Ebene hatte, abgerundet auf die nächste ganze Zahl. Der Wert gibt an, wie viele volle Monate das Mitglied Zugriff auf das Level hatte. Er bedeutet nicht, dass das Mitglied während dieser Zeit ununterbrochen eine Mitgliedschaft hatte.