LiveBroadcasts: control

ملاحظة: تم إيقاف الطريقة liveBroadcasts.control نهائيًا وستتوقّف عن العمل في 1 تشرين الأول (أكتوبر) 2020 أو بعد هذا التاريخ. وبعد ذلك التاريخ، ستعرض جميع الطلبات التي يتم إجراؤها على هذه الطريقة رمز الخطأ (403) محظورًا، وستتم إزالة الطريقة بالكامل لاحقًا.

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

تتيح لك هذه السياسة التحكم في إعدادات العنصر الحاجب الذي يمكن عرضه في بث البث.

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

الطلب

طلب HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

التفويض

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

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

المَعلمات

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

المَعلمات
المَعلمات المطلوبة
id	string تحدّد المعلَمة id معرّف البث المباشر على YouTube الذي يعرّف بشكل فريد البث الذي يتم فيه تعديل العنصر الحاجب.
part	string تحدّد المعلَمة part قائمة مفصولة بفواصل تتضمّن سمة واحدة أو أكثر من سمات موارد liveBroadcast التي ستشملها استجابة واجهة برمجة التطبيقات. أسماء part التي يمكنك تضمينها في قيمة المَعلمة هي id وsnippet وcontentDetails وstatus.
المَعلمات الاختيارية
displaySlate	boolean تحدّد المعلَمة displaySlate ما إذا كان يتم تفعيل العنصر الحاجب أو إيقافه.
offsetTimeMs	unsigned long تحدّد المعلَمة offsetTimeMs معادلة زمنية إيجابية عند حدوث تغيير العنصر الحاجب المحدّد. وتُقاس القيمة بالمللي ثانية من بداية بث شاشة البث، وهو الوقت الذي بدأت فيه مرحلة اختبار البث. على الرغم من تحديدها بالملي ثانية، فإنّها في الواقع تقريبية، ويُكمل YouTube الإجراء المطلوب في أقرب وقت ممكن. إذا لم تحدّد قيمة لهذه المَعلمة، سينفّذ YouTube الإجراء في أقرب وقت ممكن. لمزيد من التفاصيل، يمكنك الاطّلاع على دليل البدء. ملاحظة مُهمة: يجب تحديد قيمة لهذه المَعلمة فقط في حال تأخّر البث.
onBehalfOfContentOwner	string لا يمكن استخدام هذه المَعلمة إلا في طلب معتمد بشكل صحيح. ملاحظة: هذه المَعلمة مخصّصة حصريًا لشركاء المحتوى في YouTube. تشير المَعلمة onBehalfOfContentOwner إلى أنّ بيانات اعتماد التفويض الخاصة بالطلب تحدِّد مستخدم نظام "إدارة محتوى YouTube" الذي يتصرّف نيابةً عن مالك المحتوى المحدَّد في قيمة المَعلمة. هذه المعلمة مخصصة لشركاء المحتوى في YouTube الذين يملكون العديد من القنوات المختلفة على YouTube ويديرونها. يسمح هذا البرنامج لمالكي المحتوى بالمصادقة مرة واحدة والوصول إلى جميع بيانات القنوات والفيديوهات الخاصة بهم، بدون الحاجة إلى تقديم بيانات اعتماد مصادقة لكل قناة على حدة. يجب أن يكون حساب نظام إدارة المحتوى الذي يصادقه المستخدم مرتبطًا بمالك المحتوى المحدد على YouTube.
onBehalfOfContentOwnerChannel	string لا يمكن استخدام هذه المَعلمة إلا في طلب معتمد بشكل صحيح. لا يمكن استخدام هذه المَعلمة إلا في طلب معتمد بشكل صحيح. ملاحظة: هذه المَعلمة مخصّصة حصريًا لشركاء المحتوى في YouTube. تحدّد المَعلمة onBehalfOfContentOwnerChannel معرّف قناة YouTube للقناة التي تتم إضافة فيديو إليها. هذه المعلَمة مطلوبة عندما يحدِّد الطلب قيمةً للمعلَمة onBehalfOfContentOwner، ولا يمكن استخدامها إلا مع تلك المعلَمة. بالإضافة إلى ذلك، يجب أن يكون الطلب مصرّحًا به باستخدام حساب "نظام إدارة المحتوى" (CMS) المرتبط بمالك المحتوى الذي تحدّده المَعلمة onBehalfOfContentOwner. أخيرًا، يجب أن تكون القناة التي تحددها قيمة المعلَمة onBehalfOfContentOwnerChannel مرتبطة بمالك المحتوى الذي تحدّده المَعلمة onBehalfOfContentOwner. هذه المَعلمة مخصّصة لشركاء المحتوى في YouTube الذين يملكون العديد من قنوات YouTube المختلفة ويديرونها. وهي تتيح لمالكي المحتوى إجراء المصادقة مرة واحدة وتنفيذ إجراءات بالنيابة عن القناة المحددة في قيمة المعلَمة، بدون الحاجة إلى تقديم بيانات اعتماد مصادقة لكل قناة منفصلة.
walltime	datetime تحدّد المعلَمة walltime وقت ساعة الحائط الذي سيحدث عنده تغيير العنصر الحاجب المحدد. ويتم تحديد القيمة بتنسيق ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

نص الطلب

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

الإجابة

في حال نجاحها، تعرض هذه الطريقة مورد بث مباشر في نص الاستجابة.

الأخطاء

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

نوع الخطأ	تفاصيل الخطأ	الوصف
backendError	errorDisplaySlate	حدث خطأ أثناء تنفيذ الإجراء المطلوب.
forbidden (403)	liveBroadcastControlNotAllowed	لا يُسمح باتخاذ الإجراء المطلوب إلا إذا كانت حالة البث هي "live".
insufficientPermissions	insufficientLivePermissions	غير مسموح للمستخدم بإجراء العملية المطلوبة، قد يرجع ذلك إلى أنّ المستخدم لا يملك إذنًا بالبث المباشر.
insufficientPermissions	liveStreamingNotEnabled	إنّ المستخدم الذي فوَّض بالطلب غير مفعّل لبث فيديو مباشر على YouTube. يمكن للمستخدم العثور على المزيد من المعلومات على https://www.youtube.com/features.
invalidValue (400)	conflictingTimeFields	يمكن تحديد سمة واحدة فقط من offsetTimeMs وwalltime.
invalidValue (400)	invalidOffsetTimeMs	قيمة معلَمة offsetTimeMs غير صالحة. يجب أن تكون قيمة المَعلمة موجبة، ولكن لا يمكن تحديد المَعلمة إلا في حال تفعيل بث شاشة البث.
invalidValue (400)	invalidWalltime	قيمة معلَمة walltime غير صالحة.
notFound (404)	liveBroadcastNotFound	البث الذي حدّدته المَعلمة id غير متوفّر.
required (400)	actionRequired	يحتاج طلب البيانات من واجهة برمجة التطبيقات إلى تحديد إجراء واحد على الأقل. في الوقت الحالي، الإجراء الوحيد المتوافق هو القدرة على تفعيل العنصر الحاجب أو إيقافه.
required (400)	idRequired	يجب أن تحدّد معلَمة id المطلوبة البث الذي يتم تعديله.

تجربة

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