הוספת הודעה או סקר לצ'אט בשידור חי.
תרחישים נפוצים לדוגמה
בקשה
בקשת HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages
אישור
הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים. למידע נוסף על אימות והרשאה, קראו את המאמר הטמעת אימות OAuth 2.0.
| היקף |
|---|
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. צריך לרשום לפחות שני פריטים, אבל לא יותר מחמישה פריטים. הפריטים מוצגים ברצף לפי הסדר שבו הם מפורטים.
תשובה
אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר משאב liveChatMessage בגוף התגובה.
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שיכולות להופיע בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במאמר YouTube Live Streaming API – שגיאות.
| סוג השגיאה | פרטי השגיאה | תיאור |
|---|---|---|
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.