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