Method: spaces.search

عرض قائمة بالمساحات في مؤسسة Google Workspace استنادًا إلى بحث المشرف

تتطلب مصادقة المستخدم بامتيازات المشرف وأحد نطاقات التفويض التالية:

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

في الطلب، اضبط useAdminAccess على true.

طلب HTTP

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

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

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

المعلمات
useAdminAccess

boolean

عند true، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

تتطلّب إما chat.admin.spaces.readonly أو chat.admin.spaces نطاق OAuth 2.0.

لا تتيح هذه الطريقة حاليًا سوى إذن وصول المشرف، وبالتالي لا يتم قبول سوى true لهذا الحقل.
pageSize

integer

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

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

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

string

رمز مميّز تم استلامه من طلب مساحات البحث السابق قدِّم هذه المَعلمة لاسترداد الصفحة اللاحقة.

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

string

مطلوب. طلب بحث

يمكنك البحث باستخدام المَعلمات التالية:

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

تقبل السمتَان createTime وlastActiveTime طابعًا زمنيًا بتنسيق RFC-3339، وعوامل المقارنة المتوافقة هي: = و< و> و<= و>=.

يجب إدخال customer، ويتم استخدامه للإشارة إلى العميل الذي سيتم جلب المساحات منه. customers/my_customer هي القيمة الوحيدة المسموح بها.

لا تقبل الدالة displayName سوى عامل التشغيل HAS (:). يتم أولاً تقسيم النص المطلوب مطابقته إلى وحدات ترميز، ويتم مطابقة كل وحدة ترميز مع البادئة بشكل مستقل وغير حسّاس لحالة الأحرف كسلسلة فرعية في أي مكان في displayName المساحة. على سبيل المثال، يتطابق Fun Eve مع Fun event أو The evening was fun، ولكن لا يتطابق مع notFun event أو even.

يقبل externalUserAllowed إما true أو false.

لا يقبل المتغيّر spaceHistoryState سوى القيم من حقل historyState لمورد space.

‫spaceType مطلوبة والقيمة الصالحة الوحيدة هي SPACE.

في الحقول المختلفة، لا يُسمَح باستخدام عوامل التشغيل AND إلا. على سبيل المثال، spaceType = "SPACE" AND displayName:"Hello" هو مثال صالح وspaceType = "SPACE" OR displayName:"Hello" هو مثال غير صالح.

لا يتوافق عامل التشغيل spaceType مع عاملَي التشغيل AND أو OR في الحقل نفسه. لا تتيح السمات displayName و"spaceHistoryState" و"externalUserAllowed" سوى عوامل التشغيل OR. يتوافق عاملا التشغيل lastActiveTime وcreateTime مع عاملَي التشغيل AND وOR. لا يمكن استخدام AND إلا لتمثيل فاصل زمني، مثل lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

طلبات البحث التالية صالحة:

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy

string

اختياريّ. كيفية ترتيب قائمة المساحات

في ما يلي السمات المتوافقة للترتيب حسبها:

  • membershipCount.joined_direct_human_user_count: يشير إلى عدد المستخدمين الذين انضموا مباشرةً إلى مساحة.
  • lastActiveTime: يشير إلى الوقت الذي تمت فيه إضافة آخر عنصر مؤهّل إلى أي موضوع في هذه المساحة.
  • createTime: يشير إلى وقت إنشاء المساحة.

في ما يلي القيم الصالحة لعملية الترتيب:

  • ASC للترتيب التصاعدي. القيمة التلقائية

  • DESC للترتيب التنازلي.

في ما يلي بنية الجملة المتوافقة:

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

نص الطلب

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

نص الاستجابة

ردّ يتضمّن قائمة بالمساحات التي تتوافق مع طلب مساحات البحث

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

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

object (Space)

صفحة للمساحات المطلوبة
nextPageToken

string

رمز مميّز يمكن استخدامه لاسترداد الصفحة التالية. إذا كان هذا الحقل فارغًا، يعني ذلك أنّه ما مِن صفحات لاحقة.
totalSize

integer

إجمالي عدد المساحات التي تتطابق مع طلب البحث في جميع الصفحات إذا كانت النتيجة أكثر من 10,000 مساحة، تكون هذه القيمة تقديرية.

نطاقات التفويض

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

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

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