Members: list

Uwaga: 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.

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

Wpływ na limit: wywołanie tej metody ma koszt limitu wynoszący 2 jednostki.

Prośba

Żądanie HTTP

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

Upoważnienie

To żądanie wymaga autoryzacji w tym zakresie:

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

Parametry

W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa właściwości zasobu member, które będzie zawierać odpowiedź interfejsu API. Ustaw wartość parametru na snippet.
Parametry opcjonalne
mode string
Parametr mode wskazuje, którzy użytkownicy zostaną uwzględnieni w odpowiedzi interfejsu API. Ustaw wartość parametru na jedną z tych wartości:
  • all_current (domyślnie) – lista obecnych wspierających, od najnowszych do najstarszych. Jeśli używana jest ta wartość, lista osiąga się, gdy odpowiedź interfejsu API nie zawiera klasy nextPageToken.
  • updates – wyświetla tylko użytkowników, którzy dołączyli lub dokonali uaktualnienia od poprzedniego wywołania interfejsu API. Pamiętaj, że pierwsze wywołanie uruchamia nowy strumień aktualizacji, ale nie zwraca żadnych użytkowników. Aby zacząć pobierać aktualizacje członkostwa, musisz odpytywać punkt końcowy za pomocą obiektu nextPageToken z wybraną częstotliwością.

    Pamiętaj, że gdy ta wartość jest używana, odpowiedź interfejsu API zawsze zawiera nextPageToken.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zbiorze wyników. Akceptowane wartości to od 0 do 1000 (włącznie). Wartością domyślną jest 5.
pageToken string
Parametr pageToken wskazuje w zestawie wyników konkretną stronę, która ma zostać zwrócona. Token jest specyficzny dla mode używanego w oryginalnym żądaniu do interfejsu API, dlatego nie można użyć tokena strony pobranego w jednym trybie, by 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 zestawie wyników.
filterByMemberChannelId string
Parametr filterByMemberChannelId to rozdzielona przecinkami lista identyfikatorów kanałów, za pomocą których można sprawdzać stan wspierania konkretnych użytkowników. Na przykład: UC_1,UC_2,UC_3. Można określić maksymalnie 100 kanałów na wywołanie.

Treść żądania

Nie podawaj treści żądania podczas wywoływania tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:

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

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#memberListResponse.
etag etag
ETag tego zasobu.
nextPageToken string
Token, który może być używany jako wartość parametru pageToken w celu pobrania następnej strony w zbiorze wyników. Tokeny strony mogą wygasnąć, a Twoja aplikacja powinna usunąć token i wywołać interfejs API bez pageToken, aby rozpocząć nowe żądanie.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zestawie.
pageInfo.resultsPerPage integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
items[] list
Lista użytkowników spełniających 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 szczegółów znajdziesz w dokumentacji komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
badRequest (400) channelMembershipsNotEnabled Kanał twórcy, który autoryzował prośbę, nie ma włączonego 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, który został 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 został rozpoznany.
badRequest (400) invalidHasAccessToLevel Wartość parametru hasAccessToLevel jest nieprawidłowa. Nie ma poziomu o podanej wartości 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.