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 CMS الذي يتصرف نيابةً عن مالك المحتوى المحدد في قيمة المعلمة. هذه المعلمة مخصصة لشركاء محتوى YouTube الذين يملكون ويديرون العديد من قنوات YouTube المختلفة. تتيح هذه الميزة لمالكي المحتوى المصادقة مرة واحدة والوصول إلى كل بيانات الفيديو والقناة بدون الحاجة إلى تقديم بيانات اعتماد المصادقة لكل قناة على حدة. يجب ربط حساب CMS الفعلي الذي يصادق المستخدم معه بمالك محتوى 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 لاستدعاء واجهة برمجة التطبيقات هذه والاطّلاع على طلب واجهة برمجة التطبيقات والاستجابة له.