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

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.

פרמטרים
הפרמטרים הנדרשים
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
ה-e של המשאב הזה.
items[] list
רשימה של דירוגים שתואמים לקריטריונים של הבקשה.
items[].videoId string
המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון.
items[].rating string
הדירוג שהמשתמש המורשה העניק לסרטון.

הערכים החוקיים לנכס הזה הם:
  • dislike
  • like
  • none
  • unspecified

שגיאות

ה-API לא מגדיר הודעות שגיאה ייחודיות לשיטת ה-API הזו. עם זאת, השיטה הזו עדיין יכולה להחזיר שגיאות כלליות של ה-API שמפורטות בתיעוד של הודעת השגיאה.

רוצה לנסות?

משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.