Videos: getRating

رتبه بندی هایی را که کاربر مجاز به لیستی از ویدیوهای مشخص شده داده است، بازیابی می کند.

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

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

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/videos/getRating

مجوز

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

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

مولفه های

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

مولفه های
پارامترهای مورد نیاز
id string
پارامتر id فهرستی از شناسه(های) ویدیوی YouTube را برای منبع(هایی) که داده های رتبه بندی آنها را بازیابی می کنید، با کاما مشخص می کند. در یک منبع video ، ویژگی id شناسه ویدیو را مشخص می کند.
پارامترهای اختیاری
onBehalfOfContentOwner string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است.

پارامتر onBehalfOfContentOwner نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند. این به صاحبان محتوا امکان می‌دهد یک بار احراز هویت کنند و به تمام داده‌های ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS که کاربر با آن احراز هویت می‌کند باید به مالک محتوای YouTube مشخص شده مرتبط باشد.

درخواست بدن

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

واکنش

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:

{
  "kind": "youtube#videoGetRatingResponse",
  "etag": etag,
  "items": [
    {
      "videoId": string,
      "rating": string
    }
  ]
}

خواص

جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#videoGetRatingResponse خواهد بود.
etag etag
Etag این منبع
items[] list
فهرستی از رتبه‌بندی‌هایی که با معیارهای درخواست مطابقت دارند.
items[]. videoId string
شناسه ای که YouTube برای شناسایی منحصر به فرد ویدیو استفاده می کند.
items[]. rating string
امتیازی که کاربر مجاز به ویدیو داده است.

مقادیر معتبر برای این ویژگی عبارتند از:
  • dislike
  • like
  • none
  • unspecified

خطاها

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

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

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