LiveChatBans: insert

חסימת משתמש מסוים בצ'אט בשידור חי. בקשת ה-API צריכה לקבל אישור מהבעלים של הערוץ או מהמנהל של הצ'אט בשידור חי שמשויך לחסימה.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/bans

אישור

בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.

פרמטרים
הפרמטרים הנדרשים
part string
הפרמטר part משרת שתי מטרות בפעולה זו. היא מזהה את המאפיינים שפעולת הכתיבה תגדיר, וכן את המאפיינים שתחזיר תגובת ה-API. מגדירים את ערך הפרמטר כ-snippet.

גוף הבקשה

צריך לספק משאב LiveChatBan בגוף הבקשה. במשאב הזה:

  • צריך לציין ערך למאפיינים הבאים:

    • snippet.liveChatId
    • snippet.type
    • snippet.bannedUserDetails.channelId

  • ניתן להגדיר ערכים למאפיינים הבאים:

    • snippet.banDurationSeconds

תשובה

אם הפעולה בוצעה בהצלחה, השיטה מחזירה משאב LiveChatBan בגוף התשובה.

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שה-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.