הפעולה הזו משנה את הסטטוס של הודעה בצ'אט בשידור חי ב-YouTube ומתחילה את כל התהליכים שקשורים לסטטוס החדש. לדוגמה, כשמעבירים את הסטטוס של סקר פעיל ל-closed, המערכת של YouTube מסיימת את הסקר של ההודעה הזו. לפני שמפעילים את ה-method הזו, צריך לוודא שהערך של המאפיין status של הודעת הסקר בשידור חי הוא active.
השפעה על המכסה: קריאה ל-method הזה מנצלת 20 יחידות מהמכסה.
בקשה
בקשת 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 שהתגובה מה-API תכלול. הערכים הנתמכים הם id, snippet ו-authorDetails.
מגדירים את ערך הפרמטר ל- snippet כדי לקבל את תוצאת הסקר הסופית בגוף התגובה.
|
|
גוף הבקשה
אל תספקו גוף בקשה כשאתם קוראים ל-method הזו.
תשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה משאב liveChatMessages בגוף התגובה.
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שה-API יכול להחזיר בתגובה לקריאה ל-method הזה. פרטים נוספים מופיעים במסמכי התיעוד בנושא הודעות שגיאה.
| סוג השגיאה | פרטי השגיאה | תיאור |
|---|---|---|
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 והתגובה.