Members: list

توجه: این نقطه پایانی را تنها سازندگان می‌توانند برای درخواست کانال YouTube خود با قابلیت عضویت در کانال استفاده کنند. برای درخواست دسترسی با نماینده Google یا YouTube خود تماس بگیرید.

فهرست اعضا (که قبلا به عنوان "حامیان مالی" شناخته می شد) برای یک کانال. درخواست API باید توسط مالک کانال مجاز باشد.

تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 2 واحدی دارد.

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/members

مجوز

این درخواست به مجوز با محدوده زیر نیاز دارد:

محدوده
https://www.googleapis.com/auth/youtube.channel-memberships.creator

مولفه های

جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.

مولفه های
پارامترهای مورد نیاز
part string
پارامتر part ویژگی های منبع member را که پاسخ API شامل می شود را مشخص می کند. مقدار پارامتر را روی snippet تنظیم کنید.
پارامترهای اختیاری
mode string
پارامتر mode نشان می دهد که کدام اعضا در پاسخ API گنجانده می شوند. مقدار پارامتر را به یکی از مقادیر زیر تنظیم کنید:
  • all_current (پیش‌فرض) - فهرست اعضای فعلی، از جدیدترین به قدیمی‌ترین. هنگامی که از این مقدار استفاده می شود، زمانی که پاسخ API حاوی nextPageToken نباشد، به انتهای لیست می رسد.
  • updates - فقط اعضایی را فهرست کنید که از تماس قبلی API به آن ملحق شده یا ارتقا یافته اند. توجه داشته باشید که اولین تماس جریان جدیدی از به روز رسانی ها را شروع می کند اما در واقع هیچ عضوی را باز نمی گرداند. برای شروع بازیابی به‌روزرسانی‌های عضویت، باید نقطه پایانی را با استفاده از nextPageToken در فرکانس مورد نظر خود نظرسنجی کنید.

    توجه داشته باشید که وقتی از این مقدار استفاده می شود، پاسخ API همیشه حاوی nextPageToken است.
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شوند را مشخص می کند. مقادیر قابل قبول شامل 0 تا 1000 است. مقدار پیش فرض 5 است.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که باید برگردانده شود. توکن مخصوص mode است که با درخواست اصلی API استفاده می‌شود، بنابراین نمی‌توانید از یک نشانه صفحه بازیابی شده با یک حالت استفاده کنید تا متعاقباً به حالت دیگری بروید.
hasAccessToLevel string
مقدار پارامتر hasAccessToLevel یک شناسه سطح است که حداقل سطحی را که اعضای مجموعه نتیجه باید داشته باشند را مشخص می کند.
filterByMemberChannelId string
پارامتر filterByMemberChannelId فهرستی از شناسه های کانال جدا شده با کاما را مشخص می کند که می تواند برای بررسی وضعیت عضویت کاربران خاص استفاده شود. به عنوان مثال، UC_1,UC_2,UC_3 . حداکثر 100 کانال در هر تماس قابل تعیین است.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

واکنش

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

خواص

جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#memberListResponse خواهد بود.
etag etag
Etag این منبع
nextPageToken string
نشانه ای که می تواند به عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود. نشانه‌های صفحه ممکن است منقضی شوند و برنامه شما باید توکن را رها کند و برای شروع درخواست جدید، API را بدون pageToken فراخوانی کند.
pageInfo object
شی pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله می‌کند.
pageInfo. totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo. resultsPerPage integer
تعداد نتایج موجود در پاسخ API.
items[] list
لیستی از اعضایی که با معیارهای درخواست مطابقت دارند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
badRequest (400) channelMembershipsNotEnabled کانال سازنده که درخواست را تأیید می کند، عضویت کانال را فعال نمی کند.
badRequest (400) invalidMode مقدار پارامتر mode نامعتبر است. اگر پارامتر pageToken نشانه ای را مشخص کند که با استفاده از حالتی متفاوت از حالت مشخص شده بازیابی شده است، این خطا ممکن است رخ دهد.
badRequest (400) invalidPageToken مقدار پارامتر pageToken نامعتبر است. اگر نشانه صفحه استفاده شده در درخواست منقضی شده باشد یا شناسایی نشود، ممکن است این خطا رخ دهد.
badRequest (400) invalidHasAccessToLevel مقدار پارامتر hasAccessToLevel نامعتبر است. هیچ سطحی با id مشخص شده وجود ندارد.
badRequest (400) invalidFilterByMemberChannelId مقدار پارامتر filterByMemberChannelId نامعتبر است. اگر مقدار پارامتر filterByMemberChannelId بیش از 100 کانال را مشخص کند این خطا رخ می دهد.