Members

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

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

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

שיטות

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