LiveStreams: list

تعرض هذه الطريقة قائمة بفيديوهات البث التي تتطابق مع مَعلمات طلب البيانات من واجهة برمجة التطبيقات.

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

طلب

طلب HTTP

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

التفويض

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

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

المعلمات

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

المعلمات
المعلمات المطلوبة
part string
تحدّد المَعلمة part قائمة قيم مفصولة بفاصلة تتضمّن سمة واحدة أو أكثر من سمات مورد liveStream التي سيتضمّنها الردّ من واجهة برمجة التطبيقات. الأسماء part التي يمكنك تضمينها في قيمة المَعلمة هي id وsnippet وcdn وstatus.
الفلاتر (يجب تحديد مَعلمة واحدة فقط من المَعلمات التالية)
id string
تحدّد المَعلمة id قائمة قيم مفصولة بفاصلة تتضمّن معرّفات فيديوهات البث على YouTube التي تحدّد فيديوهات البث التي يتم استردادها. في مصدر liveStream، تحدّد السمة id معرّف فيديو البث.
mine boolean
لا يمكن استخدام هذه المَعلمة إلا في طلب مُفوَّض بشكلٍ صحيح. يمكن استخدام المَعلمة mine لتوجيه واجهة برمجة التطبيقات لعرض فيديوهات البث التي يملكها المستخدم الذي تمّت مصادقته فقط. اضبط قيمة المَعلمة على true لاسترداد فيديوهات البث الخاصة بك فقط.
المعلمات الاختيارية
maxResults unsigned integer
تحدّد المَعلمة maxResults الحد الأقصى لعدد النتائج التي يجب عرضها في مجموعة النتائج. القيم المقبولة هي من 0 إلى 50 ضِمنًا. القيمة التلقائية هي 5.
onBehalfOfContentOwner string
لا يمكن استخدام هذه المَعلمة إلا في طلب مُفوَّض بشكلٍ صحيح. ملاحظة: هذه المَعلمة مخصّصة حصريًا لشركاء المحتوى على YouTube.

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

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

هذه المَعلمة مخصّصة لشركاء المحتوى على YouTube الذين يملكون قنوات مختلفة على YouTube ويديرونها. تسمح هذه المَعلمة لمالكي المحتوى بالمصادقة مرة واحدة وتنفيذ الإجراءات نيابةً عن القناة المحدّدة في قيمة المَعلمة، بدون الحاجة إلى تقديم بيانات اعتماد المصادقة لكل قناة على حدة.
pageToken string
تحدّد المَعلمة pageToken صفحة معيّنة في مجموعة النتائج يجب عرضها. في الردّ من واجهة برمجة التطبيقات، تحدّد السمتان nextPageToken وprevPageToken صفحات أخرى يمكن استردادها.

نص الطلب

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

الردّ

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

{
  "kind": "youtube#liveStreamListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveStream Resource
  ]
}

الخصائص

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

الخصائص
kind string
يحدّد نوع مصدر واجهة برمجة التطبيقات. ستكون القيمة youtube#liveStreamListResponse.
etag etag
علامة Etag لهذا المصدر.
nextPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج.
prevPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة السابقة في مجموعة النتائج.
pageInfo object
يغلّف عنصر pageInfo معلومات تقسيم الصفحات لمجموعة النتائج.
pageInfo.totalResults integer
العدد الإجمالي للنتائج في مجموعة النتائج.
pageInfo.resultsPerPage integer
عدد النتائج المُدرَجة في الردّ من واجهة برمجة التطبيقات.
items[] list
قائمة بفيديوهات البث المباشر التي تتطابق مع معايير الطلب.

الأخطاء

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

نوع الخطأ تفاصيل الخطأ الوصف
insufficientPermissions insufficientLivePermissions الطلب غير مصرّح له باسترداد بث مباشر محدّد.
insufficientPermissions liveStreamingNotEnabled لم يتم تفعيل ميزة بث الفيديو المباشر على YouTube للمستخدم الذي فوّض الطلب. يمكن للمستخدم العثور على مزيد من المعلومات على https://www.youtube.com/features.

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

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