يعرض هذا القسم الأعضاء (المعروفين سابقًا باسم "الجهات الراعية") لقناة. يجب أن يصادق مالك القناة على طلب البيانات من واجهة برمجة التطبيقات.
تأثير الحصة: يتم احتساب تكلفة الحصة للمكالمة إلى هذه الطريقة من وحدتين.
الطلب
طلب 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 إلى الأعضاء الذين سيتم تضمينهم في استجابة واجهة برمجة التطبيقات. اضبط قيمة المَعلمة على إحدى القيم التالية:
|
|
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 علامة هذا المرجع. |
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 قناة. |