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 قناة.