הצגת רשימה של אירועים ממרחב משותף ב-Google Chat. payload לכל אירוע מכיל את הגרסה העדכנית ביותר של המשאב ב-Chat. לדוגמה: אם רשימת אירועים לגבי חברים חדשים במרחב המשותף, השרת יחזיר Membership
משאבים שמכילים את פרטי החברות העדכניים ביותר. אם חברים חדשים הוסרו במהלך התקופה המבוקשת, המטען הייעודי (payload) של האירוע מכיל משאב Membership
ריק.
נדרש אימות משתמש. כדי לפרסם אירועים, המשתמש המאומת צריך להיות חבר במרחב המשותף.
לדוגמה, ראו את המאמר רשימת אירועים ממרחב משותף ב-Google Chat.
בקשת HTTP
GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף ב-Google Chat שבו התרחשו האירועים. פורמט: |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
זה שינוי אופציונלי. המספר המקסימלי של אירועי חלל שהוחזרו. השירות עשוי להחזיר פחות מהערך הזה. ערכים שליליים מחזירים שגיאה מסוג |
pageToken |
אסימון דף שהתקבל מקריאה קודמת לאירועי מרחב משותף. ספקו אותו כדי לאחזר את הדף הבא. במהלך העימוד, כל הפרמטרים האחרים שמפורטים ברשימת אירועי המרחב המשותף חייבים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות. |
filter |
חובה. מסנן שאילתות. עליך לציין סוג אירוע אחד לפחות ( אפשר גם לסנן לפי שעת התחלה (
כדי לציין שעת התחלה או שעת סיום, יש להשתמש באופרטור 'שווה ל- לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא חוקיות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
הודעת תגובה לרישום אירועים במרחב המשותף.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"spaceEvents": [
{
object ( |
שדות | |
---|---|
spaceEvents[] |
התוצאות מוחזרות בסדר כרונולוגי (האירוע הישן ביותר ראשון). |
nextPageToken |
אסימון המשך שמשמש לאחזור אירועים נוספים. אם השדה הזה יושמט, לא יהיו דפים עוקבים. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של 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
למידע נוסף, עיינו במדריך ההרשאות.