Sponsors: list

Uwaga: ta metoda została wycofana 31 marca 2020 roku. Została ona zastąpiona metodą members.list. Informacje na temat tej metody można znaleźć w dokumentacji interfejsu YouTube Data API.

Od 30 września 2020 r. lub później metoda sponsors.list nie będzie już obsługiwana. Klienty interfejsu API powinny zaktualizować wywołania do metody sponsors.list, aby zamiast niej używać metody members.list.

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

Typowe przypadki użycia

Żądanie

Żądanie HTTP

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

Upoważnienie

To żądanie wymaga autoryzacji z co najmniej jednym z poniższych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).

Zakres
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

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 sponsor części zasobów, które będą uwzględnione w odpowiedzi interfejsu API. Obsługiwane wartości to id i snippet.
Parametry opcjonalne
filter string
Parametr filter określa, którzy sponsorzy mają otrzymać zwrot środków. Wartość domyślna to newest.

Akceptowane wartości to:
  • all – zwraca wszystkich sponsorów, od najnowszych do najstarszych.
  • newest – zwraca jedną stronę najnowszych sponsorów. Kolejne prośby, w których podany jest nextPageToken, może pozyskiwać nowych subskrybentów.
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 050 (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. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken wskazują inne strony, które można pobrać.

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#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor resource
  ]
}

Usługi

Poniższa tabela określa właściwości, które pojawiają się w tym zasobie:

Usługi
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#sponsorListResponse.
etag etag
Otagowanie tego zasobu.
nextPageToken string
Token, który może zostać użyty jako wartość parametru pageToken, by pobrać następną stronę z zestawu wyników.
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 sponsoró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
forbidden (403) insufficientPermissions Nie masz odpowiednich uprawnień, aby wyświetlić sponsorów kanału.
invalidValue (400) invalidValueInRequest Żądanie zawiera nieprawidłową wartość.
invalidValue (400) sponsorshipNotEnabledForChannelId Na kanale nie włączono sponsorowania.

Wypróbuj

Użyj APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.