وضعیت تعدیل یک یا چند نظر را تنظیم میکند. درخواست API باید توسط مالک کانال یا ویدیوی مرتبط با نظرات مجاز شود.
تأثیر بر سهمیه: تماس با این روش هزینه سهمیه ۵۰ واحدی دارد.
موارد استفاده رایج
درخواست
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/comments/setModerationStatus
صدور مجوز
این درخواست به مجوز با حداقل یکی از دامنههای زیر نیاز دارد (درباره اصالتسنجی و مجوز بیشتر بخوانید).
| حوزه |
|---|
https://www.googleapis.com/auth/youtube.force-ssl |
پارامترها
جدول زیر پارامترهایی را که این پُرسمان پشتیبانی میکند فهرست میکند. همه پارامترهای فهرستشده پارامترهای پُرسمان هستند.
| پارامترها | ||
|---|---|---|
| پارامترهای الزامی | ||
id |
stringپارامتر id فهرستی جداشده با کاما از حداکثر ۵۰ شناسه را مشخص میکند که نظراتی را که وضعیت گردانندگی آنها را بهروز میکنید شناسایی میکند. |
|
moderationStatus |
stringوضعیت جدید نظارت بر محتوای نظرات مشخصشده را شناسایی میکند. مقادیر قابلقبول عبارتاند از:
|
|
| پارامترهای اختیاری | ||
banAuthor |
booleanپارامتر banAuthor به شما امکان میدهد نشان دهید که میخواهید هرگونه نظر اضافی که توسط نویسنده نظر نوشته شده است بهطور خودکار رد شود. برای ممنوع کردن نویسنده، مقدار پارامتر را روی true تنظیم کنید.این پارامتر فقط درصورتی معتبر است که پارامتر moderationStatus نیز روی rejected تنظیم شده باشد. |
|
متن درخواست
هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.
پاسخ
اگر موفقیتآمیز باشد، این روش کد پاسخ HTTP 204 (No Content) را برمیگرداند.
خطاها
جدول زیر پیامهای خطایی را که ممکن است «میانای برنامهسازی کاربردی» در پاسخ به فراخوانی این روش برگرداند مشخص میکند. لطفاً برای جزئیات بیشتر به سند پیام خطا مراجعه کنید.
| نوع خطا | جزئیات خطا | شرح |
|---|---|---|
badRequest (400) |
banWithoutReject |
از پارامتر banAuthor فقط زمانی میتوان استفاده کرد که مقدار پارامتر moderationStatus برابر با rejected باشد. |
badRequest (400) |
operationNotSupported |
نظراتی که براساس Google+ نیستند، فقط عملکرد تعدیل محدودی را ارائه میدهند. |
badRequest (400) |
processingFailure |
سرور میانای برنامهسازی کاربردی نتوانست درخواست را با موفقیت پردازش کند. اگرچه این خطا میتواند موقتی باشد، اما معمولاً نشان میدهد که ورودی درخواست نامعتبر است. این خطا همچنین زمانی برگردانده میشود که تلاش برای تعدیل نظری صورت گیرد که قبلاً توسط نظردهنده اصلی حذف شده است. |
forbidden (403) |
forbidden |
وضعیت تعدیل یک یا چند نظر بهدلیل نداشتن اجازههای کافی تنظیم نمیشود. ممکن است درخواست مجاز نباشد. این خطا همچنین هنگام تلاش برای مدیریت یک شناسه نظر حذفشده یا نامعتبر برگردانده میشود. |
notFound (404) |
commentNotFound |
یک یا چند نظری که درخواست سعی دارد بهروز کند پیدا نمیشود. مقادیر پارامتر id درخواست را بررسی کنید تا مطمئن شوید درست هستند. |
امتحان کنید!
برای فراخوانی این API و دیدن درخواست و پاسخ API، از APIs Explorer استفاده کنید.