پیاده سازی: زیرنویس ها

مثال‌های زیر نحوه استفاده از YouTube Data API (v3) را برای انجام عملکردهای مربوط به شرح‌ها نشان می‌دهند.

فهرستی از آهنگ‌های زیرنویس یک ویدیو را بازیابی کنید

برای بازیابی لیستی از تراک‌های شرح که برای یک ویدیوی خاص در دسترس هستند، با روش captions.list تماس بگیرید. مقدار پارامتر videoId را روی شناسه ویدیوی YouTube تنظیم کنید که به طور منحصربه‌فرد ویدیویی را که برای آن زیرنویس‌ها را بازیابی می‌کنید، مشخص می‌کند. درخواست شما باید با استفاده از OAuth 2.0 مجاز باشد.

درخواست زیر فهرستی از شرح‌ها را برای یک ویدیو در کانال Google Stories YouTube بازیابی می‌کند:

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 زیر مشخص کنید:

هنگام آپلود یک تراک شرح، گزینه های اضافی زیر در دسترس هستند:

  • اگر پارامتر 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 مراجعه کنید.

حذف یک تراک شرح

این مثال نحوه حذف یک تراک شرح را نشان می دهد. مثال دارای مراحل زیر است:

  • مرحله 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