Method: spaces.search

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

נדרש אימות משתמש עם הרשאות אדמין ואחד מהיקפי ההרשאות הבאים:

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

בקשת 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.

בשלב הזה, השיטה הזו תומכת רק בגישת אדמין, ולכן רק הערך true מתקבל בשדה הזה.
pageSize

integer

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

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

הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא משתנה אוטומטית ל-1,000.
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

מידע נוסף זמין במדריך ההרשאות.