Method: spaces.search

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
useAdminAccess

boolean

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

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

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

בשלב זה השיטה הזו תומכת רק בהרשאת אדמין, ולכן רק 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

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