GroupItems: list

חשוב: כדי לשלוח בקשות API לשיטה הזו, נדרשת גישה לאחד מהגורמים הבאים:
  • ההיקף https://www.googleapis.com/auth/youtube
    או
  • היקף הרשאות https://www.googleapis.com/auth/youtube.readonly
    וגם
    היקף הרשאות https://www.googleapis.com/auth/yt-analytics.readonly

באפשרות הראשונה נעשה שימוש בהיקף אחד, שהוא היקף קריאה-כתיבה, ובאפשרות השנייה נעשה שימוש בשני היקפים לקריאה בלבד.

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

בקשה

בקשת HTTP

GET https://youtubeanalytics.googleapis.com/v2/groupItems

אישור

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

טווחים
https://www.googleapis.com/auth/yt-analytics.readonly עיון בדוחות YouTube Analytics עבור התוכן שלכם ב-YouTube. ההיקף הזה מספק גישה למדדי פעילות משתמשים, כמו ספירת צפיות וספירות של דירוגים.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly הצגת דוחות כספיים של YouTube Analytics לתוכן שלכם ב-YouTube. ההיקף הזה מספק גישה למדדי פעילות המשתמשים ולמדדים של ההכנסות המשוערות וביצועי המודעות.
https://www.googleapis.com/auth/youtube ניהול חשבון YouTube. ב-YouTube Analytics API, בעלי ערוצים משתמשים בהיקף הזה כדי לנהל קבוצות ופריטים מקובצים ב-YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner הצגה וניהול של נכסי YouTube והתכנים המשויכים ב-YouTube. ב-YouTube Analytics API, בעלי תוכן משתמשים בהיקף הזה כדי לנהל קבוצות ופריטי קבוצות ב-YouTube Analytics.

פרמטרים

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

פרמטרים
פרמטרים נדרשים
groupId string
הפרמטר id מציין את המזהה הייחודי של הקבוצה שעבורה רוצים לאחזר פריטים.
פרמטרים אופציונליים
onBehalfOfContentOwner string
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן ב-YouTube שבבעלותם מנוהלים הרבה ערוצים שונים ב-YouTube.

הפרמטר onBehalfOfContentOwner מציין שהפרטים המזהים של הרשאת הגישה של הבקשה מזהים משתמש ב-YouTube שפועל בשם בעלי התוכן שצוין בערך הפרמטר. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, בלי לספק פרטי כניסה לכל ערוץ בנפרד. החשבון שבאמצעותו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube.

גוף הבקשה

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

תשובה

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

{
  "kind": "youtube#groupItemListResponse",
  "etag": etag,
  "items": [
    groupItem Resource
  ]
}

מאפיינים

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

מאפיינים
kind string
מזהה את סוג משאב ה-API. הערך יהיה youtube#groupItemListResponse.
etag etag
ה-Etag של המשאב הזה.
items[] list
רשימה של הפריטים שהקבוצה מכילה. כל פריט ברשימה מייצג משאב groupItem.

שגיאות

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

נסה בעצמך!

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