מחזירה רשימה של רצועות כתוביות המשויכות לסרטון ספציפי. חשוב לשים לב שתגובת ה-API לא מכילה את הכתוביות עצמן, ושהשיטה captions.download
מאפשרת לאחזר רצועת כתוביות.
ההשפעה של המכסה: קריאה לשיטה הזו כוללת עלות מכסה של 50 יחידות.
תרחישים נפוצים לדוגמה
בקשה
בקשת HTTP
GET https://www.googleapis.com/youtube/v3/captions
אישור
בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
היקף |
---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.
פרמטרים | ||
---|---|---|
הפרמטרים הנדרשים | ||
part |
string הפרמטר part מציין את חלקי המשאבים caption שייכללו בתגובת ה-API.הרשימה שבהמשך כוללת את שמות part שאפשר לכלול בערך הפרמטר:
|
|
videoId |
string הפרמטר videoId מציין את מזהה הווידאו של הסרטון ב-YouTube, שעבורו ה-API אמור להחזיר טראקים של כתוביות. |
|
פרמטרים אופציונליים | ||
id |
string הפרמטר id מציין רשימת מזהים מופרדים בפסיקים שמזהים את המשאבים של caption שצריך לאחזר. כל מזהה חייב לזהות רצועת כתוביות המשויכת לסרטון שצוין. |
|
onBehalfOfContentOwner |
string ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה של ההרשאה של הבקשה מזהים משתמש YouTube CMS שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שהם הבעלים והמנהלים של ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון ה-CMS בפועל שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
גוף הבקשה
אין לציין את גוף הבקשה בקריאה לשיטה הזו.
תשובה
אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:
{ "kind": "youtube#captionListResponse", "etag": etag, "items": [ caption Resource ] }
תכונות
הטבלה הבאה מגדירה את המאפיינים שיופיעו במשאב הזה:
תכונות | |
---|---|
kind |
string מזהה את הסוג של משאב ה-API. הערך יהיה youtube#captionListResponse . |
etag |
etag ה-e של המשאב הזה. |
items[] |
list רשימת כתוביות שתואמות לקריטריונים של הבקשה. |
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שה-API עלול להחזיר בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במסמכים בנושא הודעת שגיאה.
סוג השגיאה | פרטי השגיאה | תיאור |
---|---|---|
forbidden (403) |
forbidden |
לא ניתן לאחזר את רצועת הכתוביות אחת או יותר, מפני שההרשאות המשויכות לבקשה לא מספיקות כדי לאחזר את המשאבים המבוקשים. יכול להיות שהבקשה לא מורשית כמו שצריך. |
notFound (404) |
captionNotFound |
לא ניתן היה למצוא אחת או יותר מרצועות הכתוביות שצוינו. השגיאה הזו מתקבלת אם הפרמטר videoId מזהה סרטון אמיתי, אבל הפרמטר id מזהה מזהים של רצועות כתוביות שלא קיימים או מזהי טראקים שמשויכים לסרטונים אחרים. צריך לבדוק את ערכי הפרמטרים id ו-videoId של הבקשה כדי לוודא שהם נכונים. |
notFound (404) |
videoNotFound |
לא הצלחנו למצוא את הסרטון שזוהה באמצעות הפרמטר videoId . |
רוצה לנסות?
משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.