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 מציין רשימה מופרדת בפסיקים של מזהי הקבוצות ב-YouTube של המשאבים שאתם מאתרים. כל קבוצה צריכה להיות בבעלות המשתמש המאומת. במשאב group, המאפיין id מציין את מזהה הקבוצה של YouTube.

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

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

גוף הבקשה

אין לספק גוף בקשה בקריאה ל-method הזה.

תשובה

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

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

מאפיינים

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

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

שגיאות

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

נסה בעצמך!

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