Videos: batchGetStats

הפונקציה מאחזרת רשימה של נתונים סטטיסטיים של סרטונים שתואמים לפרמטרים של בקשת ה-API.

השפעה על המכסה: לשיחה לשיטה הזו יש עלות מכסה של יחידה אחת.

בקשה

בקשת HTTP

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

אישור

נדרש אימות כדי להשתמש בשיטה הזו בסרטונים שלא גלויים לכולם, אבל לא נדרש אימות בסרטונים שגלויים לכולם. אם מסופקת הרשאה, הבקשה חייבת להיות מאושרת עם לפחות אחת מההרשאות הבאות (מידע נוסף על אימות והרשאה).

היקף
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 של המשאבים שאותם מאחזרים. במשאב videoStat, המאפיין id מציין את מזהה הסרטון.
part	string הפרמטר part מציין רשימה מופרדת בפסיקים של מאפיין משאב אחד או יותר שייכללו בתגובת ה-API. הרשימה הבאה מכילה את השמות part שאפשר לכלול בערך הפרמטר: videoStat contentDetails id snippet statistics
פרמטרים אופציונליים
onBehalfOfContentOwner	string אפשר להשתמש בפרמטר הזה רק בבקשה מורשית. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן ב-YouTube. הפרמטר onBehalfOfContentOwner מציין שאמצעי ההרשאה של הבקשה מזהים משתמש ב-YouTube CMS שפועל בשם בעל התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן ב-YouTube שהם הבעלים של ערוצי YouTube רבים ומנהלים אותם. הכלי מאפשר לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, בלי לספק פרטי אימות לכל ערוץ בנפרד. החשבון במערכת ניהול התוכן שהמשתמש מאמת צריך להיות מקושר לבעלי התוכן ב-YouTube שצוינו.

גוף הבקשה

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

תשובה

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

{
  "kind": "youtube#batchGetStatsResponse",
  "etag": etag,
  "items": [
    {
      "kind": "youtube#videoStats",
      "etag": etag,
      "id": string,
      "snippet": {
        "publishTime": datetime
      },
      "statistics": {
        "viewCount": unsigned long,
        "likeCount": unsigned long,
        "commentCount": unsigned long
      },
      "contentDetails": {
        "duration": string,
        "durationMillis": unsigned long
      }
    }
  ],
  "summary": {
    "requestedVideoCount": unsigned long,
    "succeededVideoCount": unsigned long,
    "failedVideoCount": unsigned long,
    "failedVideoIds": [
      string
    ]
  }
}

מאפיינים

בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:

מאפיינים
kind	‫string מזהה את סוג משאב ה-API. הערך יהיה youtube#batchGetStatsResponse.
etag	etag ה-Etag של מקור המידע הזה.
items[]	list רשימה של נתונים סטטיסטיים של סרטונים שתואמים לקריטריונים של הבקשה.
items[].id	string המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון.
items[].snippet.publishTime	datetime התאריך והשעה שבהם הסרטון הועלה.
items[].statistics.viewCount	unsigned long מספר הפעמים שהסרטון נצפה.
items[].statistics.likeCount	unsigned long מספר המשתמשים שציינו שהם אהבו את הסרטון.
items[].statistics.commentCount	unsigned long מספר התגובות לסרטון.
items[].contentDetails.duration	string אורך הסרטון.
items[].contentDetails.durationMillis	unsigned long אורך הסרטון באלפיות השנייה.
summary	object סיכום של בקשת batchGetStats.
summary.requestedVideoCount	unsigned long מספר הסרטונים שהתבקשו.
summary.succeededVideoCount	unsigned long מספר הסרטונים שהועלו בהצלחה.
summary.failedVideoCount	unsigned long מספר הסרטונים שנכשלו.
summary.failedVideoIds[]	list מזהי הסרטונים שנכשלו.

שגיאות

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