Captions: list

Zwraca listę ścieżek napisów powiązanych z określonym filmem. Pamiętaj, że odpowiedź interfejsu API nie zawiera rzeczywistych napisów, a metoda captions.download umożliwia pobranie ścieżki napisów.

Wpływ limitu: wywołanie tej metody ma limit kosztów wynoszący 50 jednostek.

Typowe przypadki użycia

Żądanie

Żądanie HTTP

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

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.force-ssl
https://www.googleapis.com/auth/youtubepartner

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 caption części zasobów, które będzie zawierać odpowiedź interfejsu API.

Poniższa lista zawiera nazwy part, które możesz uwzględnić w wartości parametru:
  • id
  • snippet
videoId string
Parametr videoId określa identyfikator filmu w YouTube, w przypadku którego interfejs API powinien zwracać napisy.
Parametry opcjonalne
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów, które identyfikują caption zasoby, które powinny zostać pobrane. Każdy identyfikator musi określać ścieżkę napisów powiązaną z określonym filmem.
onBehalfOfContentOwner string
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów w sieci reklamowej YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane logowania żądania autoryzacji to użytkownik YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Ten parametr jest przeznaczony dla partnerów w sieci reklamowej YouTube, którzy mają wiele kanałów YouTube i zarządzają nimi. Umożliwia właścicielom treści uwierzytelnianie tylko raz oraz dostęp do wszystkich filmów i kanałów bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Rzeczywiste konto CMS, z którego użytkownik się uwierzytelnia, musi być powiązane z określonym właścicielem treści w YouTube.

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#captionListResponse",
  "etag": etag,
  "items": [
    caption 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#captionListResponse.
etag etag
Otagowanie tego zasobu.
items[] list
Lista napisó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
forbidden (403) forbidden Nie udało się pobrać co najmniej 1 ścieżki napisów, ponieważ uprawnienia powiązane z żądaniem nie są wystarczające do pobrania żądanych zasobów. Żądanie może nie zostać prawidłowo autoryzowane.
notFound (404) captionNotFound Nie udało się znaleźć co najmniej 1 z podanych ścieżek napisów. Ten błąd występuje, jeśli parametr videoId identyfikuje rzeczywisty film, ale parametr id identyfikuje identyfikatory ścieżek napisów, które nie istnieją, lub identyfikatory ścieżek powiązanych z innymi filmami. Sprawdź, czy wartości parametrów id i videoId żądania są prawidłowe.
notFound (404) videoNotFound Nie udało się znaleźć filmu określonego przez parametr videoId.

Wypróbuj

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