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".

ومن بين الحقول نفسها، لا يمكن استخدام عاملَي التشغيل AND أو OR في spaceType. تتوافق 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

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

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

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

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

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