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 تنظیم کنید تا نتیجه نظرسنجی نهایی در بدنه پاسخ به دست آید. |
درخواست بدن
هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که 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 استفاده کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-08-08 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2024-08-08 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThis API endpoint transitions the status of a YouTube live chat message, such as closing an active poll.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires authorization and must include the message's unique \u003ccode\u003eid\u003c/code\u003e and the new \u003ccode\u003estatus\u003c/code\u003e (\u003ccode\u003eclosed\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epart\u003c/code\u003e parameter, which is optional, specifies which parts of the \u003ccode\u003eliveChatMessage\u003c/code\u003e resource to include in the API response (e.g. \u003ccode\u003esnippet\u003c/code\u003e, \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003eauthorDetails\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eSuccessful calls to this API will return a \u003ccode\u003eliveChatMessages\u003c/code\u003e resource in the response body, detailing the message's new status.\u003c/p\u003e\n"],["\u003cp\u003eCommon errors include \u003ccode\u003eforbidden\u003c/code\u003e for permission issues, \u003ccode\u003erequired\u003c/code\u003e for missing parameters, \u003ccode\u003enotFound\u003c/code\u003e if the message ID doesn't exist, and \u003ccode\u003emodificationNotAllowed\u003c/code\u003e if the specified message's status can't be changed.\u003c/p\u003e\n"]]],["This API endpoint, `liveChatMessages/transition`, changes a YouTube live chat message's status and triggers related actions. It requires the message's `id` and the target `status`, which can only be `closed`. The `status` of the poll must be `active` to proceed with the transition. The request is a `POST` method without a request body. Authorization scopes `youtube` or `youtube.force-ssl` are needed. Upon success, a `liveChatMessages` resource is returned, and errors include `forbidden`, `required`, and `notFound`.\n"],null,[]]
