איך עובדים עם אירועים מ-Google Chat

בדף הזה נסביר איך אפליקציות Google Chat יכולות לקבל אירועים ב-Google Chat ולהגיב עליהם.

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

ריכזנו כאן כמה דוגמאות לאופן שבו אפשר להשתמש באירועים:

  • לעקוב אחרי הודעות חדשות במרחב המשותף ולהגיב עליהן, למשל לחפש מילות מפתח או ביטויי מפתח.
  • אפשר לשלוח הודעת פתיחה למשתמשים כשהם מצטרפים למרחב המשותף, להסביר את ההנחיות של המרחב המשותף או לשתף טיפים לגבי שימוש יעיל באפליקציית Chat.
  • לעקוב אחרי הפעילות ב-Chat ולנתח אותה. לדוגמה, כדי לשלוח דוח חודשי על חברים חדשים או על ההודעות שקיבלו הכי הרבה תגובות או תשובות.
  • אפשר לתקשר בין פלטפורמות שונות של העברת הודעות. לדוגמה, משתמשים יכולים לשלוח ולקבל הודעות ממשתמשים מפלטפורמה אחרת להעברת הודעות, בלי לצאת מ-Chat.

הסבר על אירועים

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

האירועים ב-Chat מחולקים לקטגוריות לפי סוג. סוגי אירועים עוזרים לסנן ולבקש רק את סוג המידע שאתם צריכים, ומאפשרים לכם לטפל באירועים דומים באותו אופן.

בטבלה הבאה אפשר לראות איך פעילות ב-Chat משפיעה על משאב קשור של Chat API, ומהו סוג האירוע שמקבלת אפליקציית Chat:

פעילות משאב של Chat API סוג האירוע
משתמש מפרסם הודעה במרחב המשותף Chat נוצר משאב של Message. הודעה חדשה
משתמש הופך למנהל/ת של המרחב המשותף. משאב של Membership מתעדכן. המינוי עודכן
משתמש מגיב להודעה. נוצר משאב של Reaction. תגובה חדשה
משתמש עוזב מרחב משותף. משאב של Membership נמחק. המינוי נמחק

קבלת אירועים מ-Google Chat

כדי לקבל אירועים, אפליקציית Chat יכולה:

  • הרשמה לאירועים באמצעות Google Workspace Event API מאפשרת לכם לקבל אירועים בזמן שהם מתרחשים.
  • הרצת שאילתות על אירועים באמצעות קריאה ל-Chat API.

Google Workspace Event API ו-Chat API תומכים ומספקים את אותם סוגי אירועים. כדי לדעת אם כדאי להירשם לאירועים או לשלוח שאילתות לגבי אירועים, כדאי לעיין בטבלה הבאה:

הרשמה לאירועים שאילתה לאירועים
תרחישים לדוגמה
  • לעבד אירועים או להשיב להם בזמן אמת.
  • מעקב אחר פעילות החברים בקהל ומציאת מרחבים משותפים חדשים שאפשר לעקוב אחריהם.
  • מעבדים או משיבים לאירועים מדי פעם, או באמצעות טריגר.
  • אחזור אירועים שהוחמצו ממינוי (עקב הפסקה זמנית בשירות או מינוי לא פעיל).
API Google Workspace Events API Chat API
מקור האירועים מרחבים משותפים ומשתמשים מרחבים משותפים בלבד
פורמט האירוע הודעת Google Cloud Pub/Sub, בפורמט שתואם למפרט של CloudEvent. לפרטים נוספים אפשר לעיין במאמר מבנה האירועים ב-Google Workspace. משאב של Chat API ( spaces.spaceEvent)
נתוני אירוע מחרוזת בקידוד Base64 עם או בלי נתוני משאב. לדוגמה, מטענים ייעודיים (payloads) זמינים בקטע נתוני אירועים. מטען ייעודי (payload) של JSON שמכיל נתוני משאבים. יש סוגי אירועים שכוללים רק שדות מסוימים של משאבים. לדוגמה, מטענים ייעודיים (payloads) זמינים במסמכי התיעוד של SpaceEvents.

למידע נוסף על יצירת מינויים באמצעות Google Workspace Event API, תוכלו לעיין במשאבי העזרה של Google Workspace Event API. כדי לשלוח שאילתות על אירועים באמצעות Chat API, תוכלו להיעזר במדריכים הבאים:

הגבלות

  • במינויים למשתמשים, אירועים על חברים חדשים בצ'אטים אישיים או בצ'אטים קבוצתיים ללא שם (google.workspace.chat.membership.v1.created), מופעלים רק אחרי פרסום ההודעה הראשונה.
  • אם משנים את ההיסטוריה של המרחב המשותף, המערכת לא מפעילה אירועים מעודכנים במרחב המשותף (סוג האירוע: google.workspace.chat.spaces.v1.updated).
  • כדי לקבל אירועים של חברות, המשתמש צריך להיות חבר ישיר במרחב המשותף. אם משתמש נוסף, עודכן או הוסר באופן עקיף למרחב משותף באמצעות קבוצת Google, המינוי לא מקבל את אירועי החברות האלה. במאמר איך מוסיפים קבוצות של קבוצות Google למרחבים משותפים מוסבר איך זה עובד.