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

גוף הבקשה

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

תשובה

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

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

מאפיינים

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

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

שגיאות

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

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

רוצה לנסות?

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