وضعیت پیام گپ مستقیم YouTube را تغییر می‌دهد و هرگونه فرایند مرتبط با وضعیت جدید را آغاز می‌کند. برای مثال، وقتی وضعیت یک نظرسنجی زنده را به closed تغییر می‌دهید، YouTube نظرسنجی آن پیام را پایان می‌دهد. قبل‌از فراخوانی این روش، باید تأیید کنید که مقدار ویژگی status برای پیام نظرسنجی زنده active است.
تأثیر بر سهمیه: تماس با این روش هزینه سهمیه ۲۰ واحدی دارد.
درخواست
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages/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 را در بدنه پاسخ برمی‌گرداند.
خطاها
جدول زیر پیام‌های خطایی را که ممکن است API در پاسخ به فراخوانی این روش برگرداند، مشخص می‌کند. لطفاً برای جزئیات بیشتر به سند پیام خطا مراجعه کنید.
| نوع خطا | جزئیات خطا | شرح |
|---|---|---|
forbidden (403) |
forbidden |
اجازه‌های لازم را برای انتقال وضعیت پیام مشخص‌شده ندارید. |
required (400) |
idRequired |
پارامتر الزامی id باید پیامی را که می‌خواهید وضعیت آن را تغییر دهید شناسایی کند. |
required (400) |
statusRequired |
درخواست API باید مقداری برای پارامتر status مشخص کند. |
notFound (404) |
liveChatMessagesNotFound |
پیام مشخص‌شده با پارامتر id وجود ندارد. |
forbidden (403) |
modificationNotAllowed |
وضعیت منبع liveChatMessage مشخص‌شده نمی‌تواند تغییر کند. پارامتر id ممکن است پیامی را شناسایی کند که وضعیت آن قابل انتقال نیست. |
امتحان کنید!
برای فراخوانی این API و دیدن درخواست و پاسخ API، از APIs Explorer استفاده کنید.