Captions: list

Zwraca listę ścieżek z napisami 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 z napisami.

Wpływ na limit: wywołanie tej metody kosztuje 50 jednostek limitu.

Częste zastosowania

Żądanie

Żądanie HTTP

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

Autoryzacja

To żądanie wymaga autoryzacji z co najmniej jednym 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 tej tabeli znajdziesz listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa części zasobu caption, które będą uwzględnione w odpowiedzi interfejsu API.

Poniżej znajdziesz listę nazw part, które możesz uwzględnić w wartości parametru:
  • id
  • snippet
videoId string
Parametr videoId określa identyfikator filmu w YouTube, dla którego interfejs API ma zwrócić ścieżki napisów.
Parametry opcjonalne
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów, które identyfikują zasoby caption, które mają zostać pobrane. Każdy identyfikator musi identyfikować ścieżkę z napisami powiązaną z określonym filmem.
onBehalfOfContentOwner string
Ten parametr może być używany tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów YouTube.

Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające autoryzację żądania identyfikują użytkownika systemu CMS YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Parametr `**onBehalfOfContentOwner**` wskazuje, że dane uwierzytelniające żądania identyfikują użytkownika systemu zarządzania treścią w YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Umożliwia to właścicielom treści jednokrotne uwierzytelnienie i uzyskanie dostępu do wszystkich danych wideo i danych kanału bez konieczności podawania danych uwierzytelniających dla każdego pojedynczego kanału. Rzeczywiste konto CMS, za pomocą którego uwierzytelnia się użytkownik, musi być połączone z określonym właścicielem treści w YouTube.

Rzeczywiste konto CMS, za pomocą którego użytkownik się uwierzytelnia, musi być połączone z określonym właścicielem treści w YouTube.

Treść żądania

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

Odpowiedź

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

Jeśli operacja się uda, ta metoda zwróci treść odpowiedzi o tej strukturze:

Właściwości

W tej tabeli znajdziesz definicje właściwości, które pojawiają się w tym zasobie:
kind string
Określa typ zasobu interfejsu API. Wartość to youtube#captionListResponse.
etag etag
Etag tego zasobu.
items[] list
Lista napisów, które pasują do kryteriów żądania.

Błędy

W tej tabeli 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 z napisami, ponieważ uprawnienia powiązane z żądaniem są niewystarczające do pobrania żądanych zasobów. Żądanie może nie być prawidłowo autoryzowane.
notFound (404) captionNotFound Nie udało się znaleźć co najmniej 1 z podanych ścieżek z napisami. 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ązane z innymi filmami. Sprawdź wartości parametrów id i videoId w żądaniu, aby upewnić się, że są prawidłowe.
notFound (404) videoNotFound Nie udało się znaleźć filmu zidentyfikowanego przez parametr videoId.

Wypróbuj

Aby wywołać ten interfejs API i zobaczyć żądanie do interfejsu API oraz odpowiedź, użyj APIs Explorer.