Method: spaces.search

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

طلب HTTP

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

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

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

المعلمات
useAdminAccess

boolean

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

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

يتطلب نطاق 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

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