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)

قائمة المساحات في الصفحة المطلوبة (أو الأولى)
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

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