חסימת משתמש ספציפי מהשתתפות בצ'אט בשידור חי. בקשת ה-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 בגוף הבקשה. למשאב הזה:
-
חובה לציין ערך למאפיינים האלה:
snippet.liveChatId-
snippet.type– בוחרים באחת מהאפשרויות הבאות:permanentאוtemporary snippet.bannedUserDetails.channelId
-
אפשר להגדיר ערכים למאפיינים הבאים:
snippet.banDurationSeconds
תשובה
אם השיטה מצליחה, היא מחזירה משאב liveChatBan בגוף התגובה.
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שיכולות להתקבל מה-API בתגובה לקריאה של השיטה הזו. פרטים נוספים זמינים במאמר YouTube Live Streaming API - Errors.
| סוג השגיאה | פרטי השגיאה | תיאור |
|---|---|---|
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 והתגובה.