Captions: update

עדכון של רצועת כתוביות. כשמעדכנים רצועת כתוביות, אפשר לשנות את סטטוס הטיוטה של הרצועה, להעלות קובץ כתוביות חדש לרצועה או לבצע את שתי הפעולות.

השיטה הזו תומכת בהעלאת מדיה. הקבצים שמעלים צריכים לעמוד במגבלות הבאות:

  • גודל קובץ מקסימלי: 100MB
  • סוגי MIME של מדיה שמתקבלים: text/xml, application/octet-stream, */*

השפעה על המכסה: קריאה ל-method הזה מנצלת 450 יחידות מהמכסה.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

PUT https://www.googleapis.com/upload/youtube/v3/captions

אישור

הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים שמופיעים ברשימה הם פרמטרים של שאילתה.

פרמטרים
פרמטרים נדרשים
part string
לפרמטר part יש שתי מטרות בפעולה הזו. הוא מזהה את המאפיינים שפעולת הכתיבה תגדיר, וגם את המאפיינים שתגובה מה-API תכלול. אם מעדכנים את סטטוס הטיוטה של המסלול, מגדירים את ערך המאפיין כ-snippet. אחרת, מגדירים את ערך המאפיין כ-id.

הרשימה הבאה מכילה את השמות של part שאפשר לכלול בערך הפרמטר:
  • id
  • snippet
פרמטרים אופציונליים
onBehalfOfContentOwner string
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית כראוי. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן ב-YouTube.

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

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

גוף הבקשה

מציינים משאב כתוביות בגוף הבקשה. למשאב הזה:

  • חובה לציין ערך למאפיינים האלה:

    • id

  • אפשר להגדיר ערכים למאפיינים הבאים:

    • snippet.isDraft

    אם אתם שולחים בקשת עדכון, ובבקשה לא מצוין ערך למאפיין שכבר יש לו ערך, הערך הקיים של המאפיין יימחק.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה משאב של כתוביות בגוף התגובה.

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) contentRequired הבקשה לא העלתה קובץ כתוביות מעודכן. אם הפרמטר sync מוגדר לערך true, צריך לציין את התוכן בפועל של רצועת האודיו.
forbidden (403) forbidden ההרשאות שמשויכות לבקשה לא מספיקות לעדכון של רצועת הכתוביות. יכול להיות שהבקשה לא מורשית כראוי.
notFound (404) captionNotFound לא נמצאה רצועת הכתוביות שצוינה. צריך לבדוק את הערך של המאפיין id בבקשה ולוודא שהוא נכון.

רוצה לנסות?

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