הטמעה: כתוביות

הדוגמאות הבאות מראות איך להשתמש ב-YouTube Data API (v3) כדי לבצע פונקציות שקשורות לכתוביות.

אחזור רשימה של רצועות כתוביות לסרטון

כדי לאחזר רשימה של טראקים של כתוביות שזמינים לסרטון ספציפי, צריך להפעיל את השיטה captions.list. מגדירים את ערך הפרמטר videoId למזהה הסרטון ב-YouTube שמזהה באופן ייחודי את הסרטון שעבורו אתם מאחזרים כתוביות. יש לאשר את הבקשה שלך באמצעות OAuth 2.0.

הבקשה הבאה מאחזרת רשימת כתוביות לסרטון בערוץ YouTube של Google סטוריז:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?
part=snippet
&videoId=PRU2ShMzQRg

לעיון בדוגמאות של הקוד עבור captions.list.

יצירת טראק של כתוביות

לא ניתן לבדוק את השאילתה הזו באמצעות APIs Explorer, מכיוון ש-APIs Explorer לא תומך בהעלאת קבצים. זוהי דרישה הנדרשת לשיטה זו.

ניתן להשתמש בשיטת captions.insert של ה-API כדי להעלות טראק חדש של כתוביות לסרטון. כשמעלים טראק, צריך לציין ערך במאפייני המשאבים הבאים של caption:

  • snippet.videoId – מזהה את הסרטון שאליו מתווסף רצועת הכתוביות.
  • snippet.language – השפה של טראק הכתוביות.
  • snippet.name – השם של רצועת הכתוביות.

האפשרויות הנוספות הבאות זמינות בעת העלאת רצועת כתוביות:

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

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

  • אם תגדיר את נכס ה-snippet.isDraft של המשאב caption כ-true, המסלול לא יהיה גלוי לציבור.

לעיון בדוגמאות של הקוד עבור captions.insert.

הורדת טראק של כתוביות

לא ניתן לבדוק את השאילתה הזו באמצעות APIs Explorer, מכיוון ש-APIs Explorer לא תומך באפשרות להוריד קבצים.

כדי להוריד טראק ספציפי של כתוביות, צריך לקרוא לשיטה captions.download. מגדירים את ערך הפרמטר id למזהה של טראק הכתוביות ב-YouTube שמזהה באופן ייחודי את רצועת הכתוביות שהורדתם. יש לאשר את הבקשה שלך באמצעות OAuth 2.0.

ה-v3 API תומך באפשרויות הבאות:

  • כדי לציין שיש להחזיר רצועת כתוביות בפורמט ספציפי, הגדר את ערך הפרמטר tfmt כדי לזהות את הפורמט הרצוי. הגדרת הפרמטר מציינת ערכים נתמכים.

  • כדי לאחזר תרגום של רצועת כתוביות, מגדירים את ערך הפרמטר tlang כקוד שפה בן שתי אותיות על פי תקן ISO 639-1, אשר מזהה את שפת הכתוביות הרצויה. התרגום נוצר באמצעות תרגום מכונה, כגון Google Translate.

לעיון בדוגמאות של הקוד עבור captions.download.

עדכון טראק של כתוביות

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

ניתן להשתמש ב-APIs Explorer כדי לבדוק את היכולת לשנות את סטטוס הטיוטה של מסלול. עם זאת, לא ניתן להשתמש ב-APIs Explorer כדי לעדכן את רצועת הכתוביות עצמה, מפני שהכלי אינו תומך ביכולת להעלות קבצים.

הבקשה הבאה מאחזרת רשימת כתוביות לסרטון בערוץ YouTube של Google סטוריז:

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

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet

לעיון בדוגמאות של הקוד עבור captions.update.

מחיקת טראק של כתוביות

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

  • שלב 1: אחזור המזהה של רצועת הכתוביות

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

  • שלב 2: מחיקת הטראק

    צריך להתקשר לשיטה captions.delete כדי למחוק סרטון ספציפי. בבקשה, הפרמטר id מציין את מזהה רצועת הכתוביות שברצונך למחוק. יש לאשר את הבקשה באמצעות OAuth 2.0. אם בודקים את השאילתה הזו ב-APIs Explorer, צריך להחליף את המזהה החוקי של רצועת הכתוביות בערך הפרמטר id.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?
id=CAPTION_TRACK_ID