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

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

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

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

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

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

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

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

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

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

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

מבנה אובייקט האירוע

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

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

אובייקט האירוע
eventObject.commonEventObject Common fields object
אובייקט שמכיל מידע המשותף לכל האובייקטים של האירוע, ללא קשר לאפליקציה המארחת.
eventObject.calendar Calendar event object
מוצג רק אם המארח שמתקשר הוא יומן Google. אובייקט שמכיל מידע על היומן ועל האירוע.
eventObject.drive Drive event object
מוצג רק אם המארח המתקשר הוא Google Drive. אובייקט שמכיל מידע מ-Drive.
eventObject.gmail Gmail event object
מוצג רק אם המארח שמתקשר הוא Gmail. אובייקט שמכיל מידע על Gmail.
eventObject.docs Docs event object
מוצג רק אם המארח המתקשר הוא Google Docs. אובייקט שמכיל מידע מ-Docs.
eventObject.sheets Sheets event object
מוצג רק אם המארח המתקשר הוא Google Sheets. אובייקט שמכיל מידע ב-Sheets.
eventObject.slides Slides event object
מוצג רק אם המארח המתקשר הוא Google Slides. אובייקט שמכיל מידע מ-Slides.
השדות המקוריים של התוספים ל-Gmail
eventObject.messageMetadata.accessToken string
הוצא משימוש. אסימון גישה. אפשר להשתמש באפשרות הזו כדי להפעיל גישה לנתוני משתמשים באמצעות היקפים זמניים של תוספים ל-Gmail.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
הוצא משימוש. מזהה ההודעה של השרשור נפתח בממשק המשתמש של Gmail.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.gmail.messageId.

eventObject.clientPlatform string
הוצא משימוש. מציין את מקור האירוע (אתר, iOS או Android).

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.commonEventObject.platform.

eventObject.formInput object
הוצא משימוש. מפה של הערכים הנוכחיים של כל הווידג'טים של הטופס בכרטיס, שמוגבלים לערך אחד לכל ווידג'ט. המפתחות הם מזהי המחרוזות המשויכים לווידג'טים, והערכים הם מחרוזות. אובייקט האירוע מספק את formInput כאמצעי נוחות כשרוצים לקרוא נתונים מכמה ווידג'טים עם ערכי יחיד צפויים, כמו קלט של טקסט ומתגים. בווידג'טים בעלי ערכים מרובים, כמו תיבות סימון, אפשר לקרוא כל ערך מ-formInputs במקום זאת.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.commonEventObject.formInputs במקום זאת. ווידג'טים עם ערכים בודדים מיוצגים כמערכי נתונים עם רכיב אחד.

eventObject.formInputs object
הוצא משימוש. מפה של הערכים הנוכחיים של הווידג'טים בכרטיס, שמוצגת כרשימות של מחרוזות. המפתחות הם מזהי המחרוזות המשויכים לווידג'ט. לווידג'טים בעלי ערך יחיד, הערך מוצג במערך של רכיב יחיד. בווידג'טים בעלי ערכים מרובים, כמו קבוצות של תיבות סימון, כל הערכים מוצגים ברשימה.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.commonEventObject.formInputs.

eventObject.parameters object
הוצא משימוש. מפה של כל הפרמטרים הנוספים שסיפקת ל- Action באמצעות Action.setParameters(). המפתחות והערכים של המפה הם מחרוזות.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.commonEventObject.parameters.

eventObject.userCountry string
הוצאה משימוש והושבתה כברירת מחדל. קוד בן שתי אותיות המציין את המדינה או האזור של המשתמש. הוא יכול גם להיות קוד מדינה מספרי מסוג UN M49.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.commonEventObject.userLocale.

