נדרש היקף 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 – מציין את השעה שבה הפריט האחרון שעומד בדרישות מתווסף לנושא כלשהו במרחב המשותף.
[[["התוכן קל להבנה","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-02-27 (שעון UTC)."],[[["Returns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType."],["Requires administrator privileges and the `useAdminAccess` parameter set to `true` in the request."],["Utilizes the `GET https://chat.googleapis.com/v1/spaces:search` HTTP request with query parameters for customization."],["Needs authorization with either the `chat.admin.spaces` or `chat.admin.spaces.readonly` OAuth scope."],["Response body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces."]]],["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"]]
