Method: spaces.search

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

عند ضبط useAdminAccess على false، تقتصر النتائج على المساحات التي يكون فيها المستخدم الذي يجري المكالمة عضوًا منضمًا. للبحث باستخدام امتيازات المشرف، اضبط قيمة useAdminAccess على true. يتوفّر ضبط useAdminAccess على false ضمن "معاينة المطوّر".

يتيح الأنواع التالية من المصادقة:

طلب 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.

يتوفّر ضبط useAdminAccess على false ضمن "معاينة المطوّر".

pageSize

integer

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

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

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

string

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

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

string

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

يمكنك البحث باستخدام المَعلمات التالية عندما تكون قيمة useAdminAccess هي true:

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

عند ضبط useAdminAccess على false:

  • displayName
  • externalUserAllowed

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

السمة customer مطلوبة عندما تكون قيمة السمة useAdminAccess هي true، ويتم استخدامها لتحديد العميل الذي سيتم استرداد المساحات منه. القيمة الوحيدة المسموح بها هي customers/my_customer.

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

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

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

يجب إدخال قيمة spaceType عندما تكون قيمة useAdminAccess هي true، والقيمة الصالحة الوحيدة هي 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".

تكون طلبات البحث التالية صالحة عندما يتم ضبط useAdminAccess على true:

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

تكون طلبات البحث التالية صالحة عندما يتم ضبط useAdminAccess على false:

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")
orderBy

string

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

في ما يلي السمات المتوافقة التي يمكن ترتيب النتائج حسبها:

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

عندما تكون قيمة useAdminAccess هي false، لا يمكن استخدام سوى createTime وrelevance للترتيب. يُسمح فقط بالقيمة DESC لهذه الحقول في عمليات البحث التي لا يجريها المشرفون.

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

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

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

في ما يلي بنية الجملة المتوافقة عندما تكون قيمة useAdminAccess هي true:

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

عند ضبط useAdminAccess على false:

  • createTime DESC
  • relevance DESC

نص الطلب

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

نص الاستجابة

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

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

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

object (Space)

تم إيقافها نهائيًا: يُرجى استخدام الحقل الجديد results بدلاً منها. صفحة المساحات المطلوبة لن تتم تعبئة هذا الحقل إلا عندما يتم ضبط useAdminAccess على true، وسيتم إيقافه نهائيًا لصالح الحقل الجديد results.
nextPageToken

string

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

integer

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

object (SearchSpaceResult)

النتائج فقط.

قائمة بنتائج البحث التي تطابقت مع طلب البحث

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

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

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

SearchSpaceResult

تمثّل هذه السمة عنصر نتيجة واحدًا من عملية بحث في مساحة.

تمثيل JSON 
{
  "space": {
    object (Space)
  }
}
الحقول
space

object (Space)

النتائج فقط. المساحة المطابِقة