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

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

גוף הבקשה

אין לספק גוף בקשה בקריאה ל-method הזה.

תשובות

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

שגיאות

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

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

נסה בעצמך!

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