Members

Uwaga: od 31 marca 2020 roku punkt końcowy members zastąpi punkt końcowy sponsors, który został wycofany i nie będzie już obsługiwany 30 września 2020 roku. Klienty interfejsu API powinny zaktualizować wywołania metody sponsors.list, aby korzystały z metody members.list.

Punktu końcowego może używać tylko jeden twórca, aby wysyłać żądania dotyczące własnego kanału w YouTube, który wspiera kanał. Skontaktuj się z przedstawicielem Google lub YouTube, aby poprosić o dostęp.

Zasób member reprezentuje osobę wspierającą kanał w YouTube. Twórca zapewnia twórcom cykliczne wsparcie finansowe i specjalne korzyści. Twórcy mogą na przykład rozmawiać na czacie, gdy twórca włączy tryb tylko dla wspierających.

Metody

Interfejs API obsługuje następujące metody w przypadku zasobów member:

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

Reprezentowanie zasobów

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 określa właściwości, które pojawiają się w tym zasobie:

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

Pamiętaj, że wspierający mogą mieć kanały z niedostępnymi danymi profilu. Dotyczy to na przykład użytkowników, którzy usunęli swoje kanały, ale nadal płacą za wspieranie. Ci użytkownicy nadal mają dostęp do korzyści wynikających z subskrypcji.

Odpowiedzi interfejsu API zawierają zasoby dla tych członków, aby zapewnić dokładność obliczeń, mimo że szczegóły profilu w obiekcie memberDetails nie są ustawione. membershipsDetails nadal jest dostępny dla takich użytkowników.
snippet.memberDetails.channelId string
Identyfikator kanału YouTube wspierającego. Jeśli jest ustawiony, identyfikator kanału może być traktowany jako unikalny identyfikator wspierającego. Jeśli zasada nie jest skonfigurowana, nie można jednoznacznie zidentyfikować użytkownika, ale zasób i tak podaje szczegóły dotyczące członkostwa, takie jak poziomy, do których użytkownik ma dostęp, oraz czas trwania 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óły dotyczące wspierania kanału.
snippet.membershipsDetails.highestAccessibleLevel string
Identyfikator najwyższego poziomu, do którego wspierający mają obecnie dostęp. Wartość odpowiada wartości właściwości id w zasobie membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Nazwa najwyższego poziomu, do którego wspierający mają obecnie dostęp. Wartość odpowiada wartości właściwości displayName w zasobie membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Lista identyfikatorów wszystkich poziomów wspierania, do których użytkownik ma obecnie dostęp. Lista zawiera poziom aktywny i wszystkie znajdujące się pod nim poziomy.
snippet.membershipsDuration object
Ten obiekt zawiera informacje o ogólnym okresie członkostwa bieżącego wspierającego bez względu na poziomy cen. Następnie właściwość snippet.membershipsDetails.membershipsDurationAtLevel[] zawiera listę obiektów ze szczegółami okresu członkostwa, w którym użytkownik miał dostęp do danego poziomu wspierania.

Ten przykład pokazuje, jak działają te właściwości: użytkownik kupuje nową subskrypcję w styczniu na poziomie 1 i ma tę subskrypcję do marca. W kwietniu i maju użytkownik nie ma członkostwa. W czerwcu wspierający ponownie uruchomi wspieranie na poziomie 1. W sierpniu wspierający przechodzi na poziom 2. Jeśli więc wywołanie interfejsu API zostanie wykonane w październiku, zasób member powinien zawierać: 
"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żącej subskrypcji. Inaczej mówiąc, od tej daty i godziny wspierający jest członkiem kanału. Pamiętaj, że różne okresy wspierania mogły zostać wydane na różnych poziomach.
snippet.membershipsDuration.memberTotalDurationMonths integer
Liczba miesięcy zaokrąglona w dół do najbliższej liczby całkowitej, od której użytkownik był członkiem. Wartość odzwierciedla liczbę pełnych miesięcy wspierania kanału, ale nie oznacza, że korzystał on z niego cały czas.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Lista obiektów, z których każdy obiekt zawiera informacje na temat okresu członkostwa, w którym członek miał dostęp do konkretnego poziomu wspierania. Na liście znajdziesz jeden obiekt na każdy poziom wspierania, do którego użytkownik obecnie ma 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órej użytkownik miał dostęp do określonego poziomu wspierania. Inaczej mówiąc, użytkownik od tego dnia ma stały dostęp do poziomu. Pamiętaj, że różne okresy wspierania mogły zostać wydane na wyższych poziomach wspierania.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Liczba miesięcy w zaokrągleniu w dół do najbliższej liczby całkowitej, do której użytkownik miał dostęp na określonym poziomie. Ta wartość odzwierciedla liczbę pełnych miesięcy, w których wspierający miał dostęp do danego poziomu, ale nie wskazuje na to, że od danego miesiąca miał dostęp do subskrypcji.