Captions: list

מחזירה רשימה של רצועות כתוביות המשויכות לסרטון שצוין. לתשומת ליבך, תגובת ה-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 השמות שניתן לכלול בערך הפרמטר:
  • id
  • snippet
videoId string
הפרמטר videoId מציין את מזהה סרטון YouTube שעבורו ה-API צריך להחזיר רצועות של כתוביות.
פרמטרים אופציונליים
id string
הפרמטר id מציין רשימה של מזהים המופרדים בפסיקים שמזהים את משאבי caption שצריך לאחזר. כל מזהה חייב לזהות טראק של כתוביות המשויך לסרטון שצוין.
onBehalfOfContentOwner string
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

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

גוף הבקשה

אין להזין גוף בקשה בעת הפעלת שיטה זו.

תשובה

אם התגובה מוצלחת, שיטה זו תחזיר גוף תגובה בעל המבנה הבא:

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

נכסים

הטבלה הבאה מגדירה את המאפיינים שמופיעים במשאב הזה:

נכסים
kind string
מזהה את סוג המשאב של ה-API. הערך יהיה youtube#captionListResponse.
etag etag
התג של המשאב הזה.
items[] list
רשימת כתוביות שתואמת לקריטריונים של הבקשה.

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) forbidden לא ניתן לאחזר טראק אחד או יותר של כתוביות, כי ההרשאות המשויכות לבקשה אינן מספיקות כדי לאחזר את המשאבים המבוקשים. יכול להיות שהבקשה לא אושרה כראוי.
notFound (404) captionNotFound לא נמצא אחד או יותר מרצועות הכתוביות שצוינו. השגיאה הזו מתרחשת אם הפרמטר videoId מזהה סרטון אמיתי, אבל הפרמטר id מזהה מזהים של רצועת כתוביות שאינם קיימים או מזהים של טראקים שמשויכים לסרטונים אחרים. עליך לבדוק את ערכי הפרמטרים id ו-videoId של הבקשה כדי לוודא שהם נכונים.
notFound (404) videoNotFound הסרטון שזוהה על ידי הפרמטר videoId לא נמצא.

רוצה לנסות?

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