Members

Uwaga: od 31 marca 2020 r. punkt końcowy members zastępuje punkt końcowy sponsors, który jest wycofany i przestanie być obsługiwany 30 września 2020 r. lub później. Klienty interfejsu API powinny zaktualizować wywołania metody sponsors.list, aby używały zamiast niej metody members.list.

Z tego punktu końcowego mogą korzystać tylko poszczególni twórcy, aby przesyłać prośby dotyczące ich własnych kanałów w YouTube z włączoną funkcją wspierania kanału. Aby poprosić o dostęp, skontaktuj się ze swoim przedstawicielem Google lub YouTube.

Zasób member reprezentuje osobę wspierającą kanał w YouTube. Wspierający zapewnia cyklicznie wsparcie finansowe twórcy i otrzymuje wyjątkowe korzyści. Na przykład wspierający mogą rozmawiać na czacie, gdy twórca włączy tryb tylko dla wspierających.

Metody

Interfejs API obsługuje te metody zasobów member:

list
Wyświetla listę wspierających (dawniej nazywanych „sponsorami”) kanału. Żądanie do interfejsu API musi być autoryzowane przez właściciela kanału.

Reprezentacja zasobu

Poniższa struktura JSON pokazuje format zasobu member:

{
  "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,
        }
      ]
    }
  }
}

Właściwości

Poniższa tabela przedstawia właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartością będzie youtube#member.
etag etag
ETag tego zasobu.
snippet object
Obiekt snippet zawiera szczegółowe informacje o użytkowniku.
snippet.creatorChannelId string
Identyfikator kanału YouTube twórcy, który oferuje wspieranie.
snippet.memberDetails object
Ten obiekt zawiera dane profilowe kanału w YouTube, który płaci za wspieranie.

Pamiętaj, że kanał może mieć wspierających, których dane z profilu są niedostępne. Dotyczy to na przykład wspierających, którzy usunęli swoje kanały, ale nadal płacą za wspieranie. Pamiętaj, że osoby te nadal mają dostęp do korzyści wynikających z subskrypcji.

Odpowiedzi interfejsu API obejmują zasoby tych użytkowników, aby zapewnić dokładne liczby, mimo że szczegóły profilu w obiekcie memberDetails nie są ustawione. Elementy membershipsDetails nadal są dostępne dla takich użytkowników.
snippet.memberDetails.channelId string
Identyfikator kanału wspierającego kanał w YouTube. Jeśli jest ustawiony, identyfikator kanału może być również traktowany jako unikalny identyfikator wspierającego. Jeśli wartość nie jest skonfigurowana, nie będzie można jednoznacznie zidentyfikować użytkownika, ale zasób nadal przekazuje informacje o członkostwie, takie jak poziomy, do których ten użytkownik ma dostęp, oraz okres jego członkostwa.
snippet.memberDetails.channelUrl string
Adres URL kanału.
snippet.memberDetails.displayName string
Wyświetlana nazwa kanału.
snippet.memberDetails.profileImageUrl string
Adres URL awatara kanału.
snippet.membershipsDetails object
Ten obiekt zawiera szczegółowe informacje o członkostwie kanału wspierającego.
snippet.membershipsDetails.highestAccessibleLevel string
Identyfikator najwyższego poziomu wspierania, do którego dany kanał ma obecnie dostęp. Wartość odpowiada wartości właściwości id w zasobie membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Nazwa najwyższego poziomu wspierania, do którego obecnie ma dostęp dany kanał. Wartość odpowiada wartości właściwości displayName w zasobie membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Lista identyfikatorów wszystkich poziomów członkostwa, do których użytkownik ma obecnie dostęp. Lista zawiera obecnie aktywny poziom i wszystkie poziomy poniżej.
snippet.membershipsDuration object
Ten obiekt zawiera informacje o ogólnym okresie członkostwa bieżącego użytkownika, bez względu na poziomy cen. Właściwość snippet.membershipsDetails.membershipsDurationAtLevel[] zawiera listę obiektów ze szczegółowymi informacjami o okresie członkostwa, w którym użytkownik miał dostęp do określonego poziomu członkostwa.

Przykład poniżej pokazuje, jak działają te usługi: użytkownik kupuje w styczniu nowe wspieranie na poziomie 1, a ma do niego subskrypcję do marca. W kwietniu i maju użytkownik nie ma subskrypcji. W czerwcu użytkownik wznowi wspieranie, zaczynając od poziomu 1. Następnie w sierpniu przechodzi on na poziom 2. Jeśli więc wywołanie interfejsu API zostanie wykonane w październiku, zasób member będzie zawierał taki element: 
"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
Data i godzina rozpoczęcia bieżącego wspierania kanału. Oznacza to, że dany użytkownik ma członkostwo nieprzerwanie od tej daty i godziny. Pamiętaj, że różne okresy subskrypcji mogły trwać na różnych poziomach.
snippet.membershipsDuration.memberTotalDurationMonths integer
Liczba miesięcy, w których użytkownik korzystał z subskrypcji, zaokrąglona w dół do najbliższej liczby całkowitej. Ta wartość odzwierciedla liczbę pełnych miesięcy wspierania kanału, ale liczba ta nie oznacza, że dany użytkownik ma aktywne członkostwo przez tyle miesięcy.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Lista obiektów, z których każdy zawiera szczegółowe informacje o okresie członkostwa, w którym użytkownik miał dostęp do określonego poziomu członkostwa. Lista zawiera jeden obiekt na każdy poziom członkostwa, do którego użytkownik ma obecnie dostęp.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
Identyfikator poziomu wspierania. Wartość odpowiada wartości właściwości id w zasobie membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
Data i godzina, od których wspierający miał dostęp do określonego poziomu wspierania. Oznacza to, że użytkownik nieprzerwanie miał dostęp do poziomu od tej daty i godziny. Pamiętaj, że różne okresy subskrypcji mogły zostać wykorzystane na wyższych poziomach.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Liczba miesięcy, zaokrąglona w dół do najbliższej liczby całkowitej, przez które użytkownik miał dostęp do określonego poziomu. Ta wartość odzwierciedla liczbę pełnych miesięcy, w których wspierający miał dostęp do danego poziomu, ale liczba ta nie oznacza, że wspiera on kanał przez tyle miesięcy.