Method: spaces.spaceEvents.list

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

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

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

פורמט: spaces/{space}

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

פרמטרים
pageSize

integer

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

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

string

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

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

string

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

עליך לציין סוג אירוע אחד לפחות (eventType) באמצעות האופרטור :. כדי לסנן לפי כמה סוגי אירועים, צריך להשתמש באופרטור 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)

התוצאות מוחזרות בסדר כרונולוגי (האירוע הישן ביותר ראשון).
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

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