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 בגוף הבקשה. במשאב הזה:

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

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

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

    • snippet.banDurationSeconds

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה מחזירה משאב של 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.