Method: spaces.search

تعرض هذه الطريقة قائمة بالمساحات في مؤسسة Google Workspace استنادًا إلى عملية بحث يجريها المشرف. في الطلب، اضبط قيمة useAdminAccess على true. للاطّلاع على مثال، يُرجى الانتقال إلى البحث عن المساحات وإدارتها.

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

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

طلب HTTP

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

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

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

المعلمات
useAdminAccess

boolean

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

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

يتطلّب ذلك نطاق OAuth 2.0 chat.admin.spaces.readonly أو chat.admin.spaces.

لا تتيح هذه الطريقة حاليًا سوى الوصول الإداري، وبالتالي لا يتم قبول سوى 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

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