LiveChatMessages: insert
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הוספת הודעה או סקר לצ'אט בשידור חי.
תרחישים נפוצים לדוגמה
בקשה
בקשת 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. צריך לרשום לפחות שני פריטים, אבל לא יותר מחמישה פריטים. הפריטים מוצגים ברצף לפי הסדר שבו הם מפורטים.
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שיכולות להופיע בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במאמר 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.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-01-02 (שעון UTC).
[null,null,["עדכון אחרון: 2025-01-02 (שעון UTC)."],[],[],null,["# LiveChatMessages: insert\n\nAdds a message or a poll to a live chat.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/youtube/v3/liveChat/messages\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more about authentication and authorization, see [Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) in the request body.\nFor that resource, you must specify values for these properties\n\n- `snippet.liveChatId`\n- `snippet.type` - choose one of the following options: `textMessageEvent` or `pollEvent`\n- If type is `textMessageEvent`, include `snippet.textMessageDetails.messageText`\n- If type is `pollEvent`, include `snippet.pollDetails` with the following values:\n - `snippet.pollDetails.metadata.options.questionText`\n - List of `snippet.pollDetails.metadata.options.optionText`. You must list at least two items and no more than four items. Items are displayed sequentially in the order they're listed.\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. For more details, see [YouTube Live Streaming API - Errors](/youtube/v3/live/docs/errors).\n\n| Error type | Error detail | Description |\n|----------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forbidden (403)` | `forbidden` | You don't have the permissions required to create the specified message. |\n| `forbidden (403)` | `liveChatDisabled` | The specified live chat has been disabled by the owner, which means messages cannot be added to the chat. |\n| `forbidden (403)` | `liveChatEnded` | The specified live chat is no longer live. |\n| `invalidValue (400)` | `messageTextInvalid` | The message text (`snippet.textMessageDetails.messageText`) is not valid. |\n| `notFound (404)` | `liveChatNotFound` | The live chat identified in the API request does not exist. This error occurs if the chat has been deleted by the owner. |\n| `required (400)` | `liveChatIdRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.liveChatId` property. |\n| `required (400)` | `messageTextRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.textMessageDetails.messageText` property. |\n| `required (400)` | `typeRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.type` property. Set the parameter value to `text` |\n| `required (400)` | `preconditionCheckFailed` | A pinned active poll already exists. |\n| `rateLimitExceeded` | `rateLimitExceeded` | The user has posted too many chat messages in a given timeframe. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
