Members: list

ملاحظة: لا يمكن لصنّاع المحتوى الأفراد استخدام نقطة النهاية هذه إلا لتقديم طلبات لقنواتهم على YouTube التي تم تفعيل ميزة "العضوية في القنوات" فيها. يُرجى التواصل مع ممثل Google أو YouTube لطلب إذن الوصول.

تعرض هذه الطريقة قائمة بأعضاء القناة (المعروفين سابقًا باسم "الجهات الراعية"). يجب أن يكون طلب بيانات من واجهة برمجة التطبيقات مأذونًا من مالك القناة.

تأثير الحصة: يؤدي استدعاء هذه الطريقة إلى استهلاك وحدتَين من الحصة.

طلب

طلب 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 المستخدَم مع طلب بيانات من واجهة برمجة التطبيقات الأصلي، لذا لا يمكنك استخدام رمز مميّز للصفحة تم استرداده باستخدام وضع معيّن للتبديل لاحقًا إلى وضع مختلف.
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
تحدّد نوع مرجع واجهة برمجة التطبيقات. ستكون القيمة youtube#memberListResponse.
etag etag
علامة Etag لهذا المرجع.
nextPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمَعلمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج. يمكن أن تنتهي صلاحية الرموز المميّزة للصفحات، لذا على تطبيقك إزالة الرمز المميّز واستدعاء واجهة برمجة التطبيقات بدون pageToken لبدء طلب جديد.
pageInfo object
يغلّف عنصر pageInfo معلومات تقسيم الصفحات لمجموعة النتائج.
pageInfo.totalResults integer
إجمالي عدد النتائج في مجموعة النتائج.
pageInfo.resultsPerPage integer
عدد النتائج المضمّنة في الردّ من واجهة برمجة التطبيقات.
items[] list
قائمة بالأعضاء الذين يستوفون معايير الطلب.

الأخطاء

يحدّد الجدول التالي رسائل الخطأ التي يمكن أن تعرضها واجهة برمجة التطبيقات ردًا على استدعاء هذه الطريقة. يُرجى الاطّلاع على مستندات رسائل الخطأ لمزيد من التفاصيل.

نوع الخطأ تفاصيل الخطأ الوصف
badRequest (400) channelMembershipsNotEnabled لم يتم تفعيل ميزة "العضوية في القنوات" في قناة صانع المحتوى التي تخوّل الطلب.
badRequest (400) invalidMode قيمة المَعلمة mode غير صالحة. قد يظهر هذا الخطأ إذا كانت المَعلمة pageToken تحدّد رمزًا مميّزًا تم استرداده باستخدام وضع مختلف عن الوضع المحدّد.
badRequest (400) invalidPageToken قيمة المَعلمة pageToken غير صالحة. يمكن أن يظهر هذا الخطأ إذا انتهت صلاحية الرمز المميّز للصفحة المستخدَم في الطلب أو إذا لم يتم التعرّف عليه.
badRequest (400) invalidHasAccessToLevel قيمة المَعلمة hasAccessToLevel غير صالحة. ما مِن مستوى يحمل id المحدّد.
badRequest (400) invalidFilterByMemberChannelId قيمة المَعلمة filterByMemberChannelId غير صالحة. يظهر هذا الخطأ إذا كانت قيمة المَعلمة filterByMemberChannelId تحدّد أكثر من 100 قناة.