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 altyazı parçası alma olanağı sağladığını unutmayın.
Kota etkisi: Bu yönteme yapılan bir çağrının 50 birim kota maliyeti olur.
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 biriyle yetkilendirme 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 parametrelerin tümü sorgu parametreleridir.
Parametreler | ||
---|---|---|
Gerekli parametreler | ||
part |
string part parametresi, API yanıtının içereceği caption kaynak parçalarını belirtir.Aşağıdaki listede parametre değerine ekleyebileceğiniz part adları bulunmaktadır:
|
|
videoId |
string videoId parametresi, API'nin altyazı parçaları 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şkilendirilmiş bir altyazı parçasını tanımlamalıdır. |
|
onBehalfOfContentOwner |
string Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortaklarına yöneliktir. onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube CMS kullanıcısını tanımladığını gösterir. Bu parametre, birçok farklı YouTube kanalına sahip olan ve bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır. İçerik sahiplerinin, her kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan bir kez kimlik doğrulaması yaparak tüm video ve kanal verilerine erişmelerine olanak tanır. Kullanıcının kimlik doğrulaması yaptığı gerçek CMS hesabı, belirtilen YouTube içerik sahibine bağlanmalıdır. |
İstek içeriği
Bu yöntemi çağırırken 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 olur. |
etag |
etag Bu kaynağın Etag'i. |
items[] |
list İstek ölçütlerine uyan altyazıların listesi. |
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 bilgi için lütfen hata mesajı dokümanlarına bakın.
Hata türü | Hata ayrıntısı | Açıklama |
---|---|---|
forbidden (403) |
forbidden |
İstekle ilişkili izinler istenen kaynakları almak için yeterli olmadığından bir veya daha fazla altyazı parçası alınamadı. İstek düzgün ş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ımlar ancak id parametresi var olmayan altyazı parçası kimliklerini veya diğer videolarla ilişkilendirilmiş parça kimliklerini tanımlarsa 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ğini ve yanıtını görmek için APIs Explorer kullanın.