אובייקטים של אירוע

בדף הזה מפורט מבנה האובייקטים של האירועים של התוספים ל-Google Workspace.

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

תוספים ל-Google Workspace משתמשים באובייקטים של אירועים במקומות הבאים:

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

  האובייקטים של האירועים שנוצרים כשההפעלה של דף הבית מופעלת לא מכילים את כל בשדות שכלולים בשני המקרים האחרים; שדות שקשורים לווידג'טים חסרים פרטים לפי ההקשר.

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

  • Gmail מספק טריגר לפי הקשר כשהמשתמש פותחים הודעה ועוד כאשר משתמש כותב הודעה.
  • יומן Google מספק טריגר לפי הקשר כשהמשתמש פותחים אירוע.
  • Google Drive מספק טריגר לפי הקשר כשהמשתמש בוחר קובצי Drive.

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

• פעולות ווידג'ט. אובייקטים של אירוע משמשים גם לאספקת ווידג'ט אינטראקטיביות, באמצעות מודל פעולה שתוספים ל-Gmail לשימוש. לתוספים של Google Workspace משתמשים בכל אותן הפונקציות של ה-handler של הווידג'טים, Action אובייקטים ופעולה תשובות מדויקות. אבל, בתוספים ל-Google Workspace, אובייקטים של אירועי פעולה כוללים מידע רב יותר שפונקציית קריאה חוזרת יכולה לפעול.

  אובייקטי האירוע שנוצרו כתוצאה מפעולות בווידג'ט מכילים את כל שדות הכלולים באובייקטים של אירוע טריגר לפי הקשר, וגם שדות שמכילים פרטי הווידג'ט.

• תצוגה מקדימה של טריגרים עבור קישורים. ב-Google Docs , Sheets ו-Slides אפשר להגדיר תצוגה מקדימה לקישורים של שירותי צד שלישי על סמך תבניות URL ספציפיות. כשמשתמשים מקיימים אינטראקציה עם קישור את הדפוס, linkPreviewTriggers ואובייקט אירוע שמכיל את הקישור מועבר אל של פונקציית קריאה חוזרת. התוסף יכול להשתמש באובייקט האירוע הזה כדי ליצור צ'יפ חכם וכרטיס שמציגים מידע על הקישור בתוך המארח תרגום מכונה. אפשר גם ליצור פעולות לווידג'ט כדי לאפשר למשתמשים ליצור איתם אינטראקציה כרטיס התצוגה המקדימה והתוכן שלו.

מבנה האובייקטים של האירוע

הטבלה הבאה מתארת את המבנה ברמה העליונה של אובייקטים של אירוע מסוג תוספים ל-Google Workspace. האירוע מבנה האובייקט כולל commonEventObject בשדה ברמה העליונה למידע שאינו תלוי במארח. כל אובייקט של אירוע יכול גם כוללים אחד מהשדות ברמה העליונה שספציפיים למארח, שנקבע לפי אפליקציה מארחת פעילה: gmailEventObject, calendarEventObject או driveEventObject.

לתאימות לאחור, תוספים של Google Workspace אובייקטי אירוע כוללים גם את כל השדות המקוריים שנעשה בהם שימוש אובייקטים של אירועים לפעולה בתוסף Gmail. השדות האלה מפורטים בטבלה שלמטה בקטע 'שדות מקוריים של תוספי Gmail'. המידע בשדות האלה משוחזר במבנה אובייקט חדש.

אובייקט אירוע נפוץ

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

בנוסף לטריגרים לדף הבית ולטריגרים לפי הקשר, התוספים בונים ומעבירים אובייקטים של אירוע לפונקציות קריאה לפעולה (callback) כשהמשתמש מקיים אינטראקציה עם ווידג'טים. פונקציית הקריאה החוזרת של התוסף יכולה לשלוח שאילתה אובייקט האירוע המשותף כדי לקבוע את התוכן של ווידג'טים פתוחים הלקוח. לדוגמה, התוסף יכול לאתר את הטקסט שמשתמש הזין הווידג'ט TextInput ב אובייקט eventObject.commentEventObject.formInputs.

קלטים בטופס לבחירת תאריך ושעה

