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. שימו לב שהקריאה הראשונה מתחילה זרם חדש של עדכונים, אבל לא מחזירה חברים בפועל. כדי להתחיל לאחזר את עדכוני המינוי, צריך לבדוק את נקודת הקצה (endpoint) באמצעות 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 ערוצים בכל קריאה.

גוף הבקשה

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

תשובה

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

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

מאפיינים

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

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

שגיאות

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

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