Method: spaces.spaceEvents.list

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

תומך בסוגי אימות הבאים עם היקף הרשאות שמתאים לקריאת הנתונים המבוקשים:

  • אימות אפליקציות עם אישור אדמין בגרסת Developer Preview עם אחת מהרשאות הגישה הבאות:

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

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

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

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

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

פורמט: spaces/{space}

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

פרמטרים
pageSize

integer

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

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

string

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

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-list space events חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף. העברת ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות לא צפויות.
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.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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

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