Sponsors: list

Uwaga: 31 marca 2020 r. ta metoda została wycofana. Została zastąpiona metodą members.list. Informacje o tej metodzie znajdziesz w dokumentacji YouTube Data API.

30 września 2020 r. lub później metoda sponsors.list przestanie być obsługiwana. Klienty interfejsu API powinny zaktualizować wywołania metody sponsors.list, aby używały zamiast niej metody members.list.

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

Typowe przypadki użycia

Prośba

Żądanie HTTP

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

Upoważnienie

To żądanie wymaga autoryzacji z użyciem co najmniej jednego z tych 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 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 części zasobów sponsor, które będzie zawierać odpowiedź interfejsu API. Obsługiwane wartości to id i snippet.
Parametry opcjonalne
filter string
Parametr filter określa, który kanał sponsoruje. Wartość domyślna to newest.

Akceptowane wartości:
  • all – zwracaj wszystkich sponsorów, od najnowszych do najstarszych.
  • newest – pokaż jedną stronę z listą najnowszych sponsorów. Kolejne żądania przy użyciu funkcji nextPageToken pobierają nowych subskrybentów w miarę rejestracji.
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 50 (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. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken identyfikują inne strony, które można pobrać.

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#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor 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#sponsorListResponse.
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 zestawie wyników.
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 sponsoró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
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 Kanał nie ma włączonego sponsorowania.

Wypróbuj

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