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
علامة هذا المرجع.
items[] list
قائمة تضم مقاطع الترجمة والشرح التي تتطابق مع معايير الطلب

الأخطاء

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

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

تجربة

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