Captions: download

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

تأثیر سهمیه: فراخوانی این روش هزینه سهمیه ۲۰۰ واحدی دارد.

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

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

درخواست

درخواست 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» را که ازطرف مالک محتوای مشخص‌شده در مقدار پارامتر عمل می‌کند شناسایی می‌کند. این پارامتر برای شرکای محتوای YouTube است که مالک و مدیر کانال‌های مختلف YouTube هستند. این ویژگی به مالکان محتوا امکان می‌دهد یک‌بار اصالت‌سنجی کنند و به تمام داده‌های ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال جداگانه اطلاعات اصالت‌سنجی ارائه دهند. حساب واقعی «سیستم مدیریت محتوا» که کاربر با آن اصالت‌سنجی می‌کند باید به مالک محتوای YouTube مشخص‌شده پیوند داده شود.
tfmt string
پارامتر tfmt مشخص می‌کند که قطعه زیرنویس ناشنوایان باید در قالب خاصی برگردانده شود. اگر پارامتر در درخواست گنجانده نشده باشد، قطعه در قالب اصلی خود برگردانده می‌شود.

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

متن درخواست

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

پاسخ

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

خطاها

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

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

امتحان کنید!

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