Method: spaces.list

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

تتطلب المصادقة. تتطلب مصادقة حساب الخدمة بالكامل ومصادقة المستخدم نطاق التفويض chat.spaces أو chat.spaces.readonly.

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

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

المعلّمات
pageSize

integer

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

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

الحد الأقصى للقيمة هو 1,000. إذا كنت تستخدم قيمة تزيد عن 1,000، يتم تغييرها تلقائيًا إلى 1,000.

تعرض القيم السلبية خطأ 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.

باستخدام مصادقة حساب الخدمة، يتم تجاهل هذا الحقل ويعرض طلب البحث دائمًا جميع المسافات. ومع ذلك، ستظل واجهة برمجة تطبيقات Chat تتحقّق من بنية طلب البحث باستخدام حسابات الخدمة، لذا سيتم رفض طلبات البحث غير الصالحة.

نص الطلب

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

نص الاستجابة

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

تمثيل 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

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