Members: list

Uwaga: z tego punktu końcowego mogą korzystać tylko poszczególni twórcy, aby przesyłać prośby dotyczące własnego kanału w YouTube, który wspiera kanał. Skontaktuj się z przedstawicielem Google lub YouTube, aby poprosić o dostęp.

Przedstawia osoby, które wspierają kanał (dawniej nazywane „sponsorami”). Żądanie do interfejsu API musi zostać autoryzowane przez właściciela kanału.

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

Żądanie

Żądanie HTTP

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

Upoważnienie

To żądanie wymaga autoryzacji w następującym zakresie:

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

Parametry

W poniższej tabeli podano 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ędą uwzględniane w odpowiedzi 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) – wyświetla listę obecnych członków (od najnowszych do najstarszych). W przypadku użycia tej wartości koniec listy jest osiągany, gdy odpowiedź interfejsu API nie zawiera nextPageToken.
  • updates – wyświetla tylko członków, którzy dołączyli lub przeszli od uaktualnienia od poprzedniego wywołania interfejsu API. Zwróć uwagę, że pierwsze wywołanie rozpoczyna nowy strumień aktualizacji, ale w rzeczywistości nie zwraca żadnych użytkowników. Aby rozpocząć pobieranie informacji o subskrypcjach, musisz przeprowadzić ankietę z punktem końcowym za pomocą nextPageToken z odpowiednią częstotliwością.

    Pamiętaj, że w przypadku tej wartości odpowiedź interfejsu API zawsze zawiera nextPageToken.
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zestawie wyników. Akceptowane wartości to 01000 (włącznie). Wartością domyślną jest 5.
pageToken string
Parametr pageToken wskazuje konkretną stronę w zestawie wyników, która powinna zostać zwrócona. Token dotyczy konkretnie mode, który jest używany w pierwotnym żądaniu interfejsu API, więc nie można użyć tokena strony pobranego w jednym trybie, aby przełączyć się na inny tryb.
hasAccessToLevel string
Wartość parametru hasAccessToLevel to identyfikator poziomu, który określa minimalny poziom, który powinien mieć użytkownicy w zbiorze wyników.
filterByMemberChannelId string
Parametr filterByMemberChannelId określa oddzieloną przecinkami listę identyfikatorów kanałów, których można używać do sprawdzania stanu wspierania konkretnych użytkowników. na przykład UC_1,UC_2,UC_3. Możesz określić maksymalnie 100 kanałów na połączenie.

Treść żądania

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

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź w następującym formacie:

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

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#memberListResponse.
etag etag
Otagowanie tego zasobu.
nextPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać następną stronę z zestawu wyników. Tokeny na stronie mogą wygasnąć, a aplikacja powinna usunąć token i wywołać interfejs API bez pageToken, aby rozpocząć nowe żądanie.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu dla zestawu wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zestawie wyników.
pageInfo.resultsPerPage integer
Liczba wyników zawartych 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 informacji 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ł żądanie, nie ma włączonego wspierania.
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ż ten 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 podanym id.
badRequest (400) invalidFilterByMemberChannelId Wartość parametru filterByMemberChannelId jest nieprawidłowa. Ten błąd występuje wtedy, gdy wartość parametru filterByMemberChannelId określa więcej niż 100 kanałów.