Method: spaces.search

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

נדרשת אימות משתמש עם הרשאות אדמין. בבקשה, מגדירים את useAdminAccess כ-true.

בקשת HTTP

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

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

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

פרמטרים
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

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