הצגת אירועים ממרחבים משותפים ב-Google Chat. מטען הייעודי של כל אירוע מכיל את הגרסה האחרונה של משאב 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 |
חובה. מסנן שאילתות. צריך לציין לפחות סוג אירוע אחד ( אפשר גם לסנן לפי שעת ההתחלה (
כדי לציין שעת התחלה או שעת סיום, צריך להשתמש באופרטור ובפורמט RFC-3339 שווים ל- לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
הודעת תגובה להצגת אירועים במרחב המשותף.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג ב-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
מידע נוסף זמין במדריך להרשאות.