LiveBroadcasts: list

عرض قائمة بأحداث بث YouTube التي تتطابق مع معلَمات طلب واجهة برمجة التطبيقات

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

الطلب

طلب HTTP

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

التفويض

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

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

المعلمات

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

المعلمات
المَعلمات المطلوبة
part string
تحدّد المعلمة part قائمة مفصولة بفواصل لخاصية واحدة أو أكثر من سمات مورد liveBroadcast والتي ستتضمّنها استجابة واجهة برمجة التطبيقات. أسماء part التي يمكنك تضمينها في قيمة المَعلمة هي id وsnippet وcontentDetails وmonetizationDetails وstatus.
الفلاتر (حدد معلمة واحدة بالضبط من المعلمات التالية)
broadcastStatus string
تعمل المَعلمة broadcastStatus على فلترة استجابة واجهة برمجة التطبيقات لتضمين عمليات البث ذات الحالة المحدّدة فقط.

في ما يلي القيم المقبولة:
  • active – عرض أحداث البث المباشر الحالية
  • all – عرض جميع عمليات البث
  • completed – عرض مجموعات البث التي سبق وتم إنهاؤها
  • upcoming – عرض مجموعات البث التي لم تبدأ بعد
id string
تحدّد المعلمة id قائمة مفصولة بفواصل لمعرّفات بث YouTube التي تحدّد عمليات البث التي يتم استردادها. في مورد liveBroadcast، تحدّد السمة id معرّف البث.
mine boolean
يمكن استخدام المَعلمة mine لتوجيه واجهة برمجة التطبيقات بعرض رسائل البث التي يملكها المستخدم الذي تمت مصادقته فقط. اضبط قيمة المَعلمة على true لاسترداد عمليات البث الخاصة بك فقط.
المَعلمات الاختيارية
broadcastType string
تعمل المَعلمة broadcastType على فلترة استجابة واجهة برمجة التطبيقات لكي تتضمّن عمليات البث من النوع المحدّد فقط. ويجب استخدام المَعلمة في الطلبات التي تضبط المَعلمة mine على true أو التي تستخدم المَعلمة broadcastStatus. القيمة التلقائية هي event.

القيم المقبولة هي:
  • all – عرض جميع عمليات البث
  • event – عرض عمليات بث الأحداث المُجدوَلة فقط
  • persistent – عرض مجموعات البث الدائمة فقط
maxResults unsigned integer
تحدد المعلمة maxResults الحد الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج. تتراوح القيم المقبولة بين 0 و50 بشكل شامل. القيمة التلقائية هي 5.
onBehalfOfContentOwner string
لا يمكن استخدام هذه المَعلمة إلّا في طلب مفوَّض بشكل صحيح.
ملاحظة: هذه المعلمة مخصصة حصريًا لشركاء المحتوى في YouTube.

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

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

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

نص الطلب

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

الرد

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

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

أماكن إقامة

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

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

الأخطاء

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

نوع الخطأ تفاصيل الخطأ الوصف
insufficientPermissions insufficientLivePermissions غير مسموح للطلب باسترداد البث المباشر.
insufficientPermissions liveStreamingNotEnabled لم يتم تفعيل المستخدم الذي فوّض الطلب لبث فيديو مباشر على YouTube. لمزيد من المعلومات، يُرجى الاطّلاع على الأهلية لاستخدام الميزات.

جرّب الآن

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