Members

הערה: החל מ-31 במרץ 2020, נקודת הקצה members מחליפה את נקודת הקצה sponsors, שהוצאה משימוש והתמיכה בה תופסק ב-30 בספטמבר 2020 או לאחר מכן. לקוחות API צריכים לעדכן את הקריאות ל-method‏ sponsors.list כדי להשתמש ב-method‏ members.list במקום זאת.

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

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

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
מספר החודשים, מעוגל כלפי מטה למספר שלם קרוב, שבהם למשתמש הייתה גישה לרמה שצוינה. הערך משקף את מספר החודשים המלאים שבהם למנויים הייתה גישה לרמה, אבל המספר לא מעיד על כך שהמנויים היו חברים במועדון במשך כל אותם חודשים.