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، ولا يمكن استخدامها إلا مع هذه المَعلمة. بالإضافة إلى ذلك، يجب أن يكون الطلب مصرّحًا به باستخدام حساب على "نظام إدارة المحتوى" (CMS) مرتبط بمالك المحتوى الذي تحدّده المَعلمة 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
تمثّل هذه السمة علامة 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 لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب واجهة برمجة التطبيقات والاستجابة.