Method: spaces.search

מחזירה רשימה של מרחבים בארגון Google Workspace. דוגמה מופיעה במאמר בנושא חיפוש וניהול של חללים משותפים.

אם useAdminAccess מוגדר לערך false, התוצאות מוגבלות למרחבים שבהם המשתמש המתקשר הוא משתתף. כדי לחפש עם הרשאות אדמין, מגדירים את useAdminAccess ל-true. ההגדרה useAdminAccess ל-false זמינה במסגרת תצוגה מקדימה למפתחים.

יש תמיכה בסוגי האימות הבאים:

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
useAdminAccess

boolean

כשמגדירים את הערך true, השיטה מופעלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את השיחה צריך להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים.

נדרש היקף ההרשאות של OAuth 2.0 chat.admin.spaces.readonly או chat.admin.spaces.

ההגדרה useAdminAccess ל-false זמינה במסגרת תצוגה מקדימה למפתחים.

pageSize

integer

המספר המקסימלי של מרחבים שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה.

אם לא מציינים ערך, המערכת תחזיר עד 100 מרחבים.

הערך המקסימלי הוא 1,000. אם משתמשים בערך שגדול מ-1,000, הוא משתנה אוטומטית ל-1,000.
pageToken

string

טוקן שהתקבל מהקריאה הקודמת של search spaces. צריך להזין את הפרמטר הזה כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו צריכים להיות זהים לקריאה שסיפקה את הטוקן של הדף. העברת ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות לא צפויות.
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)

פלט בלבד. המרחב התואם.