Method: spaces.search

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

عند ضبط useAdminAccess على false، تقتصر النتائج على المساحات التي يكون فيها المستخدم الذي يطلب البيانات عضوًا منضمًا. للبحث باستخدام امتيازات المشرف، اضبط 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 .
pageSize

integer

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

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

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

string

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

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

string

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

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

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

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

  • displayName
  • externalUserAllowed
  • spaceType

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 مطلوبة والقيمة الصالحة الوحيدة هي 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" AND spaceType = "SPACE"

(displayName:"Hello" OR displayName:"Fun") AND spaceType = "SPACE"

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

(externalUserAllowed = "true" AND displayName:"Hello" AND spaceType =
"SPACE")
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:

نص الطلب

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

نص الاستجابة

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

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

تمثيل 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)

النتائج فقط. المساحة التي تم العثور عليها.