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.

גוף הבקשה

אין להזין גוף בקשה בעת הפעלת שיטה זו.

תשובה

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

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

נכסים

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

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

שגיאות

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

רוצה לנסות?

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