Captions: insert

מעלה רצועת כתוביות.

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

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

ההשפעה של המכסה: קריאה לשיטה הזו כוללת עלות מכסה של 400 יחידות.

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

בקשה

בקשת HTTP

POST 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 מציין את חלקי המשאבים של caption שייכללו בתגובת ה-API. מגדירים את ערך הפרמטר ל-snippet.

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

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

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

גוף הבקשה

צריך לספק משאב כתוביות בגוף הבקשה. במשאב הזה:

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

    • snippet.videoId
    • snippet.language
    • snippet.name

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

    • snippet.videoId
    • snippet.language
    • snippet.name
    • snippet.isDraft

תשובה

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) contentRequired הבקשה לא מכילה את התוכן של רצועת הכתוביות.
conflict (409) captionExists לסרטון שצוין כבר יש רצועת כתוביות עם snippet.language ו-snippet.name שצוינו. לסרטון יכולים להיות כמה טראקים באותה שפה, אבל לכל טראק צריך להיות שם שונה.

יש כמה דרכים לטפל בשגיאה. אפשר למחוק את הטראק הקיים ואז להוסיף טראק חדש או לשנות את השם של הטראק החדש לפני שמוסיפים אותו.
forbidden (403) forbidden ההרשאות המשויכות לבקשה לא מספיקות כדי להעלות את רצועת הכתוביות. יכול להיות שהבקשה לא מורשית כמו שצריך.
invalidValue (400) invalidMetadata הבקשה מכילה ערכי מטא-נתונים לא חוקיים, שמונעים את יצירת הטראק. צריך לוודא שהבקשה מציינת ערכים חוקיים למאפיינים snippet.language, snippet.name ו-snippet.videoId. אפשר לכלול גם את המאפיין snippet.isDraft, אבל זו לא חובה.
notFound (404) videoNotFound לא הצלחנו למצוא את הסרטון שזוהה באמצעות הפרמטר videoId.
invalidValue (400) nameTooLong השדה snippet.name שצוין בבקשה ארוך מדי. האורך המקסימלי הנתמך הוא 150 תווים.

רוצה לנסות?

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