LiveChatBans: insert
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
איסור על משתמש ספציפי להשתתף בצ'אט בשידור חי. בקשת ה-API צריכה להיות מאושרת על ידי הבעלים של הערוץ או על ידי מנהל התגובות בצ'אט בשידור חי שמשויך להחרגה.
תרחישים נפוצים לדוגמה
בקשה
בקשת HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/bans
אישור
הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים. למידע נוסף על אימות ועל מתן הרשאות, קראו את המאמר הטמעת אימות OAuth 2.0.
| היקף |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים שמפורטים הם פרמטרים של שאילתות.
| פרמטרים |
| פרמטרים נדרשים |
part |
string
הפרמטר part משמש לשני יעדים בפעולה הזו. הוא מזהה את המאפיינים שתוגדר להם פעולת הכתיבה, וגם את המאפיינים שתשובת ה-API מחזירה. מגדירים את ערך הפרמטר כ-snippet. |
גוף הבקשה
מספקים משאב liveChatBan בגוף הבקשה.
במשאב הזה:
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שיכולות להופיע בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במאמר YouTube Live Streaming API – שגיאות.
| סוג השגיאה |
פרטי השגיאה |
תיאור |
forbidden (403) |
insufficientPermissions |
אין לכם את ההרשאות הנדרשות כדי להחריג משתמש מהצ'אט החי שצוין. |
forbidden (403) |
liveChatBanInsertionNotAllowed |
לא ניתן ליצור את האיסור שצוין. השגיאה הזו יכולה להתרחש אם הבקשה מנסה להוציא צו איסור על הבעלים של הצ'אט או על מנהל אחר. |
invalidValue (400) |
invalidChannelId |
לא ניתן למצוא את מזהה הערוץ שצוין. |
invalidValue (400) |
invalidLiveChatId |
הערך של snippet.liveChatId שצוין בבקשה לא חוקי. בודקים את המשאב המשויך liveBroadcast כדי לוודא שהערך נכון. |
notFound (404) |
liveChatNotFound |
לא ניתן למצוא את הצ'אט בשידור חי שצוין. בודקים את משאב ה-liveBroadcast המשויך כדי לוודא שהגדרתם את נכס ה-snippet.liveChatId לערך הנכון. |
notFound (404) |
liveChatUserNotFound |
לא ניתן למצוא את המשתמש בצ'אט בשידור חי שניסיתם לחסום. |
required (400) |
bannedUserChannelIdRequired |
במשאב liveChatBan שנשלח בגוף הבקשה צריך לציין ערך למאפיין snippet.bannedUserDetails.channelId. |
required (400) |
liveChatIdRequired |
במשאב liveChatBan שנשלח בגוף הבקשה צריך לציין ערך למאפיין snippet.liveChatId. |
נסה בעצמך!
משתמשים ב-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,["# LiveChatBans: insert\n\nBans a specific user from participating in the live chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\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/bans\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more\nabout authentication and authorization, see\n[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 in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#resource) in the request body.\nFor that resource:\n\n- You must specify a value for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.liveChatId`\n - `snippet.type`\n - `snippet.bannedUserDetails.channelId`\n\n \u003cbr /\u003e\n\n- You can set values for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.banDurationSeconds`\n\n \u003cbr /\u003e\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatBan resource](/youtube/v3/live/docs/liveChatBans#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)` | `insufficientPermissions` | You do not have the necessary permissions to ban a user from the specified live chat. |\n| `forbidden (403)` | `liveChatBanInsertionNotAllowed` | The specified ban cannot be created. This error can occur if the request attempts to ban the chat owner or another moderator. |\n| `invalidValue (400)` | `invalidChannelId` | The specified channel ID cannot be found. |\n| `invalidValue (400)` | `invalidLiveChatId` | The `snippet.liveChatId` value specified in the request is invalid. Check the associated `liveBroadcast` resource to ensure that you have the correct value. |\n| `notFound (404)` | `liveChatNotFound` | The specified live chat cannot be found. Check the associated `liveBroadcast` resource to ensure that you are setting the `snippet.liveChatId` property to the correct value. |\n| `notFound (404)` | `liveChatUserNotFound` | The live chat user you are trying to ban cannot be found. |\n| `required (400)` | `bannedUserChannelIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.bannedUserDetails.channelId` property. |\n| `required (400)` | `liveChatIdRequired` | The `liveChatBan` resource submitted in the request body must specify a value for the `snippet.liveChatId` property. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
