Belirtilen videoyla ilişkili altyazı parçalarının listesini döndürür. API yanıtının gerçek altyazıları içermediğini ve captions.download
yönteminin bir altyazı parçası alma özelliği sağladığını unutmayın.
Kota etkisi: Bu yönteme yapılan çağrının kota maliyeti 50 birimdir.
Yaygın kullanım alanları
İstek
HTTP isteği
GET https://www.googleapis.com/youtube/v3/captions
Yetkilendirme
Bu istek için aşağıdaki kapsamlardan en az birinin yetkilendirilmesi gerekir (kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinin).
Kapsam |
---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
Parametreler
Aşağıdaki tabloda, bu sorgunun desteklediği parametreler listelenmiştir. Listelenen tüm parametreler sorgu parametreleridir.
Parametreler | ||
---|---|---|
Gerekli parametreler | ||
part |
string part parametresi, API yanıtının içereceği caption kaynak bölümlerini belirtir.Aşağıdaki listede, parametre değerine ekleyebileceğiniz part adları yer almaktadır:
|
|
videoId |
string videoId parametresi, API'nin altyazı parçalarını döndürmesi gereken videonun YouTube video kimliğini belirtir. |
|
İsteğe bağlı parametreler | ||
id |
string id parametresi, alınması gereken caption kaynaklarını tanımlayan kimliklerin virgülle ayrılmış listesini belirtir. Her kimlik, belirtilen videoyla ilişkili bir altyazı parçası tanımlamalıdır. |
|
onBehalfOfContentOwner |
string Bu parametre yalnızca uygun bir yetkili istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortakları içindir. onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin, parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube İYS kullanıcısını tanımladığını gösterir. Bu parametre, birçok farklı YouTube kanalının sahibi ve yöneticisi olan YouTube içerik iş ortakları için tasarlanmıştır. Bu sayede içerik sahipleri, her kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan bir kez kimlik doğrulaması yapabilir ve tüm video ve kanal verilerine erişebilir. Kullanıcının kimlik doğrulaması yaptığı gerçek İYS hesabı, belirtilen YouTube içerik sahibine bağlanmalıdır. |
İstek metni
Bu yöntemi çağırırken bir istek gövdesi sağlamayın.
Yanıt
Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt gövdesi döndürür:
{ "kind": "youtube#captionListResponse", "etag": etag, "items": [ caption Resource ] }
Özellikler
Aşağıdaki tabloda, bu kaynakta görünen özellikler tanımlanmaktadır:
Özellikler | |
---|---|
kind |
string API kaynağının türünü tanımlar. Değer youtube#captionListResponse olacak. |
etag |
etag Bu kaynağın Etag'i. |
items[] |
list İstek ölçütleriyle eşleşen altyazıların listesidir. |
Hatalar
Aşağıdaki tabloda, API'nin bu yönteme yapılan çağrıya yanıt olarak döndürebileceği hata mesajları tanımlanmaktadır. Daha fazla ayrıntı için lütfen hata mesajı dokümanlarını inceleyin.
Hata türü | Hata ayrıntısı | Açıklama |
---|---|---|
forbidden (403) |
forbidden |
İstekle ilgili izinler, istenen kaynakları almak için yeterli olmadığından bir veya daha fazla altyazı parçası alınamadı. İstek düzgün bir şekilde yetkilendirilmemiş olabilir. |
notFound (404) |
captionNotFound |
Belirtilen altyazı parçalarından biri veya daha fazlası bulunamadı. Bu hata, videoId parametresi gerçek bir videoyu tanımlarken id parametresi, var olmayan altyazı parçası kimliklerini veya diğer videolarla ilişkili parça kimliklerini tespit ederse ortaya çıkar. İsteğin id ve videoId parametrelerinin değerlerini kontrol ederek doğru olduklarından emin olun. |
notFound (404) |
videoNotFound |
videoId parametresiyle tanımlanan video bulunamadı. |
Deneyin.
Bu API'yi çağırmak ve API isteği ile yanıtını görmek için APIs Explorer özelliğini kullanın.