העברת הסטטוס של הודעת צ'אט בשידור חי ב-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 כדי לקבל את התוצאה הסופית של הסקר בגוף התשובה.
|
|
גוף הבקשה
אין לספק גוף בקשה כשמבצעים קריאה ל-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 והתגובה.