Members

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