Captions: download

הורדה של רצועת כתוביות. רצועת הכתוביות מוחזרת בפורמט המקורי שלה, אלא אם הבקשה מציינת ערך לפרמטר tfmt ובשפה המקורית שלו, אלא אם הבקשה מציינת ערך לפרמטר tlang.

ההשפעה של המכסה: קריאה לשיטה הזו כוללת עלות מכסה של 200 יחידות.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

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

אישור

בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.

פרמטרים
הפרמטרים הנדרשים
id string
הפרמטר id מזהה את רצועת הכתוביות שמאוחזרת. הערך הוא מזהה רצועת כתוביות, כפי שמזוהה על ידי המאפיין id במשאב caption.
פרמטרים אופציונליים
onBehalfOfContentOwner string
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה של ההרשאה של הבקשה מזהים משתמש YouTube CMS שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שהם הבעלים והמנהלים של ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון ה-CMS בפועל שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube.
tfmt string
הפרמטר tfmt מציין שצריך להחזיר את הטראק של כתוביות בפורמט ספציפי. אם הפרמטר לא נכלל בבקשה, הטראק מוחזר בפורמט המקורי שלו.

הערכים הנתמכים הם:
  • sbv – כותרת משנה של SubViewer
  • scc – פורמט כתוביות של Scenarist
  • srt – כותרת משנה של SubRip
  • ttml – כיתוב מתוזמן של שפת סימון טקסט
  • vtt – כיתוב של טראקים של טקסט בווידאו באינטרנט
tlang string
הפרמטר tlang מציין שתגובת ה-API צריכה להחזיר תרגום של רצועת הכתוביות שצוינה. ערך הפרמטר הוא קוד שפה בן שתי אותיות לפי תקן ISO 639-1 שמזהה את שפת הכתוביות הרצויה. התרגום נוצר באמצעות תרגום אוטומטי, כמו Google Translate.

גוף הבקשה

אין לציין את גוף הבקשה בקריאה לשיטה הזו.

תשובה

אם הפעולה מצליחה, השיטה מחזירה קובץ בינארי. הכותרת Content-Type של התשובה היא application/octet-stream.

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שה-API עלול להחזיר בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במסמכים בנושא הודעת שגיאה.

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) forbidden ההרשאות המשויכות לבקשה לא מספיקות כדי להוריד את רצועת הכתוביות. יכול להיות שהבקשה לא אושרה כמו שצריך, או שהזמנת הסרטון לא אפשרה להוסיף תוכן על ידי צד שלישי לכתוביות.
invalidValue (400) couldNotConvert לא ניתן להמיר את הנתונים של רצועת הכתוביות לשפה ו/או לפורמט המבוקשים. יש לוודא שהערכים המבוקשים tfmt ו-tlang חוקיים, ושה-snippet.status של רצועת הכתוביות המבוקשת אינו failed.
notFound (404) captionNotFound לא ניתן למצוא את רצועת הכתוביות. צריך לבדוק את ערך הפרמטר id של הבקשה כדי לוודא שהוא נכון.

רוצה לנסות?

משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.