אנחנו מעדכנים את Data API כך שיתאים לאופן שבו YouTube סופר צפיות ב-Shorts.
מידע נוסף
הטמעה: כתוביות
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדוגמאות הבאות מוסבר איך משתמשים ב-YouTube Data API (גרסה 3) כדי לבצע פונקציות שקשורות לכתוביות.
אחזור רשימה של רצועות של כתוביות לסרטון
יצירת רצועת כתוביות
לא ניתן לבדוק את השאילתה הזו באמצעות API Explorer כי ב-API Explorer אין תמיכה בהעלאת קבצים, וזו דרישה לשיטה הזו.
אפשר להשתמש בשיטה captions.insert של ה-API כדי להעלות טראק כתוביות חדש לסרטון. כשאתם מעלים טראק, אתם צריכים לציין ערך למאפייני המשאב הבאים של caption:
האפשרויות הנוספות הבאות זמינות כשאתם מעלים טראק של כתוביות:
-
אם תגדירו את הפרמטר sync לערך true, מערכת YouTube תתעלם מקודי זמן שנמצאים בקובץ הכתוביות שהועלו ותיצור קודי זמן חדשים לכתוביות.
צריך להגדיר את הפרמטר sync לערך true אם מעלים תמליל ללא קודי זמן, או אם יש חשד שהקודים האלה בקובץ שגויים ורוצים שמערכת YouTube תנסה לתקן אותם.
-
אם תגדירו את המאפיין snippet.isDraft של המשאב caption לערך true, הטראק לא יהיה גלוי לכולם.
דוגמאות קוד זמינות במסמכי העזרה של השיטה captions.insert.
הורדת רצועת כתוביות
לא ניתן לבדוק את השאילתה הזו באמצעות APIs Explorer כי ב-APIs Explorer אין תמיכה בהורדת קבצים.
כדי להוריד טראק כתוביות ספציפי, צריך לבצע קריאה ל-method captions.download. מגדירים את ערך הפרמטר id למזהה של רצועת הכתוביות ב-YouTube, שמזהה באופן ייחודי את רצועת הכתוביות שאתם מורידים. צריך לאשר את הבקשה באמצעות OAuth 2.0.
ה-API בגרסה 3 תומך באפשרויות הבאות:
-
כדי לציין שצריך להחזיר טראק של כתוביות בפורמט ספציפי, מגדירים את ערך הפרמטר tfmt כדי לזהות את הפורמט הרצוי. בהגדרת הפרמטר מפורטים הערכים הנתמכים.
-
כדי לאחזר תרגום של טראק כתוביות, מגדירים את ערך הפרמטר tlang לקוד שפה בן שתי אותיות לפי תקן ISO 639-1 שמזהה את שפת הכתוביות הרצויה. התרגום נוצר באמצעות תרגום מכונה, כמו Google Translate.
דוגמאות קוד זמינות במסמכי העזרה של השיטה captions.download.
עדכון של רצועת כתוביות
ה-API תומך באפשרות לשנות את סטטוס הטיוטה של רצועת כתוביות, להעלות רצועת כתוביות חדשה לקובץ או בשניהם.
אתם יכולים להשתמש ב-APIs Explorer כדי לבדוק את היכולת לשנות את סטטוס הטיוטה של טראק. עם זאת, אי אפשר להשתמש ב-API Explorer כדי לעדכן את הטראק של הכתוביות בפועל, כי הכלי לא תומך בהעלאת קבצים.
הבקשה הבאה מאחזרת רשימה של כתוביות לסרטון בערוץ YouTube של Google Stories:
הבקשה מעדכנת את סטטוס הטיוטה של טראק הכתוביות ל-true, כלומר הטראק לא יהיה גלוי לכולם. כדי להשלים את הבקשה ב-API Explorer, צריך להגדיר את הערך של המאפיין id כדי לזהות טראק של כתוביות.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet
דוגמאות קוד זמינות במסמכי העזרה של השיטה captions.update.
מחיקת רצועת כתוביות
בדוגמה הזו מוסבר איך למחוק טראק של כתוביות. הדוגמה כוללת את השלבים הבאים:
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-11-23 (שעון UTC).
[null,null,["עדכון אחרון: 2024-11-23 (שעון UTC)."],[[["\u003cp\u003eThis document provides instructions on how to use the YouTube Data API (v3) to manage video captions.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve a list of caption tracks for a specific video using the \u003ccode\u003ecaptions.list\u003c/code\u003e method, requiring OAuth 2.0 authorization.\u003c/p\u003e\n"],["\u003cp\u003eUploading a new caption track to a video is achieved using the \u003ccode\u003ecaptions.insert\u003c/code\u003e method, requiring the \u003ccode\u003esnippet.videoId\u003c/code\u003e, \u003ccode\u003esnippet.language\u003c/code\u003e, and \u003ccode\u003esnippet.name\u003c/code\u003e properties to be set.\u003c/p\u003e\n"],["\u003cp\u003eDownloading a specific caption track is possible via the \u003ccode\u003ecaptions.download\u003c/code\u003e method, including options to specify the desired format and retrieve a translated version.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows for updating a caption track's draft status and even deleting it completely using the \u003ccode\u003ecaptions.update\u003c/code\u003e and \u003ccode\u003ecaptions.delete\u003c/code\u003e methods respectively.\u003c/p\u003e\n"]]],["The YouTube Data API (v3) facilitates caption management. Key actions include: retrieving caption track lists for a video via `captions.list`; creating new tracks with `captions.insert`, specifying video ID, language, and name; downloading tracks with `captions.download`, allowing format and language selection; updating track status or file with `captions.update`; and deleting tracks using `captions.delete` after retrieving the track ID. Uploading caption files cannot be tested in the APIs Explorer.\n"],null,["# Implementation: Captions\n\nThe following examples show how to use the YouTube Data API (v3) to perform functions related to captions.\n\nRetrieve a list of caption tracks for a video\n---------------------------------------------\n\nTo retrieve a list of caption tracks that are available for a specific video, call the [captions.list](/youtube/v3/docs/captions/list) method. Set the [videoId](/youtube/v3/docs/captions/list#videoId) parameter value to the YouTube video ID that uniquely identifies the video for which you are retrieving captions. Your request must be authorized using OAuth 2.0.\n\nThe request below retrieves a list of captions for a video on the Google Stories YouTube channel: \n\n```\nhttps://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?\npart=snippet\n&videoId=PRU2ShMzQRg\n```\n\nSee the [captions.list](/youtube/v3/docs/captions/list#usage) method's documentation for code samples.\n\nCreate a caption track\n----------------------\n\nThis query cannot be tested using the APIs Explorer because the APIs Explorer does not support the ability to upload files, which is a requirement for this method.\n\nYou can use the API's [captions.insert](/youtube/v3/docs/captions/insert) method to upload a new caption track for a video. When uploading a track, you must specify a value for the following `caption` resource properties:\n\n\u003cbr /\u003e\n\n- [snippet.videoId](/youtube/v3/docs/captions#snippet.videoId) - This identifies the video to which the caption track is being added.\n- [snippet.language](/youtube/v3/docs/captions#snippet.language) - The language of the caption track.\n- [snippet.name](/youtube/v3/docs/captions#snippet.name) - The name of the caption track.\n\n\u003cbr /\u003e\n\nThe following additional options are available when uploading a caption track:\n\n- If you set the [sync](/youtube/v3/docs/captions/insert#sync) parameter to `true`, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions.\n\n You should set the [sync](/youtube/v3/docs/captions/insert#sync) parameter to `true` if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.\n- If you set the `caption` resource's [snippet.isDraft](/youtube/v3/docs/captions#snippet.isDraft) property to `true`, the track will not be publicly visible.\n\nSee the [captions.insert](/youtube/v3/docs/captions/insert#examples) method's documentation for code samples.\n\nDownload a caption track\n------------------------\n\nThis query cannot be tested using the APIs Explorer because the APIs Explorer does not support the ability to download files.\n\nTo download a specific caption track, call the [captions.download](/youtube/v3/docs/captions/download) method. Set the [id](/youtube/v3/docs/captions/download#id) parameter value to the YouTube caption track ID that uniquely identifies the caption track that you are downloading. Your request must be authorized using OAuth 2.0.\n\nThe v3 API supports the following options:\n\n- To specify that a caption track should be returned in a specific format, set the [tfmt](/youtube/v3/docs/captions/download#tfmt) parameter value to identify the desired format. The parameter definition lists supported values.\n\n- To retrieve a translation of a caption track, set the [tlang](/youtube/v3/docs/captions/download#tlang) parameter value to an [ISO 639-1 two-letter language code](http://www.loc.gov/standards/iso639-2/php/code_list.php) that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.\n\nSee the [captions.download](/youtube/v3/docs/captions/download#examples) method's documentation for code samples.\n\nUpdate a caption track\n----------------------\n\nThe API supports the ability to change a caption track's [draft status](/youtube/v3/docs/captions#snippet.isDraft), upload a new caption track for a file, or both.\n\nYou can use the APIs Explorer to test the ability to change a track's draft status. However, you cannot use the APIs Explorer to update the actual caption track because tool does not support the ability to upload files.\n\nThe request below retrieves a list of captions for a video on the Google Stories YouTube channel:\n\nThe request updates the draft status of a caption track to `true`, which means the track will not be publicly visible. To complete the request in the APIs Explorer, you need to set the `id` property's value to identify a caption track. \n\n```\nhttps://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?\npart=snippet\n```\n\nSee the [captions.update](/youtube/v3/docs/captions/update#usage) method's documentation for code samples.\n\nDelete a caption track\n----------------------\n\nThis example shows how to delete a caption track. The example has the following steps:\n\n- **Step 1: Retrieve the caption track ID**\n\n Follow the steps above to [retrieve a list of caption tracks](#captions-list) for a video. The list could be used to display a list of caption tracks, using each track's ID as a key.\n- **Step 2: Delete the track**\n\n Call the [captions.delete](/youtube/v3/docs/captions/delete) method to delete a specific video. In the request, the `id` parameter specifies the caption track ID of the track that you are deleting. The request must be authorized using OAuth 2.0. If you are testing this query in the APIs Explorer, you will need to substitute a valid caption track ID for the `id` parameter value. \n\n ```\n https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?\n id=CAPTION_TRACK_ID\n ```"]]
