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" الذي يتصرّف نيابةً عن مالك المحتوى المحدَّد في قيمة المَعلمة. هذه المعلمة مخصصة لشركاء المحتوى في YouTube الذين يملكون العديد من القنوات المختلفة على YouTube ويديرونها. يسمح هذا البرنامج لمالكي المحتوى بالمصادقة مرة واحدة والوصول إلى جميع بيانات القنوات والفيديوهات الخاصة بهم، بدون الحاجة إلى تقديم بيانات اعتماد مصادقة لكل قناة على حدة. يجب أن يكون حساب نظام إدارة المحتوى الفعلي الذي يجري المستخدم عملية المصادقة عليه مرتبطًا بمالك المحتوى المحدّد على YouTube.
tfmt string
تحدّد المعلَمة tfmt أنّه يجب عرض مسار الترجمة بتنسيق معيّن. إذا لم يتم تضمين المَعلمة في الطلب، يتم عرض المقطع الصوتي بتنسيقه الأصلي.

القيم المسموح بها هي:
  • sbv – الترجمة الفرعية في SubViewer
  • scc – تنسيق Scenarist Closed Caption
  • srt – الترجمة الفرعية SubRip
  • ttml – شرح بلغة ترميز النص في وقت محدد
  • vtt – شرح المقاطع النصية للفيديوهات على الويب
tlang string
تحدّد المعلَمة tlang أنّه يجب أن تعرض استجابة واجهة برمجة التطبيقات ترجمةً لمسار الترجمة والشرح المحدَّد. تكون قيمة المعلَمة رمز لغة مؤلفًا من حرفَين وفقًا لمعيار 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 لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات من واجهة برمجة التطبيقات والاستجابة لها.