Comments: setModerationStatus

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

השפעה על המכסה: קריאה ל-method הזה מנצלת 50 יחידות מהמכסה.

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

בקשה

בקשת HTTP

POST https://www.googleapis.com/youtube/v3/comments/setModerationStatus

אישור

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

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

פרמטרים

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

פרמטרים
פרמטרים נדרשים
id ‫string
הפרמטר id מציין רשימה מופרדת בפסיקים של עד 50 מזהים שמציינים את התגובות שרוצים לעדכן את סטטוס הפיקוח שלהן.
moderationStatus string
מזהה את סטטוס הניהול החדש של התגובות שצוינו.

הערכים הקבילים הם:
  • ‫heldForReview – סימון תגובה כהמתנה לבדיקה על ידי מנהל.
  • published – אישור תגובה להצגה באופן גלוי לכולם. אי אפשר לשנות את סטטוס הניהול של תגובה שנדחתה ל-published.
  • ‫rejected – דחיית תגובה כי היא לא מתאימה להצגה. הפעולה הזו גם מסתירה את כל התשובות לתגובה שנדחתה. כדי להסיר מהערוץ או מהסרטון שלכם תגובה שכתב משתמש אחר, צריך להגדיר את סטטוס הניהול שלה כ-rejected. רק מי שכתב את התגובה יכול להשתמש בשיטה comments.delete.
פרמטרים אופציונליים
banAuthor boolean
הפרמטר banAuthor מאפשר לציין שרוצים לדחות באופן אוטומטי תגובות נוספות שנכתבו על ידי מחבר התגובה. כדי לחסום את המחבר, מגדירים את ערך הפרמטר בתור true.

הפרמטר הזה תקף רק אם הפרמטר moderationStatus מוגדר גם הוא לערך rejected.

גוף הבקשה

אל תספקו גוף בקשה כשאתם קוראים ל-method הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-method מחזירה קוד תגובה של HTTP‏ 204 ‏ (No Content).

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שיכולות להתקבל מה-API בתגובה לקריאה של השיטה הזו. פרטים נוספים זמינים במסמכי התיעוד של הודעת השגיאה.

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) banWithoutReject אפשר להשתמש בפרמטר banAuthor רק אם ערך הפרמטר moderationStatus הוא rejected.
badRequest (400) operationNotSupported תגובות שלא מבוססות על Google+‎ מציעות רק פונקציונליות מוגבלת של ניהול תגובות.
badRequest (400) processingFailure שרת ה-API לא הצליח לעבד את הבקשה. יכול להיות שמדובר בשגיאה זמנית, אבל בדרך כלל היא מצביעה על כך שהקלט של הבקשה לא תקין. השגיאה הזו מוחזרת גם כשמנסים לנהל תגובה שכבר נמחקה על ידי המשתמש שפרסם אותה.
forbidden (403) forbidden אי אפשר להגדיר את סטטוס הניהול של תגובה אחת או יותר בגלל הרשאות לא מספיקות. יכול להיות שהבקשה לא אושרה. השגיאה הזו מוחזרת גם כשמנסים לנהל תגובה שנמחקה או מזהה תגובה לא חוקי.
notFound (404) commentNotFound לא ניתן למצוא אחת או יותר מהתגובות שהבקשה מנסה לעדכן. צריך לבדוק את הערכים של הפרמטר id בבקשה ולוודא שהם נכונים.

רוצה לנסות?

משתמשים ב-APIs Explorer כדי להפעיל את ה-API הזה ולראות את בקשת ה-API והתגובה.