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