Members: list

Uwaga: tego punktu końcowego mogą używać tylko pojedynczy twórcy, aby wysyłać żądania dotyczące własnego kanału YouTube z włączoną funkcją wspierania kanału. Aby uzyskać dostęp, skontaktuj się z przedstawicielem Google lub YouTube.

Wyświetla listę członków (wcześniej nazywanych „sponsorami”) kanału. Żądanie do interfejsu API musi być autoryzowane przez właściciela kanału.

Wpływ na limit: Wywołanie tej metody wiąże się z kosztem limitu wynoszącym 2 jednostki.

Żądanie

Żądanie HTTP

GET https://www.googleapis.com/youtube/v3/members

Autoryzacja

To żądanie wymaga autoryzacji z tym zakresem:

Zakres
https://www.googleapis.com/auth/youtube.channel-memberships.creator

Parametry

W tabeli poniżej znajdziesz listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Wymagane parametry
part string
Parametr part określa właściwości zasobu member, które będą uwzględnione w odpowiedzi interfejsu API. Ustaw wartość parametru na snippet.
Opcjonalne parametry
mode string
Parametr mode wskazuje, którzy członkowie będą uwzględnieni w odpowiedzi interfejsu API. Ustaw wartość parametru na jedną z tych wartości:
  • all_current (domyślnie) – wyświetla listę aktualnych członków od najnowszych do najstarszych. Gdy ta wartość jest używana, koniec listy jest osiągany, gdy odpowiedź interfejsu API nie zawiera parametru nextPageToken.
  • updates – wyświetla listę tylko tych członków, którzy dołączyli lub przeszli na wyższy poziom od czasu poprzedniego wywołania interfejsu API. Pamiętaj, że pierwsze wywołanie rozpoczyna nowy strumień aktualizacji, ale nie zwraca żadnych członków. Aby zacząć pobierać aktualizacje dotyczące członkostwa, musisz wysyłać zapytania do punktu końcowego z użyciem parametru nextPageToken z wybraną częstotliwością.

    Pamiętaj, że gdy używana jest ta wartość, odpowiedź interfejsu API zawsze zawiera parametr nextPageToken.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które mają zostać zwrócone w zbiorze wyników. Dopuszczalne wartości to od 0 do 1000 włącznie. Wartość domyślna to 5.
pageToken string
Parametr pageToken określa konkretną stronę w zbiorze wyników, która ma zostać zwrócona. Token jest specyficzny dla mode użytego w pierwotnym żądaniu do interfejsu API, więc nie możesz użyć tokena strony pobranego w jednym trybie, aby później przełączyć się na inny tryb.
hasAccessToLevel string
Wartość parametru hasAccessToLevel to identyfikator poziomu, który określa minimalny poziom, jaki powinni mieć członkowie w zbiorze wyników.
filterByMemberChannelId string
Parametr filterByMemberChannelId określa listę identyfikatorów kanałów rozdzieloną przecinkami, których można użyć do sprawdzenia statusu wspierającego konkretnych użytkowników. Na przykład, UC_1,UC_2,UC_3. W jednym wywołaniu można określić maksymalnie 100 kanałów.

Treść żądania

Podczas wywoływania tej metody nie podawaj treści żądania.

Odpowiedź

Jeśli operacja się uda, ta metoda zwróci treść odpowiedzi o tej strukturze:

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

Właściwości

W tabeli poniżej znajdziesz definicje właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość to youtube#memberListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać następną stronę w zbiorze wyników. Tokeny stron mogą wygasnąć, dlatego aplikacja powinna odrzucić token i wywołać interfejs API bez parametru pageToken, aby rozpocząć nowe żądanie.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zbiorze wyników.
pageInfo.resultsPerPage integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
items[] list
Lista członków, którzy spełniają kryteria żądania.

Błędy

W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej informacji znajdziesz w dokumentacji komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
badRequest (400) channelMembershipsNotEnabled Kanał twórcy autoryzujący żądanie nie ma włączonej funkcji wspierania kanału.
badRequest (400) invalidMode Wartość parametru mode jest nieprawidłowa. Ten błąd może wystąpić, jeśli parametr pageToken określa token pobrany w innym trybie niż określony.
badRequest (400) invalidPageToken Wartość parametru pageToken jest nieprawidłowa. Ten błąd może wystąpić, jeśli token strony użyty w żądaniu wygasł lub nie jest rozpoznawany.
badRequest (400) invalidHasAccessToLevel Wartość parametru hasAccessToLevel jest nieprawidłowa. Nie ma poziomu o podanym identyfikatorze id.
badRequest (400) invalidFilterByMemberChannelId Wartość parametru filterByMemberChannelId jest nieprawidłowa. Ten błąd występuje, jeśli wartość parametru filterByMemberChannelId określa więcej niż 100 kanałów.