Method: spaces.list

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

يتطلب المصادقة. يتوافق مع مصادقة التطبيقات ومصادقة المستخدم.

يسرد المساحات المرئية للمتصل أو المستخدم الذي تمت مصادقته. ولا يتم إدراج المحادثات الجماعية والرسائل المباشرة حتى يتم إرسال الرسالة الأولى.

طلب 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

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