Members

Uwaga: od 31 marca 2020 r. punkt końcowy members zastąpi punkt końcowy sponsors, który został wycofany i nie będzie już obsługiwany po 30 września 2020 r. Klienci interfejsu API powinni zaktualizować wywołania metody sponsors.list, aby zamiast niej używać metody members.list.

Tego punktu końcowego mogą używać tylko pojedynczy twórcy, aby wysyłać prośby dotyczące własnych kanałów w YouTube z włączonymi subskrypcjami. Aby poprosić o dostęp, skontaktuj się z przedstawicielem Google lub YouTube.

Zasób member reprezentuje wspierającego kanał w YouTube. Wspierający regularnie wpłacają pieniądze twórcy i otrzymują specjalne korzyści. Na przykład wspierający mogą korzystać z czatu, gdy twórca włączy tryb tylko dla wspierających.

Metody

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

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

Reprezentacja zasobu

Struktura JSON poniżej 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

Właściwości występujące w tym zasobie są opisane w tabeli poniżej:

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

Pamiętaj, że kanał może mieć wspierających, którzy mają niedostępne dane profilu. Dzieje się tak na przykład w przypadku wspierających, którzy usunęli swoje kanały, ale nadal płacą za wspieranie. Pamiętaj, że 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ładne zliczanie, mimo że szczegóły profilu w obiekcie memberDetails nie są ustawione. Te opcje: membershipsDetails są nadal dostępne dla takich wspierających.
snippet.memberDetails.channelId string
Identyfikator kanału YouTube wspieranego kanału. Jeśli jest ustawiony, identyfikator kanału może być traktowany jako unikalny identyfikator wspierającego. Jeśli nie jest ustawiony, nie można jednoznacznie zidentyfikować wspierającego, ale zasób nadal zawiera szczegóły dotyczące wspierania, takie jak poziomy, do których ma dostęp wspierający, oraz czas trwania wspierania.
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 członkostwa na kanale wspierającego.
snippet.membershipsDetails.highestAccessibleLevel string
Identyfikator najwyższego poziomu wspierania, do którego kanał wspierający 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 ma dostęp kanał wspierający. 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 obejmuje: aktualny poziom i wszystkie poziomy poniżej niego.
snippet.membershipsDuration object
Ten obiekt zawiera informacje o ogólnym czasie trwania subskrypcji obecnego subskrybenta bez względu na poziomy cen. Właściwość snippet.membershipsDetails.membershipsDurationAtLevel[] zawiera listę obiektów z informacjami o okresie członkostwa, w którym użytkownik miał dostęp do określonego poziomu członkostwa.

Ten przykład pokazuje, jak działają te właściwości: użytkownik kupuje nową subskrypcję w styczniu na poziomie 1 i ma ją do marca. W kwietniu i maju użytkownik nie miał subskrypcji. W czerwcu wspierający ponownie rozpoczyna wspieranie, ponownie na poziomie 1. Następnie w sierpniu wspierający przechodzi na poziom 2. Jeśli więc wywołanie interfejsu API zostanie wykonane w październiku, zasób member będzie zawierać te informacje: 
"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 członkostwa. Oznacza to, że użytkownik miał subskrypcję nieprzerwanie od tej daty i godziny. Pamiętaj, że różne okresy wspierania mogły być spędzone na różnych poziomach wspierania.
snippet.membershipsDuration.memberTotalDurationMonths integer
Liczba miesięcy (zaokrąglona w dół do najbliższej liczby całkowitej) od momentu, gdy użytkownik został członkiem. Wartość ta odzwierciedla liczbę pełnych miesięcy, przez które użytkownik był wspierającym, ale nie oznacza, że wspierał przez taką samą liczbę 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 dla każdego poziomu 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órej użytkownik ma dostęp do określonego poziomu członkostwa. Innymi słowy, użytkownik miał nieprzerwany dostęp do poziomu od tej daty i godziny. Pamiętaj, że różne okresy wspierania mogły być spędzone na wyższych poziomach wspierania.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Liczba miesięcy zaokrąglona w dół do najbliższej liczby całkowitej, w których użytkownik miał dostęp do określonego poziomu. Wartość ta odpowiada liczbie pełnych miesięcy, przez które użytkownik miał dostęp do danego poziomu, ale nie oznacza, że użytkownik miał ten poziom przez taką samą liczbę miesięcy.