ما در حال به‌روزرسانی Data API هستیم تا با نحوه شمارش بازدیدهای YouTube برای Shorts مطابقت داشته باشد.
بیشتر بدانید
پیاده سازی: زیرنویس ها
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
مثال‌های زیر نحوه استفاده از YouTube Data API (v3) را برای انجام عملکردهای مربوط به شرح‌ها نشان می‌دهند.
فهرستی از آهنگ‌های زیرنویس یک ویدیو را بازیابی کنید
یک تراک شرح ایجاد کنید
این پرس و جو را نمی توان با استفاده از APIs Explorer آزمایش کرد زیرا APIs Explorer از قابلیت آپلود فایل ها پشتیبانی نمی کند، که برای این روش الزامی است.
می‌توانید از روش captions.insert API برای آپلود یک تراک شرح جدید برای یک ویدیو استفاده کنید. هنگام آپلود یک آهنگ، باید مقداری را برای ویژگی های منبع caption زیر مشخص کنید:
هنگام آپلود یک تراک شرح، گزینه های اضافی زیر در دسترس هستند:
اگر پارامتر sync را روی true تنظیم کنید، YouTube کدهای زمانی را که در فایل زیرنویس آپلود شده است را نادیده می‌گیرد و کدهای زمانی جدیدی برای شرح‌ها ایجاد می‌کند.
اگر رونوشتی را آپلود می‌کنید که فاقد کد زمانی است، یا اگر مشکوک هستید که کدهای زمانی موجود در فایل شما نادرست است و می‌خواهید YouTube سعی کند آنها را برطرف کند، باید پارامتر sync را روی true تنظیم کنید.
اگر ویژگی 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 برای به‌روزرسانی مسیر زیرنویس واقعی استفاده کنید، زیرا ابزار توانایی آپلود فایل‌ها را پشتیبانی نمی‌کند.
درخواست زیر فهرستی از شرح‌ها را برای یک ویدیو در کانال Google Stories YouTube بازیابی می‌کند:
این درخواست وضعیت پیش‌نویس یک تراک شرح را به true به‌روزرسانی می‌کند، به این معنی که آهنگ برای عموم قابل مشاهده نخواهد بود. برای تکمیل درخواست در APIs Explorer، باید مقدار ویژگی id را برای شناسایی یک تراک عنوان تنظیم کنید.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet
برای نمونه کد به مستندات روش captions.update مراجعه کنید.
حذف یک تراک شرح
این مثال نحوه حذف یک تراک شرح را نشان می دهد. مثال دارای مراحل زیر است:
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2024-11-23 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2024-11-23 بهوقت ساعت هماهنگ جهانی."],[[["\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 ```"]]
