Members: list

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

רשימה של חברי המועדון (לשעבר "נותני חסות") בערוץ. בקשת ה-API חייבת לקבל הרשאה מהבעלים של הערוץ.

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

בקשה

בקשת 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
התג של המשאב הזה.
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 ערוצים.