Videos: rate

رتبه پسندیدن یا نپسندیدن را به یک ویدیو اضافه کنید یا امتیازی را از یک ویدیو حذف کنید.

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

توجه: این بر تعداد رسمی پسندیدن/نپسندیدن ویدیو تأثیری نمی‌گذارد.

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

درخواست

درخواست HTTP

POST https://www.googleapis.com/youtube/v3/videos/rate

مجوز

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

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

مولفه های

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

مولفه های
پارامترهای مورد نیاز
id string
پارامتر id شناسه ویدیوی YouTube را مشخص می کند که در حال رتبه بندی یا حذف رتبه آن است.
rating string
درجه بندی برای ثبت را مشخص می کند.

مقادیر قابل قبول عبارتند از:
  • dislike - ضبط می کند که کاربر تأیید شده ویدیو را دوست نداشته است.
  • like - ضبط می کند که کاربر احراز هویت ویدیو را پسندیده است.
  • none - هر رتبه‌بندی را که کاربر احراز هویت قبلاً برای ویدیو تعیین کرده بود، حذف می‌کند.

درخواست بدن

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

واکنش

در صورت موفقیت آمیز بودن، این روش کد پاسخ HTTP 204 ( No Content ) را برمی گرداند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
badRequest (400) emailNotVerified کاربر باید آدرس ایمیل خود را قبل از رتبه بندی تایید کند.
badRequest (400) invalidRating درخواست حاوی مقدار غیرمنتظره ای برای پارامتر rating بود.
badRequest (400) videoPurchaseRequired ویدیوهای کرایه ای فقط توسط کاربرانی که آنها را اجاره کرده اند می توانند رتبه بندی کنند.
forbidden (403) forbidden ویدیویی که می‌خواهید به آن امتیاز دهید نمی‌تواند رتبه‌بندی شود. ممکن است درخواست به درستی مجاز نباشد.
forbidden (403) videoRatingDisabled مالک ویدیویی که می‌خواهید رتبه‌بندی کنید، رتبه‌بندی آن ویدیو را غیرفعال کرده است.
notFound (404) videoNotFound ویدیویی که می‌خواهید به آن امتیاز دهید پیدا نمی‌شود. مقدار پارامتر id درخواست را بررسی کنید تا مطمئن شوید که درست است.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.

،

رتبه پسندیدن یا نپسندیدن را به یک ویدیو اضافه کنید یا امتیازی را از یک ویدیو حذف کنید.

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

توجه: این بر تعداد رسمی پسندیدن/نپسندیدن ویدیو تأثیری نمی‌گذارد.

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

درخواست

درخواست HTTP

POST https://www.googleapis.com/youtube/v3/videos/rate

مجوز

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

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

مولفه های

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

مولفه های
پارامترهای مورد نیاز
id string
پارامتر id شناسه ویدیوی YouTube را مشخص می کند که در حال رتبه بندی یا حذف رتبه آن است.
rating string
درجه بندی برای ثبت را مشخص می کند.

مقادیر قابل قبول عبارتند از:
  • dislike - ضبط می کند که کاربر تأیید شده ویدیو را دوست نداشته است.
  • like - ضبط می کند که کاربر احراز هویت ویدیو را پسندیده است.
  • none - هر رتبه‌بندی را که کاربر احراز هویت قبلاً برای ویدیو تعیین کرده بود، حذف می‌کند.

درخواست بدن

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

واکنش

در صورت موفقیت آمیز بودن، این روش کد پاسخ HTTP 204 ( No Content ) را برمی گرداند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
badRequest (400) emailNotVerified کاربر باید آدرس ایمیل خود را قبل از رتبه بندی تایید کند.
badRequest (400) invalidRating درخواست حاوی مقدار غیرمنتظره ای برای پارامتر rating بود.
badRequest (400) videoPurchaseRequired ویدیوهای کرایه ای فقط توسط کاربرانی که آنها را اجاره کرده اند می توانند رتبه بندی کنند.
forbidden (403) forbidden ویدیویی که می‌خواهید به آن امتیاز دهید نمی‌تواند رتبه‌بندی شود. ممکن است درخواست به درستی مجاز نباشد.
forbidden (403) videoRatingDisabled مالک ویدیویی که می‌خواهید رتبه‌بندی کنید، رتبه‌بندی آن ویدیو را غیرفعال کرده است.
notFound (404) videoNotFound ویدیویی که می‌خواهید به آن امتیاز دهید پیدا نمی‌شود. مقدار پارامتر id درخواست را بررسی کنید تا مطمئن شوید که درست است.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.