Method: spaces.list

يسرد المساحات التي ينتمي إليها المتصل. لا يتم إدراج المحادثات الجماعية والرسائل المباشرة إلى أن يتم إرسال أول رسالة. للحصول على مثال، يُرجى الاطّلاع على إدراج المساحات.

تتوافق مع أنواع المصادقة التالية:

لعرض جميع المساحات المُسمّاة حسب مؤسسة Google Workspace، استخدِم طريقة spaces.search() باستخدام امتيازات مشرف Workspace بدلاً من ذلك.

طلب HTTP

GET https://chat.googleapis.com/v1/spaces

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

معامِلات طلب البحث

المعلمات
pageSize

integer

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

إذا لم يتم تحديد عدد المسافات، يتم عرض 100 مسافة كحد أقصى.

الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000.

تعرِض القيم السلبية خطأ INVALID_ARGUMENT.
pageToken

string

اختياريّ. رمز مميّز للصفحة، تم تلقّيه من استدعاء سابق لمساحات قائمة قدِّم هذه المَعلمة لاسترداد الصفحة اللاحقة.

عند تقسيم الصفحات، يجب أن تتطابق قيمة الفلتر مع الطلب الذي قدّم الرمز المميّز للصفحة. وقد يؤدي تمرير قيمة مختلفة إلى نتائج غير متوقّعة.
filter

string

اختياريّ. فلتر طلب بحث

يمكنك فلترة المساحات حسب نوع المساحة (spaceType).

للفلترة حسب نوع المساحة، يجب تحديد قيمة تعداد صالحة، مثل SPACE أو GROUP_CHAT (لا يمكن أن تكون قيمة spaceType هي SPACE_TYPE_UNSPECIFIED). لطلب البحث عن أنواع مساحات متعدّدة، استخدِم عامل التشغيل OR.

على سبيل المثال، تكون طلبات البحث التالية صالحة:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

يرفض الخادم طلبات البحث غير الصالحة ويعرض خطأ INVALID_ARGUMENT.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

ردّ على طلب قائمة المساحات

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
الحقول
spaces[]

object (Space)

قائمة المساحات في الصفحة المطلوبة (أو الأولى) ملاحظة: لا يتم عرض الحقل permissionSettings في عنصر Space لطلبات القوائم.
nextPageToken

string

يمكنك إرسال رمز مميّز كـ pageToken لاسترداد الصفحة التالية من النتائج. وإذا كان هذا الحقل فارغًا، لن تظهر أي صفحات لاحقة.

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.