Captions: list

تعرض هذه الطريقة قائمة بمسارات الترجمة والشرح المرتبطة بفيديو معيّن. يُرجى العِلم أنّ استجابة واجهة برمجة التطبيقات لا تحتوي على الترجمة والشرح الفعليين، وأنّ الطريقة captions.download تتيح إمكانية استرداد مسار الترجمة والشرح.

التأثير في الحصة: يتطلّب طلب هذه الطريقة تكلفة حصة تبلغ 50 وحدة.

حالات الاستخدام الشائعة

طلب

طلب HTTP

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

التفويض

يتطلّب هذا الطلب الحصول على إذن باستخدام نطاق واحد على الأقل من النطاقات التالية (مزيد من المعلومات حول المصادقة ومنح الإذن).

النطاق
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

المعلمات

يعرض الجدول التالي المَعلمات التي يتيحها هذا الطلب. جميع المَعلمات المدرَجة هي مَعلمات طلب البحث.

المعلمات
المَعلمات المطلوبة
part string
تحدّد المَعلمة part أجزاء المورد caption التي سيتضمّنها ردّ من واجهة برمجة التطبيقات.

تتضمّن القائمة أدناه أسماء part التي يمكنك تضمينها في قيمة المَعلمة:
  • id
  • snippet
videoId string
تحدّد المَعلمة videoId معرّف الفيديو على YouTube الذي يجب أن تعرض واجهة برمجة التطبيقات مسارات الترجمة والشرح له.
المَعلمات الاختيارية
id string
تحدّد المَعلمة id قائمة بأرقام التعريف مفصولة بفواصل، وتحدّد هذه الأرقام موارد caption التي يجب استردادها. يجب أن يحدّد كل معرّف مسار ترجمة وشرح مرتبطًا بالفيديو المحدّد.
onBehalfOfContentOwner string
لا يمكن استخدام هذه المَعلمة إلا في طلب مصرَّح به بشكل صحيح. ملاحظة: هذه المَعلمة مخصّصة حصريًا لشركاء المحتوى في YouTube.

تشير المَعلمة onBehalfOfContentOwner إلى أنّ بيانات اعتماد التفويض للطلب تحدّد مستخدمًا في نظام إدارة محتوى YouTube يعمل بالنيابة عن مالك المحتوى المحدّد في قيمة المَعلمة. هذه المَعلمة مخصّصة لشركاء المحتوى على YouTube الذين يملكون ويديرون العديد من القنوات المختلفة على YouTube. تتيح هذه الميزة لمالكي المحتوى المصادقة مرة واحدة والوصول إلى جميع بيانات الفيديوهات والقنوات، بدون الحاجة إلى تقديم بيانات اعتماد المصادقة لكل قناة على حدة. يجب ربط حساب "نظام إدارة المحتوى" الفعلي الذي يصادق عليه المستخدم بمالك المحتوى المحدّد على YouTube.

نص الطلب

لا تقدِّم نص الطلب عند استدعاء هذه الطريقة.

الردّ

في حال نجاح هذه الطريقة، ستعرض نص استجابة بالبنية التالية:

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

الخصائص

يحدّد الجدول التالي السمات التي تظهر في هذا المورد:

الخصائص
kind string
تحدّد هذه السمة نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#captionListResponse.
etag etag
تمثّل هذه السمة علامة Etag الخاصة بهذا المرجع.
items[] list
قائمة بالترجمات التي تتطابق مع معايير الطلب.

الأخطاء

يحدّد الجدول التالي رسائل الخطأ التي يمكن أن تعرضها واجهة برمجة التطبيقات استجابةً لطلب هذه الطريقة. يُرجى الاطّلاع على مستندات رسالة الخطأ لمزيد من التفاصيل.

نوع الخطأ تفاصيل الخطأ الوصف
forbidden (403) forbidden تعذّر استرداد مسار واحد أو أكثر من مسارات الترجمة والشرح لأنّ الأذونات المرتبطة بالطلب غير كافية لاسترداد الموارد المطلوبة. قد لا يكون الطلب مُصرّحًا به بشكلٍ صحيح.
notFound (404) captionNotFound تعذّر العثور على مسار واحد أو أكثر من مسارات الترجمة المحدّدة. يظهر هذا الخطأ إذا كانت المَعلمة videoId تحدّد فيديو فعليًا، ولكنّ المَعلمة id تحدّد معرّفات مسارات ترجمة غير موجودة أو معرّفات مسارات مرتبطة بفيديوهات أخرى. تحقَّق من قيم المَعلمتَين id وvideoId للطلب للتأكّد من صحتها.
notFound (404) videoNotFound تعذّر العثور على الفيديو الذي تم تحديده من خلال المَعلمة videoId.

جرِّبها الآن.

استخدِم APIs Explorer لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات من واجهة برمجة التطبيقات والاستجابة.