Members: list

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

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

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

درخواست

درخواست HTTP

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

صدور مجوز

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

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

پارامترها

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

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

    توجه داشته باشید که وقتی از این مقدار استفاده می‌شود، پاسخ میانای برنامه‌سازی کاربردی همیشه حاوی 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. حداکثر ۱۰۰ کانال را می‌توان در هر تماس مشخص کرد.

متن درخواست

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

پاسخ

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

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

مشخصات

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

مشخصات
kind string
نوع منبع میانای برنامه‌سازی کاربردی را مشخص می‌کند. مقدار youtube#memberListResponse خواهد بود.
etag etag
‫Etag این منبع.
nextPageToken string
نشانه‌ای که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود. رموز صفحه ممکن است منقضی شوند و برنامه شما باید رمز را حذف کند و API را بدون pageToken فراخوانی کند تا درخواست جدیدی را شروع کند.
pageInfo object
شیء pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله می‌کند.
pageInfo.totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo.resultsPerPage integer
تعداد نتایج موجود در پاسخ میانای برنامه‌سازی کاربردی.
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 بیش‌از ۱۰۰ کانال را مشخص کند.