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

הערכים הנתמכים הם:
  • sbv – כותרת משנה של צפייה משנית
  • scc – פורמט הכתוביות של התרחיש סגור
  • srt – כותרת משנה לכתוביות
  • 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 ואת התשובה.