הפונקציה מחזירה רשימה של מרחבים בארגון Google Workspace על סמך חיפוש של אדמין. בבקשה, מגדירים את useAdminAccess ל-true. דוגמה מופיעה במאמר חיפוש וניהול של חללים.
בשלב הזה, השיטה הזו תומכת רק בגישת אדמין, ולכן רק הערך true מתקבל בשדה הזה.
pageSize
integer
המספר המקסימלי של מרחבים להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה.
אם לא מציינים מספר, המערכת מחזירה עד 100 מרחבים.
הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא משתנה אוטומטית ל-1,000.
pageToken
string
טוקן שהתקבל מהקריאה הקודמת של מרחבי החיפוש. צריך לציין את הפרמטר הזה כדי לאחזר את הדף הבא.
כשמבצעים חלוקה לעמודים, כל שאר הפרמטרים שצוינו צריכים להיות זהים לקריאה שסיפקה את טוקן הדף. העברת ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות לא צפויות.
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 — מציין את השעה שבה נוסף הפריט האחרון שעומד בדרישות לנושא כלשהו במרחב הזה.
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-08-20 (שעון UTC)."],[[["\u003cp\u003eReturns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType.\u003c/p\u003e\n"],["\u003cp\u003eRequires administrator privileges and the \u003ccode\u003euseAdminAccess\u003c/code\u003e parameter set to \u003ccode\u003etrue\u003c/code\u003e in the request.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003eGET https://chat.googleapis.com/v1/spaces:search\u003c/code\u003e HTTP request with query parameters for customization.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with either the \u003ccode\u003echat.admin.spaces\u003c/code\u003e or \u003ccode\u003echat.admin.spaces.readonly\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces.\u003c/p\u003e\n"]]],["To search for Google Workspace spaces, send a `GET` request to `https://chat.googleapis.com/v1/spaces:search`, ensuring admin privileges and setting `useAdminAccess` to `true`. Define the search using query parameters, including a required `query` to filter spaces (by `customer`, `displayName`, etc.), optional `pageSize` and `pageToken` for pagination, and optional `orderBy` for sorting. You must have one of the authorization scopes: `chat.admin.spaces` or `chat.admin.spaces.readonly`. The response will list spaces matching the query.\n"],null,[]]
