מאחזר את הדירוגים שהמשתמש המורשה נתן לרשימה של סרטונים שצוינו.
ההשפעה על המכסה: לשיחה בשיטה הזו מוגדרת עלות מכסה של יחידה אחת.
תרחישים נפוצים
שליחת בקשה
בקשת 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 מציין שפרטי הכניסה להרשאה של הבקשה מזהים משתמש CMS ב-YouTube שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם של ערוצי YouTube רבים. היא מאפשרת לבעלי התוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון במערכת ניהול התוכן שהמשתמש מאמת באמצעותו חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
גוף הבקשה
אין להזין גוף בקשה בעת הפעלת שיטה זו.
תשובה
אם התגובה מוצלחת, שיטה זו תחזיר גוף תגובה בעל המבנה הבא:
{ "kind": "youtube#videoGetRatingResponse", "etag": etag, "items": [ { "videoId": string, "rating": string } ] }
נכסים
הטבלה הבאה מגדירה את המאפיינים שמופיעים במשאב הזה:
נכסים | |
---|---|
kind |
string מזהה את סוג המשאב של ה-API. הערך יהיה youtube#videoGetRatingResponse . |
etag |
etag התג של המשאב הזה. |
items[] |
list רשימה של דירוגים שתואמים לקריטריונים של הבקשה. |
items[].videoId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון. |
items[].rating |
string הדירוג שהמשתמש המורשה נתן לסרטון. הערכים החוקיים לנכס הזה הם:
|
שגיאות
ממשק ה-API לא מגדיר הודעות שגיאה שהן ייחודיות לשיטה הזו. עם זאת, השיטה הזו עדיין יכולה להחזיר שגיאות כלליות בממשק ה-API שמפורטות במסמכי התיעוד בנושא הודעת שגיאה.
רוצה לנסות?
אפשר להשתמש ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את בקשת ה-API ואת התשובה.