Videos: getRating

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

تأثیر سهمیه: تماس با این روش هزینه سهمیه ۱ واحدی دارد.

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

درخواست

درخواست 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
https://www.googleapis.com/auth/youtube.readonly

پارامترها

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

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

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

متن درخواست

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

پاسخ

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

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

مشخصات

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

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

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

خطاها

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

امتحان کنید!

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