eventObject.userLocale string
הוצאה משימוש והושבתה כברירת מחדל. קוד ISO 639 בן שתי אותיות המציין את שפת המשתמש. פרטים נוספים זמינים במאמר גישה ללוקאל ולאזור הזמן של המשתמש.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
הוצאה משימוש והושבתה כברירת מחדל. מזהה אזור הזמן של אזור הזמן של המשתמש. לדוגמה: America/New_York, Europe/Vienna ו-Asia/Seoul. לפרטים נוספים, אפשר לעיין במאמר גישה למיקום ולאזור הזמן של המשתמש.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
הוצאה משימוש והושבתה כברירת מחדל. הפרש הזמן מזמן אוניברסלי מתואם (UTC) של אזור הזמן של המשתמש, שנמדד באלפיות שנייה. לפרטים נוספים, אפשר לעיין במאמר גישה למיקום ולאזור הזמן של המשתמש.

לגבי תוספים ל-Google Workspace, אפשר למצוא את המידע הזה בשדה eventObject.commonEventObject.timeZone.offset.

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

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

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

שדות אובייקטים של אירועים נפוצים
commonEventObject.platform string
ציון המיקום שממנו הגיע האירוע (`WEB`, `IOS` או `ANDROID`).
commonEventObject.formInputs object
מפה שמכילה את הערכים הנוכחיים של הווידג'טים בכרטיס שמוצג. מפתחות המפה הם מזהי המחרוזות שמוקצים לכל ווידג'ט.

המבנה של האובייקט של ערך המפה תלוי בסוג הווידג'ט:

  • ווידג'טים עם ערך יחיד (לדוגמה, תיבת טקסט): רשימת מחרוזות (רכיב אחד בלבד).

    דוגמה: לווידג'ט של קלט טקסט שהמזהה שלו הוא employeeName, יש לגשת לערך של קלט הטקסט באמצעות e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • ווידג'טים בעלי ערכים מרובים (לדוגמה, קבוצות של תיבות סימון): רשימה של מחרוזות.

    דוגמה: לווידג'ט מרובה ערכים שהמזהה שלו הוא participants, צריך לגשת למערך הערכים באמצעות: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: DateTimeInput object.

    דוגמה: עבור בורר עם המזהה myDTPicker, ניגשים לאובייקט DateTimeInput באמצעות e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: DateInput object.

    דוגמה: לבורר עם המזהה myDatePicker, ניגשים לאובייקט DateInput באמצעות e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: TimeInput object.

    דוגמה: לבורר עם המזהה myTimePicker, ניגשים לאובייקט TimeInput באמצעות e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
מציין את האפליקציה המארחת שהתוסף פעיל בה כשאובייקט האירוע נוצר. דוגמאות לערכים אפשריים:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
פרמטרים נוספים שתספקו ל- Action באמצעות Action.setParameters().
commonEventObject.userLocale string
מושבת כברירת מחדל. מזהה השפה והמדינה/האזור של המשתמש בפורמט של קוד שפה ISO 639 – קוד מדינה/אזור לפי ISO 3166. לדוגמה, en-US

כדי להפעיל את השדה הזה, עליך להגדיר את addOns.common.useLocaleFromApp לערך true במניפסט של התוסף. רשימת ההיקפים של התוספים חייבת לכלול גם את https://www.googleapis.com/auth/script.locale. פרטים נוספים זמינים במאמר גישה למיקום ולאזור הזמן של המשתמש.

commonEventObject.timeZone string
מושבת כברירת מחדל. המזהה והקיזוז של אזור הזמן. כדי להפעיל את השדה הזה, יש להגדיר את addOns.common.useLocaleFromApp לערך true במניפסט של התוסף. רשימת ההיקפים של התוספים חייבת לכלול גם את https://www.googleapis.com/auth/script.locale. פרטים נוספים זמינים במאמר גישה למיקום ולאזור הזמן של המשתמש.
commonEventObject.timeZone.id string
מזהה אזור הזמן של אזור הזמן של המשתמש. לדוגמה: America/New_York, Europe/Vienna ו-Asia/Seoul. כדי להפעיל את השדה הזה, יש להגדיר את addOns.common.useLocaleFromApp לערך true במניפסט של התוסף. רשימת ההיקפים של התוספים חייבת לכלול גם את https://www.googleapis.com/auth/script.locale. לפרטים נוספים, אפשר לעיין במאמר גישה למיקום ולאזור הזמן של המשתמש.
commonEventObject.timeZone.offset string
הפרש הזמן בין שעון אוניברסלי מתואם (UTC) של אזור הזמן של המשתמש, שנמדד באלפיות שנייה. לפרטים נוספים, אפשר לעיין במאמר גישה למיקום ולאזור הזמן של המשתמש.

