Members

توجه: از 31 مارس 2020، نقطه پایانی members جایگزین نقطه پایانی sponsors می شود، که اکنون منسوخ شده است و دیگر در 30 سپتامبر 2020 یا پس از آن پشتیبانی نخواهد شد. مشتریان API باید برای استفاده از members.list تماس ها را به روش 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 Etag این منبع
snippet	object شی snippet حاوی جزئیات مربوط به عضو است.
snippet. creatorChannelId	string شناسه کانال YouTube سازنده که عضویت را ارائه می دهد.
snippet. memberDetails	object این شی حاوی داده های نمایه مربوط به کانال YouTube است که هزینه عضویت را پرداخت می کند. توجه داشته باشید که یک کانال می‌تواند اعضایی داشته باشد که داده‌های نمایه در دسترس ندارند. به عنوان مثال، این اتفاق برای اعضایی رخ می‌دهد که کانال‌های خود را حذف کرده‌اند اما همچنان برای عضویت پرداخت می‌کنند. توجه داشته باشید که این اعضا همچنان می توانند به مزایای عضویت خود دسترسی داشته باشند. پاسخ‌های API شامل منابعی برای آن اعضا می‌شود تا از شمارش دقیق اطمینان حاصل کنند، حتی اگر جزئیات نمایه در شی memberDetails تنظیم نشده باشد. membershipsDetails هنوز برای چنین اعضایی ارائه شده است.
snippet.memberDetails. channelId	string شناسه کانال یوتیوب کانال عضو. اگر تنظیم شده باشد، شناسه کانال همچنین می تواند به عنوان یک شناسه منحصر به فرد برای عضو در نظر گرفته شود. اگر تنظیم نشود، نمی‌توان آن عضو را به‌طور منحصربه‌فرد شناسایی کرد، اما منبع همچنان جزئیات عضویت مانند سطوحی که عضو می‌تواند به آنها دسترسی داشته باشد و مدت زمان عضویت خود را منتقل می‌کند.
snippet.memberDetails. channelUrl	string آدرس کانال
snippet.memberDetails. displayName	string نام نمایشی کانال
snippet.memberDetails. profileImageUrl	string آدرس آواتار کانال.
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 تعداد ماه‌هایی که به نزدیک‌ترین عدد صحیح گرد شده و کاربر به سطح مشخص‌شده دسترسی داشته است. این مقدار تعداد ماه‌های کاملی را نشان می‌دهد که عضو به سطح دسترسی داشته است، اما این عدد به این معنا نیست که عضو به طور مداوم برای این چند ماه عضویت داشته است.