Comments: setModerationStatus

وضعیت تعدیل یک یا چند نظر را تنظیم می کند. درخواست API باید توسط مالک کانال یا ویدیوی مرتبط با نظرات مجاز باشد.

تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 50 واحدی دارد.

موارد استفاده رایج

درخواست

درخواست HTTP

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

مجوز

این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).

محدوده
https://www.googleapis.com/auth/youtube.force-ssl

مولفه های

جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.

مولفه های
پارامترهای مورد نیاز
id string
پارامتر id فهرستی از شناسه‌های جدا شده با کاما را مشخص می‌کند که نظراتی را که برای آنها وضعیت تعدیل را به‌روزرسانی می‌کنید، مشخص می‌کند.
moderationStatus string
وضعیت تعدیل جدید نظرات مشخص شده را مشخص می کند.

مقادیر قابل قبول عبارتند از:
  • heldForReview - نظر را به عنوان در انتظار بررسی توسط ناظر علامت گذاری می کند.
  • published - یک نظر را برای نمایش عمومی پاک می کند.
  • rejected - نظر را به عنوان نامناسب برای نمایش رد می کند. این عمل همچنین به طور موثر تمام پاسخ‌های به نظر رد شده را پنهان می‌کند.
پارامترهای اختیاری
banAuthor boolean
پارامتر banAuthor به شما امکان می دهد نشان دهید که می خواهید به طور خودکار هر نظر اضافی نوشته شده توسط نویسنده نظر را رد کنید. مقدار پارامتر را روی true تنظیم کنید تا نویسنده ممنوع شود.

توجه: این پارامتر تنها در صورتی معتبر است که پارامتر moderationStatus نیز روی rejected تنظیم شده باشد.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

واکنش

در صورت موفقیت آمیز بودن، این روش کد پاسخ 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 استفاده کنید.