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 را مشخص می‌کند که پاسخ API شامل آن خواهد شد. مقادیر پشتیبانی شده عبارتند از id , snippet , و authorDetails .

مقدار پارامتر را روی snippet تنظیم کنید تا نتیجه نظرسنجی نهایی در بدنه پاسخ به دست آید.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

واکنش

در صورت موفقیت آمیز بودن، این روش یک منبع liveChatMessages را در بدنه پاسخ برمی گرداند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
forbidden (403) forbidden شما مجوزهای لازم برای انتقال وضعیت پیام مشخص شده را ندارید.
required (400) idRequired پارامتر id مورد نیاز باید پیامی را که می خواهید وضعیت آن را انتقال دهید مشخص کند.
required (400) statusRequired درخواست API باید مقداری برای پارامتر status مشخص کند.
notFound (404) liveChatMessagesNotFound پیام مشخص شده توسط پارامتر id وجود ندارد.
forbidden (403) modificationNotAllowed وضعیت منبع liveChatMessage مشخص شده قابل انتقال نیست. پارامتر id ممکن است پیامی را شناسایی کند که وضعیت آن قابل انتقال نباشد.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.