Method: spaces.spaceEvents.list

הצגת אירועים ממרחבים משותפים ב-Google Chat. מטען הייעודי של כל אירוע מכיל את הגרסה האחרונה של משאב Chat. לדוגמה, אם תציגו אירועים על חברים חדשים במרחב המשותף, השרת יחזיר משאבי Membership שמכילים את פרטי החברות העדכניים ביותר. אם חברים חדשים הוסרו במהלך התקופה המבוקשת, המטען הייעודי (payload) של האירוע מכיל משאב Membership ריק.

נדרש אימות משתמש. כדי להציג את האירועים, המשתמש המאומת צריך להיות חבר במרחב המשותף.

דוגמה לכך מופיעה במאמר הצגת רשימת אירועים במרחב משותף ב-Google Chat.

בקשת HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

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

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של המרחבים המשותפים ב-Google Chat שבהם התרחשו האירועים.

פורמט: spaces/{space}

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

פרמטרים
pageSize

integer

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

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

string

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

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

string

חובה. מסנן שאילתות.

צריך לציין לפחות סוג אירוע אחד (eventType) באמצעות האופרטור has :. כדי לסנן לפי כמה סוגי אירועים, משתמשים באופרטור OR. להשמיט מסננים של סוגי אירועים של קבוצות. הבקשה מחזירה באופן אוטומטי את כל אירועי האצווה הקשורים. לדוגמה, אם מסננים לפי תגובות חדשות (google.workspace.chat.reaction.v1.created), השרת מחזיר גם אירועים של קבוצת תגובות חדשות (google.workspace.chat.reaction.v1.batchCreated). רשימה של סוגי האירועים הנתמכים מופיעה במסמכי העזרה של SpaceEvents.

אפשר גם לסנן לפי שעת ההתחלה (startTime) ושעת הסיום (endTime):

  • startTime: חותמת זמן בלעדית שממנה מתחילים לרשום אירועים במרחב המשותף. אפשר לרשום אירועים שהתרחשו עד לפני 28 יום. אם לא צוין תאריך, יוצגו אירועים במרחב המשותף מ-28 הימים האחרונים.
  • endTime: חותמת זמן מקיפה עד שתוצג רשימה של אירועים במרחב המשותף. אם לא צוין תאריך, המערכת תציג אירועים עד לזמן שליחת הבקשה.

כדי לציין זמן התחלה או זמן סיום, משתמשים באופרטור השוויון = ובפורמט RFC-3339. כדי לסנן לפי startTime וגם לפי endTime, משתמשים באופרטור AND.

לדוגמה, השאילתות הבאות תקינות:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

השאילתות הבאות לא תקינות:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה INVALID_ARGUMENT.

גוף הבקשה

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

גוף התשובה

הודעת תגובה להצגת אירועים במרחב המשותף.

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

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

object (SpaceEvent)

התוצאות מוחזרות בסדר כרונולוגי (האירוע הישן ביותר מופיע קודם). הערה: השדה permissionSettings לא מוחזר באובייקט המרחב המשותף לבקשות רשימה.
nextPageToken

string

אסימון המשך שמשמש לאחזור אירועים נוספים. אם השדה הזה לא יצוין, לא יהיו דפים נוספים.

היקפי הרשאה

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

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

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