Method: spaces.search

boolean

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

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

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

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

integer

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

אם לא צוין, המערכת תחזיר עד 100 מקומות פנויים.

הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000.

string

טוקן, שהתקבל מהקריאה הקודמת למרחבים משותפים לחיפוש. מציינים את הפרמטר הזה כדי לאחזר את הדף הבא.

במהלך החלוקה לדפים, כל הפרמטרים האחרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות.

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")

string

זה שינוי אופציונלי. סדר הרשימה של המרחבים המשותפים.

המאפיינים הנתמכים להזמנה הם:

• membershipCount.joined_direct_human_user_count – מציין את מספר המשתמשים האנושיים שהצטרפו ישירות למרחב המשותף.
• lastActiveTime — מציין את המועד שבו נוסף הפריט האחרון שעומד בדרישות לכל נושא במרחב המשותף הזה.
• createTime — מציין את הזמן שבו נוצר המרחב המשותף.

הערכים החוקיים של פעולת ההזמנה הם:

• ASC לסדר עולה. ערך ברירת המחדל.

• DESC לעמודה בסדר יורד.

אלה תחבירי ה-JSON הנתמכים:

• membershipCount.joined_direct_human_user_count DESC
• membershipCount.joined_direct_human_user_count ASC
• lastActiveTime DESC
• lastActiveTime ASC
• createTime DESC
• createTime ASC