הוספת הודעה או סקר לצ'אט בשידור חי.
תרחישים נפוצים לדוגמה
בקשה
בקשת HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages
אישור
הבקשה הזו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
| היקף |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שנתמכים בשאילתה הזו. כל הפרמטרים הרשומים הם פרמטרים של שאילתות.
| פרמטרים | ||
|---|---|---|
| פרמטרים נדרשים | ||
part |
stringהפרמטר part משמש לשתי מטרות. הוא מזהה את המאפיינים שפעולת הכתיבה תגדיר וגם את המאפיינים שתגובת ה-API תכלול. מגדירים את ערך הפרמטר כ-snippet. |
|
גוף הבקשה
מציינים משאבliveChatMessage בגוף הבקשה. צריך לציין ערכים למאפיינים האלה במשאב הזה.
snippet.liveChatIdsnippet.type– בוחרים אחת מהאפשרויות הבאות:textMessageEventאוpollEvent- אם הסוג הוא
textMessageEvent, יש לכלול אתsnippet.textMessageDetails.messageText - אם הסוג הוא
pollEvent, צריך לכלול אתsnippet.pollDetailsעם הערכים הבאים:snippet.pollDetails.metadata.options.questionText- רשימה של
snippet.pollDetails.metadata.options.optionText. צריך לרשום לפחות שני פריטים ולא יותר מחמישה פריטים. הפריטים מוצגים ברצף, לפי סדר הצגתם.
תשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו תחזיר משאבliveChatMessage בגוף התשובה.
שגיאות
הטבלה הבאה מזהה את הודעות השגיאה שה-API יכול להחזיר בתגובה לקריאה ל-method הזה. פרטים נוספים זמינים במסמכים בנושא הודעות שגיאה.
| סוג השגיאה | פרטי השגיאה | תיאור |
|---|---|---|
forbidden (403) |
forbidden |
אין לך את ההרשאות שנדרשות כדי ליצור את ההודעה שצוינה. |
forbidden (403) |
liveChatDisabled |
הצ'אט בשידור חי שצוין הושבת על ידי הבעלים, ולכן אי אפשר להוסיף הודעות לצ'אט. |
forbidden (403) |
liveChatEnded |
הצ'אט בשידור חי שצוין כבר לא פעיל. |
invalidValue (400) |
messageTextInvalid |
טקסט ההודעה (snippet.textMessageDetails.messageText) אינו חוקי. |
notFound (404) |
liveChatNotFound |
הצ'אט בשידור חי שצוין בבקשת ה-API לא קיים. השגיאה הזו מתקבלת אם הבעלים מחקו את הצ'אט. |
required (400) |
liveChatIdRequired |
המשאבliveChatMessage חייב לכלול ולציין ערך עבור המאפיין snippet.liveChatId. |
required (400) |
messageTextRequired |
המשאבliveChatMessage חייב לכלול ולציין ערך עבור המאפיין snippet.textMessageDetails.messageText. |
required (400) |
typeRequired |
המשאבliveChatMessage חייב לכלול ולציין ערך עבור המאפיין snippet.type. הגדרת ערך הפרמטר כ-text |
required (400) |
preconditionCheckFailed |
כבר קיים סקר פעיל מוצמד. |
rateLimitExceeded |
rateLimitExceeded |
המשתמש פרסם יותר מדי הודעות צ'אט בפרק זמן נתון. |
נסה בעצמך!
אפשר להשתמש ב-APIs Explorer כדי לשלוח קריאה ל-API הזה ולראות את בקשת ה-API והתגובה.