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 – כתוביות בפורמט Timed Text Markup Language
  • vtt – כתוביות בפורמט Web Video Text Tracks (כתוביות לסרטונים באינטרנט)
tlang string
הפרמטר tlang מציין שהתגובה מה-API צריכה להחזיר תרגום של רצועת הכתוביות שצוינה. ערך הפרמטר הוא קוד שפה בן שתי אותיות לפי תקן ISO 639-1 שמזהה את שפת הכתוביות הרצויה. התרגום נוצר באמצעות תרגום אוטומטי, כמו Google Translate.

גוף הבקשה

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

תשובה

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

שגיאות

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

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

רוצה לנסות?

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