Members: list

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

רשימה של החברים (לשעבר 'נותני חסות') בערוץ. הבעלים של הערוץ צריכים לאשר את בקשת ה-API.

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

בקשה

בקשת HTTP

GET https://www.googleapis.com/youtube/v3/members

אישור

בקשה זו מחייבת הרשאה עם ההיקף הבא:

היקף
https://www.googleapis.com/auth/youtube.channel-memberships.creator

פרמטרים

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

פרמטרים
הפרמטרים הנדרשים
part string
הפרמטר part מציין את מאפייני המשאבים של member שייכללו בתגובת ה-API. מגדירים את ערך הפרמטר כ-snippet.
פרמטרים אופציונליים
mode string
הפרמטר mode מציין אילו חברים ייכללו בתגובת ה-API. מגדירים את ערך הפרמטר לאחד מהערכים הבאים:
  • all_current (ברירת מחדל) - הצגת רשימת החברים הנוכחיים, מהחדש לישן. כשמשתמשים בערך הזה, מגיעים לסוף הרשימה כאשר תגובת ה-API לא מכילה nextPageToken.
  • updates – רשימה רק של חברים שהצטרפו או שדרגו אחרי הקריאה הקודמת ל-API. חשוב לשים לב שהשיחה הראשונה מתחילה רצף עדכונים חדש, אבל לא מוחזרות חברים בפועל. כדי להתחיל לאחזר את עדכוני המינוי, צריך לבדוק את נקודת הקצה באמצעות nextPageToken בתדירות הרצויה.

    חשוב לשים לב שכאשר משתמשים בערך הזה, תגובת ה-API תמיד מכילה את nextPageToken.
maxResults unsigned integer
הפרמטר maxResults מציין את מספר הפריטים המקסימלי שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 1000, כולל. ערך ברירת המחדל הוא 5.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. האסימון הוא ספציפי ל-mode שמשמש יחד עם בקשת ה-API המקורית, כך שלא ניתן להשתמש באסימון דף שאוחזר במצב אחד כדי לעבור בהמשך למצב אחר.
hasAccessToLevel string
ערך הפרמטר hasAccessToLevel הוא מזהה רמה שמציין את הרמה המינימלית שצריך להיות למשתמשים בקבוצת התוצאות.
filterByMemberChannelId string
הפרמטר filterByMemberChannelId מציין רשימה של מזהי ערוצים מופרדים בפסיקים, שאפשר להשתמש בהם כדי לבדוק את סטטוס החבֵרוּת של משתמשים ספציפיים. לדוגמה, UC_1,UC_2,UC_3. ניתן לציין עד 100 ערוצים לכל שיחה.

גוף הבקשה

אין לציין את גוף הבקשה בקריאה לשיטה הזו.

תשובה

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

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

תכונות

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

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) channelMembershipsNotEnabled בערוץ של היוצר שמאשר את הבקשה לא מופעל מועדון החברים של הערוץ.
badRequest (400) invalidMode ערך הפרמטר mode אינו חוקי. השגיאה הזו יכולה להתרחש אם בפרמטר pageToken מצוין אסימון שאוחזר באמצעות מצב שונה מזה שצוין.
badRequest (400) invalidPageToken ערך הפרמטר pageToken לא חוקי. השגיאה הזו יכולה לקרות אם פג התוקף של אסימון הדף שבו נעשה שימוש בבקשה או אם הוא לא מזוהה.
badRequest (400) invalidHasAccessToLevel ערך הפרמטר hasAccessToLevel לא חוקי. אין רמה עם id שצוין.
badRequest (400) invalidFilterByMemberChannelId ערך הפרמטר filterByMemberChannelId לא חוקי. השגיאה הזו מתקבלת אם ערך הפרמטר filterByMemberChannelId מציין יותר מ-100 ערוצים.