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