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

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

גוף הבקשה

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

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

    • 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 לא נמצא.

רוצה לנסות?

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