Captions: update

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

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

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

ההשפעה של המכסה: קריאה לשיטה הזו כוללת עלות מכסה של 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 עלול להחזיר בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במסמכים בנושא הודעת שגיאה.

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

רוצה לנסות?

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