Captions: download

یک تراک شرح را دانلود می کند. تراک عنوان در قالب اصلی خود برگردانده می شود مگر اینکه درخواست مقداری برای پارامتر tfmt و به زبان اصلی خود مشخص کند مگر اینکه درخواست مقداری برای پارامتر tlang مشخص کند.

تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 200 واحدی دارد.

موارد استفاده رایج

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/captions/id

مجوز

این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).

محدوده
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

مولفه های

جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.

مولفه های
پارامترهای مورد نیاز
id string
پارامتر id تراک عنوانی را که در حال بازیابی است مشخص می کند. مقدار یک شناسه تراک عنوان است که توسط ویژگی id در یک منبع caption مشخص می شود.
پارامترهای اختیاری
onBehalfOfContentOwner string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است.

پارامتر onBehalfOfContentOwner نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند. این به صاحبان محتوا امکان می‌دهد یک بار احراز هویت کنند و به تمام داده‌های ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS واقعی که کاربر با آن احراز هویت می‌کند باید به مالک محتوای YouTube مشخص‌شده مرتبط باشد.
tfmt string
پارامتر tfmt مشخص می کند که تراک عنوان باید در قالب خاصی برگردانده شود. اگر پارامتر در درخواست گنجانده نشده باشد، آهنگ در قالب اصلی خود برگردانده می شود.

مقادیر پشتیبانی شده عبارتند از:
  • sbv – زیرنویس SubViewer
  • scc – فرمت شرح بسته Scenarist
  • srt – زیرنویس SubRip
  • ttml – عنوان زبان نشانه گذاری متن زمان بندی شده
  • vtt – عنوان آهنگ‌های متن ویدیوی وب
tlang string
پارامتر tlang مشخص می کند که پاسخ API باید ترجمه ای از تراک عنوان مشخص شده را برگرداند. مقدار پارامتر یک کد زبان دو حرفی ISO 639-1 است که زبان عنوان مورد نظر را مشخص می کند. ترجمه با استفاده از ترجمه ماشینی مانند Google Translate ایجاد می شود.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

واکنش

در صورت موفقیت آمیز بودن، این روش یک فایل باینری را برمی گرداند. هدر Content-Type برای پاسخ application/octet-stream است.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
forbidden (403) forbidden مجوزهای مرتبط با درخواست برای دانلود آهنگ شرح کافی نیست. ممکن است درخواست به درستی مجاز نباشد، یا ممکن است سفارش ویدیو مشارکت شخص ثالث را برای این شرح فعال نکرده باشد.
invalidValue (400) couldNotConvert داده‌های آهنگ شرح را نمی‌توان به زبان و/یا قالب درخواستی تبدیل کرد. اطمینان حاصل کنید که مقادیر tfmt و tlang درخواستی معتبر هستند و وضعیت snippet.status تراک عنوان درخواستی failed نیست.
notFound (404) captionNotFound تراک شرح یافت نشد. مقدار پارامتر id درخواست را بررسی کنید تا مطمئن شوید که درست است.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.