קלט לחלונית לבחירת תאריך ושעה

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

אובייקט DateTimeinput קלט
dateTimeInput.hasDate boolean
true אם התאריך והשעה שהוזנו כוללים תאריך, אם הטבלה false כוללת רק שעה.
dateTimeInput.hasTime boolean
true אם התאריך והשעה שהוזנו כוללים שעה; אם הערך בשדה false הוא רק תאריך.
dateTimeInput.msSinceEpoch string
הזמן שנבחר על ידי המשתמש, באלפיות השנייה מאז תחילת התקופה (00:00:00 UTC ב-1 בינואר 1970).
אובייקט תאריך קלט
dateInput.msSinceEpoch string
הזמן שנבחר על ידי המשתמש, באלפיות השנייה מאז תחילת התקופה (00:00:00 UTC ב-1 בינואר 1970).
אובייקט קלט זמן
timeInput.hours number
מספר השעות שהמשתמש בחר.
timeInput.minutes number
מספר הדקות שנבחר על ידי המשתמש.

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

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

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

אובייקט של אירוע ביומן
calendar.attendees[] list of attendee objects
נתונים שנוצרו על ידי משתמשים. רשימת המשתתפים באירוע שביומן.
calendar.calendarId string
מזהה היומן.
calendar.capabilities object
נתונים שנוצרו על ידי משתמשים. אובייקט שמתאר את היכולות של התוסף להציג או לעדכן פרטי אירוע.
calendar.capabilities.canAddAttendees boolean
נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול להוסיף משתתפים חדשים לרשימת המשתתפים באירוע, false אחרת.
calendar.capabilities.canSeeAttendees boolean
נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול לקרוא את רשימת המשתתפים באירוע; false אחרת.
calendar.capabilities.canSeeConferenceData boolean
נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול לקרוא את הנתונים של שיחת הוועידה באירוע, false אחרת.
calendar.capabilities.canSetConferenceData boolean
נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול לעדכן את הנתונים של שיחת הוועידה באירוע; false אחרת.
calendar.capabilities.canAddAttachments boolean
נתונים שנוצרו על ידי משתמשים. true אם התוסף יכול לצרף קבצים חדשים לאירוע, false אחרת.
calendar.conferenceData Conference data object
נתונים שנוצרו על ידי משתמשים. אובייקט שמייצג נתונים של שיחת ועידה שמשויכים לאירוע הזה, כמו פרטי שיחת הוועידה ב-Google Meet.
calendar.id string
מזהה האירוע.
calendar.organizer object
אובייקט שמייצג את מארגן האירוע.
calendar.organizer.email string
כתובת האימייל של מארגן האירוע.
calendar.recurringEventId string
המזהה של אירוע חוזר.

משתתף

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

אובייקט משתתף
attendee.additionalGuests number
מספר האורחים הנוספים שהמשתתף ציין שהם להביא. ברירת המחדל היא אפס.
attendee.comment string
תגובת המשתתף, אם יש כזו.
attendee.displayName string
השם המוצג של המשתתף.
attendee.email string
כתובת האימייל של המשתתף.
attendee.optional boolean
true אם ההשתתפות של המשתתף הזה מסומנת כאופציונלית. אחרת, false.
attendee.organizer boolean
true אם המשתתף הוא מארגן האירוע.
attendee.resource boolean
true אם המשתתף מייצג משאב, כמו חדר או ציוד, false אחרת.
attendee.responseStatus string
סטטוס התגובה של המשתתף. דוגמאות לערכים אפשריים:
  • accepted: המשתתף אישר את ההזמנה לאירוע.
  • declined: המשתתף דחה את ההזמנה לאירוע.
  • needsAction: מי שהזמנת לא השיב להזמנה לאירוע.
  • tentative: המשתתף אישר את ההזמנה לאירוע באופן לא סופי.