פונקציות קריאה חוזרת (callback) יכול לקבל את ערכי הווידג'ט הנוכחיים בשדה commonEventObject.formInputs. המידע הזה כולל את ערכי התאריך או השעה שהמשתמש בוחר בחלונית לבחירת תאריך או שעה הווידג'טים האלה. עם זאת, מבנה המידע משתנה בהתאם הווידג'ט הוגדר כבורר תאריך ושעה, חלונית לבחירת תאריך בלבד או כלי של שעה בלבד בוחר. ההבדלים המבניים מתוארים בטבלה הבאה:

אובייקט של אירוע ביומן

אובייקט האירוע ביומן הוא החלק מתוך האובייקט הכולל של האירוע כולל מידע על האירועים ביומן והאירועים ביומן של המשתמש. זה רק קיים באובייקט אירוע אם האפליקציה המארחת היא יומן Google.

בטבלה הבאה מפורטים השדות שנמצאים ברכיב calendarEventObject בשדה של אובייקט האירוע. שדות שמסומנים כנתונים שנוצרו על ידי משתמשים הם קיים באובייקט האירוע רק אם הנתונים נמצאים ביומן. אירוע והתוסף מגדיר את addOns.calendar.currentEventAccess שלו מניפסט שדה ל READ או READ_WRITE.

משתתפ/ת

האובייקטים של המשתתפים נושאים ביומן Google מידע על המשתתפים השונים אירועים. המידע הזה יופיע באובייקט האירוע אך ורק אם הנתונים מופיע באירוע ביומן, והתוסף מגדיר addOns.calendar.currentEventAccess מניפסט שדה ל READ או READ_WRITE.

נתוני שיחת הוועידה

האובייקטים של נתוני שיחת הוועידה נושאים מידע על שיחות הוועידה שמצורף. לאירועים ביומן Google. אלה יכולים להיות פתרונות לשיחות ועידה של Google, כמו Google Meet או שיחות ועידה של צד שלישי. המידע הזה נמצא אובייקט של אירוע ביומן רק אם הנתונים קיימים באירוע ביומן התוסף מגדיר את addOns.calendar.currentEventAccess שלו מניפסט שדה ל READ או READ_WRITE.

נקודת כניסה

אובייקטים של נקודת כניסה נושאים מידע על אמצעי הגישה הקיימים שיחת ועידה מסוימת, למשל בטלפון או בווידאו. המידע הזה נמצא ב אובייקט האירוע רק אם הנתונים קיימים באירוע ביומן התוסף מגדיר את addOns.calendar.currentEventAccess שלו מניפסט שדה ל READ או READ_WRITE.

אובייקט של אירוע ב-Drive

אובייקט האירוע ב-Drive הוא החלק מתוך אובייקט האירוע הכולל כולל מידע על Google Drive של המשתמש ועל התוכן שלו. זה רק קיימים באובייקט אירוע אם האפליקציה המארחת היא Google Drive.

פריט ב-Drive

אובייקטים של פריט ב-Drive נושאים מידע על פריטים ספציפיים ב-Drive, כמו קבצים או תיקיות.

אובייקט של אירוע ב-Gmail

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

אובייקט אירוע ב-Docs

אובייקט האירוע של Docs הוא החלק מתוך אובייקט האירוע הכולל שנושא את האובייקט מידע על המסמך של המשתמש ועל התוכן שלו. נמצא רק אובייקט של אירוע אם האפליקציה המארחת היא Google Docs.

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

אובייקט אירוע ב-Sheets

אובייקט האירוע של Sheets הוא החלק מתוך אובייקט האירוע הכולל שנושא את האובייקט מידע על המסמך של המשתמש ועל התוכן שלו. נמצא רק אובייקט של אירוע אם האפליקציה המארחת היא Google Sheets.

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

אובייקט אירוע ב-Slides

אובייקט האירוע של Slides הוא החלק מתוך אובייקט האירוע הכולל שנושא את האובייקט מידע על המסמך של המשתמש ועל התוכן שלו. נמצא רק אובייקט של אירוע אם האפליקציה המארחת היא Google Slides.

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}