Captions: list

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

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

Typowe przypadki użycia

Prośba

Żądanie HTTP

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

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

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 caption, 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ć ścieżki z napisami.
Parametry opcjonalne
id string
Parametr id zawiera rozdzieloną przecinkami listę identyfikatorów identyfikujących zasoby caption, które należy pobrać. Każdy identyfikator musi określać ścieżkę napisów powiązaną z danym filmem.
onBehalfOfContentOwner string
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla dostawców treści w YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające żądanie identyfikują użytkownika YouTube CMS działającego w imieniu właściciela treści określonego w wartości parametru. Jest on przeznaczony dla dostawców treści w YouTube, którzy mają wiele różnych kanałów w YouTube i nimi zarządzają. Dzięki niej właściciele treści mogą jednorazowo uwierzytelnić się i uzyskiwać dostęp do wszystkich swoich filmów oraz danych dotyczących kanałów bez konieczności podawania danych uwierzytelniających dla każdego kanału z osobna. Konto CMS, za pomocą którego użytkownik uwierzytelnia się, musi być powiązane z określonym właścicielem treści YouTube.

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#captionListResponse",
  "etag": etag,
  "items": [
    caption 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#captionListResponse.
etag etag
ETag 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 szczegółów 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 jednej ścieżki napisów, ponieważ uprawnienia powiązane z żądaniem są niewystarczające do pobrania żądanych zasobów. Żądanie może nie być poprawnie autoryzowane.
notFound (404) captionNotFound Nie udało się znaleźć co najmniej jednej podanej ścieżki napisów. Ten błąd występuje, gdy parametr videoId identyfikuje 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 interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.