Videos: getRating

הפונקציה מאחזרת את הדירוגים שהמשתמש המורשה נתן לרשימה של סרטונים ספציפיים.

השפעה על המכסה: קריאה ל-method הזה מנצלת יחידה אחת מהמכסה.

תרחישים נפוצים לדוגמה

בקשה

בקשת 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 מציין שפרטי הכניסה לאימות של הבקשה מזהים משתמש של YouTube CMS שפועל בשם בעלי התוכן שצוינו בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן ב-YouTube שהם הבעלים של ערוצי YouTube רבים ומנהלים אותם. הוא מאפשר לבעלי התוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, בלי לספק פרטי כניסה לאימות לכל ערוץ בנפרד. חשבון מערכת ניהול התוכן (CMS) שהמשתמש מאמת באמצעותו חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube.

גוף הבקשה

אל תספקו גוף בקשה כשאתם קוראים ל-method הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:

{
  "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 והתגובה.