Method: spaces.findGroupChats

מחזירה את כל החללים עם spaceType == GROUP_CHAT, שהחברות האנושיות שלהם כוללות בדיוק את המשתמש שקורא לפונקציה, ואת המשתמשים שצוינו ב-FindGroupChatsRequest.users. דוגמה מופיעה במאמר חיפוש צ'אטים קבוצתיים.

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

קבוצת המשתמשים שצוינה צריכה להכיל רק חברים שהם בני אדם (לא אפליקציות). בקשה שמכילה משתמשים שהם לא בני אדם לא מחזירה מרחבים.

נדרש אימות משתמש עם אחת מהרשאות הגישה הבאות:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

בקשת HTTP

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

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

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

פרמטרים
user[]
(deprecated)

string

אופציונלי. הוצא משימוש: במקומו, צריך להשתמש בשדה users.

שמות המשאבים של כל המשתמשים האנושיים בצ'אט הקבוצתי עם המשתמש המתקשר. אי אפשר לכלול אפליקציות צ'אט בבקשה.

המספר המקסימלי של משתמשים שאפשר לציין בבקשה אחת הוא 49.

פורמט: users/{user}, כאשר {user} הוא id של האדם מ-People API, או id של המשתמש מ-Directory API. לדוגמה, כדי למצוא את כל הצ'אטים הקבוצתיים עם המשתמש המתקשר ושני משתמשים נוספים, עם מזהי הפרופיל ב-People API ‏123456789 ו-987654321, אפשר להשתמש ב-users/123456789 וב-users/987654321. אפשר גם להשתמש בכתובת האימייל ככתובת חלופית לכתובת {user}. לדוגמה, users/example@gmail.com כאשר example@gmail.com היא כתובת האימייל של המשתמש ב-Google Chat.
users[]

string

אופציונלי. שמות המשאבים של כל המשתמשים האנושיים בצ'אט הקבוצתי עם המשתמש המתקשר. אי אפשר לכלול אפליקציות צ'אט בבקשה.

המספר המקסימלי של משתמשים שאפשר לציין בבקשה אחת הוא 49.

פורמט: users/{user}, כאשר {user} הוא id של האדם מ-People API, או id של המשתמש מ-Directory API. לדוגמה, כדי למצוא את כל הצ'אטים הקבוצתיים עם המשתמש המתקשר ושני משתמשים נוספים, עם מזהי הפרופיל ב-People API ‏123456789 ו-987654321, אפשר להשתמש ב-users/123456789 וב-users/987654321. אפשר גם להשתמש בכתובת האימייל ככתובת חלופית לכתובת {user}. לדוגמה, users/example@gmail.com כאשר example@gmail.com היא כתובת האימייל של המשתמש ב-Google Chat.
pageSize

integer

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

אם לא מציינים ערך, המערכת מחזירה עד 100 מרחבים.

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

ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
pageToken

string

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

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

enum (SpaceView)

סוג התצוגה המבוקש של המרחב. אם לא מגדירים ערך, ברירת המחדל היא SPACE_VIEW_RESOURCE_NAME_ONLY. בקשות שמציינות את SPACE_VIEW_EXPANDED צריכות לכלול היקפי הרשאות שמאפשרים לקרוא נתונים של מרחבים, למשל https://www.googleapis.com/auth/chat.spaces או https://www.googleapis.com/auth/chat.spaces.readonly.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

תשובה שמכילה מרחבים של צ'אט קבוצתי עם המשתמש שמתקשר בדיוק והמשתמשים המבוקשים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
שדות
spaces[]

object (Space)

רשימת המרחבים בדף המבוקש (או בדף הראשון).
nextPageToken

string

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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

SpaceView

תצוגה שמציינת אילו שדות צריכים להיות מאוכלסים במשאב Space. כדי להבטיח תאימות לגרסאות עתידיות, מומלץ שהקוד יתייחס לערכים נוספים.

טיפוסים בני מנייה (enum)
SPACE_VIEW_UNSPECIFIED ערך ברירת המחדל או הערך שלא הוגדר.
SPACE_VIEW_RESOURCE_NAME_ONLY מאכלס רק את שם המשאב של המרחב.
SPACE_VIEW_EXPANDED מאכלס את השדות של משאב המרחב. הערה: השדה permissionSettings לא יאוכלס. בקשות שמציינות SPACE_VIEW_EXPANDED צריכות לכלול היקפי הרשאות שמאפשרים לקרוא נתונים של מרחבים, לדוגמה, https://www.googleapis.com/auth/chat.spaces או https://www.googleapis.com/auth/chat.spaces.readonly.