LiveChatMessages: transition

ينقل هذا الحدث حالة رسالة المحادثة المباشرة في YouTube ويبدأ أي عمليات مرتبطة بالحالة الجديدة. على سبيل المثال، عند تغيير حالة استطلاع مباشر إلى closed، تُنهي YouTube استطلاع الرأي المعنيّ. قبل استخدام هذه الطريقة، يجب التأكّد من أنّ قيمة السمة status لرسالة الاستطلاع المباشر هي active.

الطلب

طلب HTTP

POST https://www.googleapis.com/youtube/v3/liveChatMessages/transition

التفويض

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

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

المعلمات

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

المعلمات
المَعلمات المطلوبة
id string
تحدد المعلمة id المعرف الفريد للرسالة التي تنتقل إلى حالة أخرى.
status enum
تحدِّد المَعلمة status الحالة التي يتم تغيير الرسالة إليها. لنقل رسالة إلى الحالة closed، يجب ضبط السمة status على active للاستطلاع المرتبط بالرسالة.

يمكنك فقط الانتقال إلى closed، مما يعني أن الاستطلاع مغلق.
المَعلمات الاختيارية
part string
تحدّد المعلمة part أجزاء موارد liveChatMessage التي ستتضمّنها استجابة واجهة برمجة التطبيقات. والقيم المسموح بإدراجها هي id وsnippet وauthorDetails.

يمكنك ضبط قيمة المَعلمة على snippet للحصول على نتيجة الاستطلاع النهائية في نص الاستجابة.

نص الطلب

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

الرد

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

الأخطاء

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

نوع الخطأ تفاصيل الخطأ الوصف
forbidden (403) forbidden ليس لديك الأذونات المطلوبة لنقل حالة الرسالة المحددة.
required (400) idRequired يجب أن تحدد معلمة id المطلوبة الرسالة التي تريد نقل حالتها.
required (400) statusRequired يجب أن يحدّد طلب البيانات من واجهة برمجة التطبيقات قيمة للمَعلمة status.
notFound (404) liveChatMessagesNotFound الرسالة التي حدّدتها المَعلمة id غير موجودة.
forbidden (403) modificationNotAllowed لا يمكن نقل حالة مورد liveChatMessage المحدّد. قد تحدد المعلمة id رسالة لا يمكن نقل حالتها.

جرّب الآن

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