Groups: list

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

שליחת בקשה

בקשת HTTP

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

הרשאה

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

טווחים
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.

פרמטרים

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

פרמטרים
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים)
id string
הפרמטר id מציין רשימה של המזהים של מזהי הקבוצות שמאוחזרים, כשהם מופרדים בפסיקים. כל קבוצה חייבת להיות בבעלות המשתמש המאומת. במשאב group, המאפיין id מציין את מזהה קבוצת YouTube של הקבוצה.

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

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

גוף הבקשה

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

תשובה

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

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

נכסים

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

נכסים
kind string
מזהה את סוג המשאב של ה-API. הערך יהיה youtube#groupListResponse.
etag etag
התג של המשאב הזה.
items[] list
רשימת קבוצות שתואמות לפרמטרים של בקשת ה-API. כל פריט ברשימה מייצג משאב group.
nextPageToken string
האסימון שיכול לשמש כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות.

שגיאות

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

רוצה לנסות?

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