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

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