attendee.self boolean
true אם המשתתף הזה מייצג את היומן שבו האירוע מופיע. אחרת, false.

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

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

אובייקט של נתוני שיחת הוועידה
conferenceData.conferenceId string
מזהה שיחת הוועידה. המזהה הזה נועד לאפשר לאפליקציות לעקוב אחר שיחות ועידה. לא מומלץ להציג את המזהה הזה למשתמשים.
conferenceData.conferenceSolution object
אובייקט שמייצג את פתרון שיחת הוועידה, כמו Hangouts או Google Meet.
conferenceData.conferenceSolution.iconUri string
ה-URI של הסמל הגלוי למשתמש שמייצג את פתרון שיחת הוועידה הזה.
conferenceData.conferenceSolution.key object
המפתח שמזהה באופן ייחודי את פתרון שיחות הוועידה לאירוע הזה.
conferenceData.conferenceSolution.key.type string
סוג הפתרון לשיחות ועידה. דוגמאות לערכים אפשריים:
  • eventHangout ל-Hangouts לצרכנים (http://hangouts.google.com).
  • eventNamedHangout בגרסה הקלאסית של Hangouts למשתמשי Google Workspace (http://hangouts.google.com).
  • hangoutsMeet ל-Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
השם של פתרון שיחת הוועידה הזה (לא מותאם לשוק המקומי).
conferenceData.entryPoints[] list of entry point objects
רשימת נקודות הכניסה לשיחת הוועידה, כמו כתובות URL או מספרי טלפון.
conferenceData.notes string
הערות נוספות (כמו הוראות ממנהל הדומיין או הודעות משפטיות) לגבי שיחת הוועידה שצריך להציג למשתמש. יכול להכיל HTML. האורך המקסימלי הוא 2,048 תווים.
conferenceData.parameters object
אובייקט שמכיל מפה של נתוני פרמטרים מוגדרים לשימוש על ידי התוסף.
conferenceData.parameters.addOnParameters object
מפה של מפתחות וערכים למחרוזות פרמטרים. המפתחות והערכים האלה מוגדרים על ידי מפתח התוסף כדי לצרף מידע לשיחת ועידה ספציפית שבה רוצים להשתמש בתוסף.

נקודת כניסה

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

אובייקט של נקודת הכניסה
entryPoint.accessCode string
קוד הגישה ששימש לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. ספקי שיחות ועידה בדרך כלל משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לתת גישה לשיחות ועידה. תהיה אפשרות להציג התאמות ולהציג רק את השדות שבהם משתמש הספק של שיחת הוועידה.
entryPoint.entryPointFeatures list
התכונות של נקודת הכניסה. בשלב הזה, התכונות האלה רלוונטיות רק ל-phone נקודות כניסה:
  • toll: נקודת הכניסה היא שיחת טלפון בתשלום.
  • toll_free: נקודת הכניסה היא שיחת טלפון ללא תשלום.
entryPoint.entryPointType string
סוג נקודת הכניסה. הערכים האפשריים הם:
  • more: הוראות הצטרפות נוספות לשיחת הוועידה, כמו מספרי טלפון חלופיים. לכל שיחת ועידה יכולה להיות רק נקודת כניסה אחת ל-more. אם יש נקודת כניסה אחת לפחות, צריך גם להשתמש בה.
  • phone: הצטרפות לשיחת הוועידה באמצעות מספר טלפון. לכל שיחת ועידה יכולות להיות אפס נקודות כניסה או יותר ל-phone. ביומן Google מוצגות רק שתי נקודות הכניסה הראשונות של הטלפון, אחרי עיצוב ומיון לפי סדר אלפביתי.
  • sip: הצטרפות לשיחת הוועידה באמצעות SIP. לכל שיחת ועידה יכולה להיות נקודת כניסה אחת (sip) לכל היותר.
  • video: הצטרפות לשיחת הוועידה באמצעות HTTP. לכל שיחת ועידה יכולה להיות רק נקודת כניסה אחת (video) אחת.
entryPoint.label string
התווית הגלויה למשתמש של ה-URI של נקודת הכניסה (לא מותאמת לשוק המקומי).
entryPoint.meetingCode string
קוד הפגישה ששימש לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. ספקי שיחות ועידה בדרך כלל משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לתת גישה לשיחות ועידה. תהיה אפשרות להציג התאמות ולהציג רק את השדות שבהם משתמש הספק של שיחת הוועידה.
entryPoint.passcode string
קוד הגישה ששימש לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. ספקי שיחות ועידה בדרך כלל משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לתת גישה לשיחות ועידה. תהיה אפשרות להציג התאמות ולהציג רק את השדות שבהם משתמש הספק של שיחת הוועידה.
entryPoint.password string
הסיסמה ששימשה לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. ספקי שיחות ועידה בדרך כלל משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לתת גישה לשיחות ועידה. תהיה אפשרות להציג התאמות ולהציג רק את השדות שבהם משתמש הספק של שיחת הוועידה.
entryPoint.pin string
קוד האימות ששימש לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. ספקי שיחות ועידה בדרך כלל משתמשים רק בקבוצת משנה של {accessCode, meetingCode, passcode, password, pin} כדי לתת גישה לשיחות ועידה. תהיה אפשרות להציג התאמות ולהציג רק את השדות שבהם משתמש הספק של שיחת הוועידה.
entryPoint.regionCode string
קוד האזור של מספר הטלפון. המשתמשים נדרשים אם ה-URI לא כולל קוד מדינה. הערכים מבוססים על רשימת קודי האזורים ב-CLDR הציבורית.
entryPoint.uri string
ה-URI של נקודת הכניסה. האורך המקסימלי הוא 1,300 תווים. הפורמט נקבע לפי הסוג של נקודת הכניסה:
  • more: נדרשת הסכימה http: או https:.
  • phone: נדרשת הסכימה tel:. ה-URI צריך לכלול את רצף החיוג כולו (לדוגמה, 'tel:+12345678900,,,12345678;1234').
  • sip: נדרשת הסכימה sip: או sips:. לדוגמה, "sip:12345678@myprovider.com".
  • video: נדרשת הסכימה http: או https:.

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

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

אובייקט אירוע ב-Drive
drive.activeCursorItem Drive item object
הפריט ב-Drive שפעיל כרגע.
drive.selectedItems[] list of Drive item objects
רשימת פריטים (קבצים או תיקיות) שנבחרו ב-Drive.

פריט ב-Drive

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

אובייקט של פריט ב-Drive
item.addonHasFileScopePermission boolean
אם true, התוסף ביקש וקיבל הרשאת היקף של https://www.googleapis.com/auth/drive.file לפריט הזה. אחרת, השדה הזה הוא false.
item.id string
המזהה של הפריט שנבחר.
item.iconUrl string
כתובת ה-URL של הסמל שמייצג את הפריט שנבחר.
item.mimeType string
סוג MIME של הפריט שנבחר.
item.title string
השם של הפריט שנבחר.

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

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

אובייקט אירוע ב-Gmail
gmail.accessToken string
אסימון הגישה הספציפי ל-Gmail. אפשר להשתמש באסימון הזה באמצעות השיטה GmailApp.setCurrentMessageAccessToken(accessToken) כדי להעניק לתוסף גישה זמנית להודעה ב-Gmail שפתוחה כרגע של משתמש, או כדי לאפשר לתוסף לכתוב טיוטות חדשות.
gmail.bccRecipients[] list of strings
מושבת כברירת מחדל. הרשימה של כתובות האימייל של הנמען 'עותק מוסתר': שכלולות כרגע בטיוטה שהתוסף מחבר. כדי להפעיל את השדה הזה, צריך להגדיר את השדה addOns.gmail.composeTrigger.draftAccess במניפסט כ-METADATA.
gmail.ccRecipients[] list of strings
מושבת כברירת מחדל. הרשימה של כתובות האימייל של הנמענים שכלולים כרגע בטיוטה שהתוסף נכתב. כדי להפעיל את השדה הזה, צריך להגדיר את השדה addOns.gmail.composeTrigger.draftAccess במניפסט כ-METADATA.
gmail.messageId string
המזהה של ההודעה הפתוחה ב-Gmail.
gmail.threadId string
מזהה השרשור ב-Gmail שפתוח כרגע.
gmail.toRecipients[] list of strings
מושבת כברירת מחדל. הרשימה של כתובות האימייל של הנמענים בקטע 'אל:' שכלולות כרגע בטיוטה שהתוסף מחבר. כדי להפעיל את השדה הזה, צריך להגדיר את השדה addOns.gmail.composeTrigger.draftAccess במניפסט כ-METADATA.

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

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

אובייקט אירוע ב-Docs
docs.id string
מוצג רק אם ההיקף https://www.googleapis.com/auth/drive.file אושר על ידי המשתמש.
המזהה של המסמך הפתוח בממשק המשתמש של Docs.
docs.title string
מוצג רק אם ההיקף https://www.googleapis.com/auth/drive.file אושר על ידי המשתמש.
כותרת המסמך הפתוח בממשק המשתמש של Docs.
docs.addonHasFileScopePermission boolean
אם true, התוסף ביקש וקיבל הרשאה להיקף ההרשאות https://www.googleapis.com/auth/drive.file עבור המסמך הפתוח בממשק המשתמש של Docs. אחרת, השדה הזה הוא false.
docs.matchedUrl.url string
מוצג רק אם התנאים הבאים מתקיימים:
  • החשבון https://www.googleapis.com/auth/workspace.linkpreview אושר על ידי המשתמש.
  • כתובת ה-URL תואמת לדפוס המארח שצוין בטריגר LinkPreviewTriggers.

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

מטען ייעודי (payload) לדוגמה כשמשתמש מציג את הקישור בתצוגה מקדימה https://www.example.com/12345: 

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

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

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

אובייקט אירוע ב-Sheets
sheets.id string
מוצג רק אם ההיקף https://www.googleapis.com/auth/drive.file אושר על ידי המשתמש. המזהה של הגיליון האלקטרוני שנפתח בממשק המשתמש של Sheets.
sheets.title string
מוצג רק אם ההיקף https://www.googleapis.com/auth/drive.file אושר על ידי המשתמש. הכותרת של הגיליון האלקטרוני שנפתח בממשק המשתמש של Sheets.
sheets.addonHasFileScopePermission boolean
אם true, התוסף ביקש וקיבל הרשאת היקף של https://www.googleapis.com/auth/drive.file לגיליון האלקטרוני הפתוח בממשק המשתמש של Sheets. אחרת, השדה הזה הוא false.
sheets.matchedUrl.url string
מוצג רק אם התנאים הבאים מתקיימים:
  • החשבון https://www.googleapis.com/auth/workspace.linkpreview אושר על ידי המשתמש.
  • כתובת ה-URL תואמת לדפוס המארח שצוין בטריגר LinkPreviewTriggers.

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

מטען ייעודי (payload) לדוגמה כשמשתמש מציג את הקישור בתצוגה מקדימה של https://www.example.com/12345:

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

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

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

אובייקט אירוע ב-Slides
slides.id string
מוצג רק אם ההיקף https://www.googleapis.com/auth/drive.file אושר על ידי המשתמש. מזהה המצגת שנפתח בממשק המשתמש של Slides.
slides.title string
מוצג רק אם ההיקף https://www.googleapis.com/auth/drive.file אושר על ידי המשתמש. שם המצגת נפתח בממשק המשתמש של Slides.
slides.addonHasFileScopePermission boolean
אם true, התוסף ביקש וקיבל הרשאת היקף של https://www.googleapis.com/auth/drive.file למצגת פתוחה בממשק המשתמש של Slides. אחרת, השדה הזה הוא false.
slides.matchedUrl.url string
מוצג רק אם התנאים הבאים מתקיימים:
  • החשבון https://www.googleapis.com/auth/workspace.linkpreview אושר על ידי המשתמש.
  • כתובת ה-URL תואמת לדפוס המארח שצוין בטריגר LinkPreviewTriggers.

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

מטען ייעודי (payload) לדוגמה כשמשתמש מציג את הקישור בתצוגה מקדימה של https://www.example.com/12345:

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