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 CMS الذي يتصرف نيابةً عن مالك المحتوى المحدد في قيمة المعلمة. هذه المعلمة مخصصة لشركاء محتوى 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 لاستدعاء واجهة برمجة التطبيقات هذه والاطّلاع على طلب واجهة برمجة التطبيقات والاستجابة له.