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

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