Members

משאב member מייצג חבר במועדון של ערוץ ב-YouTube. חברי מועדון תומכים ביוצרים באופן קבוע ומקבלים הטבות מיוחדות. לדוגמה, חברי המועדון יכולים לשלוח הודעות בצ'אט כשהיוצר מפעיל את המצב 'צ'אט לחברי מועדון בלבד'.

הגבלות הגישה הבאות חלות:

• הגישה לנקודות הקצה members ו-membershipsLevels מוגבלת ליוצרים ב-YouTube שיש להם מנהל שותפים ייעודי של YouTube.
• הגישה ניתנת ברמת הערוץ. בגלל הוספת הערוץ הזה לרשימת ההיתרים, היקף ההרשאות של youtube.channel-memberships.creator ב-OAuth לא עובר את תהליך האימות הרגיל של Google Cloud OAuth.

Methods

ה-API תומך בשיטות הבאות למשאבי member:

list

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

ייצוג מקורות מידע

מבנה ה-JSON הבא מציג את הפורמט של משאב member:

{
  "kind": "youtube#member",
  "etag": etag,
  "snippet": {
    "creatorChannelId": string,
    "memberDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "membershipsDetails": {
      "highestAccessibleLevel": string,
      "highestAccessibleLevelDisplayName": string,
      "accessibleLevels": [
        string
      ],
      "membershipsDuration": {
        "memberSince": datetime,
        "memberTotalDurationMonths": integer,
      },
      "membershipsDurationAtLevel": [
        {
          "level": string,
          "memberSince": datetime,
          "memberTotalDurationMonths": integer,
        }
      ]
    }
  }
}

מאפיינים

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

מאפיינים
kind	string מזהה את סוג המשאב של ה-API. הערך יהיה youtube#member.
etag	etag ה-Etag של מקור המידע הזה.
snippet	‫object האובייקט snippet מכיל פרטים על החבר.
snippet.creatorChannelId	string מזהה ערוץ YouTube של היוצר שמציע חברות במועדון.
snippet.memberDetails	object האובייקט הזה מכיל נתוני פרופיל על הערוץ ב-YouTube שמשלם על החברות במועדון. חשוב לדעת: בערוץ יכולים להיות חברים שנתוני הפרופיל שלהם לא זמינים. לדוגמה, זה קורה עם חברים שמחקו את הערוצים שלהם אבל עדיין משלמים על החברות במועדון. חשוב לזכור שהחברים האלה עדיין יכולים לגשת להטבות למנויים. התגובות מה-API כוללות משאבים לחברים האלה כדי להבטיח ספירה מדויקת, למרות שפרטי הפרופיל באובייקט memberDetails לא מוגדרים. הם עדיין יקבלו את membershipsDetails.
snippet.memberDetails.channelId	string מזהה הערוץ ב-YouTube של הערוץ החבר. אם הוא מוגדר, אפשר להתייחס למזהה הערוץ גם כמזהה ייחודי של חבר המועדון. אם הוא לא מוגדר, אי אפשר לזהות את המנוי באופן ייחודי, אבל המשאב עדיין מעביר את פרטי המינוי, כמו הרמות שהמנוי יכול לגשת אליהן ומשך המינוי.
snippet.memberDetails.channelUrl	string כתובת ה-URL של הערוץ.
snippet.memberDetails.displayName	string השם המוצג של הערוץ.
snippet.memberDetails.profileImageUrl	string כתובת ה-URL של האווטאר של הערוץ.
snippet.membershipsDetails	object האובייקט הזה מכיל פרטים על החברות במועדון החברים של הערוץ.
snippet.membershipsDetails.highestAccessibleLevel	string המזהה של רמה במועדון החברים הגבוהה ביותר שלמועדון החברים בערוץ יש כרגע גישה אליה. הערך הזה תואם לערך המאפיין id במשאב membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName	string השם של רמת החברות הגבוהה ביותר שלחבר המועדון בערוץ יש גישה אליה כרגע. הערך תואם לערך המאפיין displayName במשאב membershipsLevel.
snippet.membershipsDetails.accessibleLevels[]	list (of strings) רשימה של מזהים לכל הרמות במועדון החברים שהמשתמש יכול לגשת אליהן כרגע. הרשימה כוללת את הרמה הפעילה הנוכחית ואת כל הרמות שמתחתיה.
snippet.membershipsDuration	object האובייקט הזה מכיל מידע על משך הזמן הכולל של המינוי של המשתמש הנוכחי, בלי קשר לרמות התמחור. המאפיין snippet.membershipsDetails.membershipsDurationAtLevel[] מכיל רשימה של אובייקטים עם פרטים על תקופת החברות שבה לחבר המועדון הייתה גישה לרמה מסוימת במועדון. הדוגמה הבאה ממחישה איך המאפיינים האלה פועלים: חבר מועדון רוכש חברות חדשה במועדון בינואר ברמה 1, והחברות הזו נמשכת עד מרץ. באפריל ובמאי, למשתמש אין מינוי. ביוני, החבר מחדש את החברות שלו, שוב ברמה 1. באוגוסט, החבר משדרג את החברות שלו במועדון לרמה 2. לכן, אם קריאה ל-API מתבצעת באוקטובר, המשאב member יכיל את הפרטים הבאים: "membershipsDetails": { "membershipsDuration": { "memberSince": "2020-06-01T12:00:00", "memberTotalDurationMonths": 7, }, "membershipsDurationAtLevel": [ { "level": "level_1_ID", "memberSince": "2020-06-01T12:00:00", "memberTotalDurationMonths": 7 }, { "level": "level_2_ID", "memberSince": "2020-08-01T12:00:00", "memberTotalDurationMonths": 2 }, ] }
snippet.membershipsDuration.memberSince	datetime התאריך והשעה שבהם התחילה החברות הנוכחית של המנוי. במילים אחרות, המנוי היה חבר במועדון ברציפות מאז התאריך והשעה האלה. חשוב לזכור שבתקופות שונות של החברות במועדון, יכול להיות שהייתם ברמות שונות במועדון החברים.
snippet.membershipsDuration.memberTotalDurationMonths	integer מספר החודשים שהמשתמש חבר במועדון, מעוגל כלפי מטה למספר השלם הקרוב ביותר. הערך משקף את מספר החודשים המלאים שבהם המשתמש היה חבר במועדון, אבל המספר לא מציין שהמשתמש היה חבר במועדון במשך כל כך הרבה חודשים ברציפות.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[]	list (of objects) רשימה של אובייקטים, שכל אחד מהם מכיל פרטים על תקופת החברות שבמהלכה הייתה למשתמש גישה לרמה במועדון החברים מסוימת. הרשימה כוללת אובייקט אחד לכל רמה במועדון החברים שהחבר יכול לגשת אליה כרגע.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level	string המזהה של הרמה במועדון החברים. הערך תואם לערך המאפיין id במשאב membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince	datetime התאריך והשעה שמהם יש לחבר במועדון גישה לרמה שצוינה במועדון החברים. במילים אחרות, למנוי יש גישה רציפה לרמה הזו מאז התאריך והשעה האלה. חשוב לזכור שבתקופות שונות של החברות במועדון, יכול להיות שהייתם ברמות חברות גבוהות יותר.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths	integer מספר החודשים, מעוגל כלפי מטה למספר השלם הקרוב ביותר, שבהם למשתמש הייתה גישה לרמה שצוינה. הערך משקף את מספר החודשים המלאים שבהם לחבר הייתה גישה לרמה, אבל המספר לא מציין שהחבר היה חבר במועדון במשך כל החודשים האלה ברצף.