בדף הזה מפורט מבנה האובייקטים של האירועים של התוספים ל-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'. המידע בשדות האלה משוחזר במבנה אובייקט חדש.
אובייקט אירוע | |
---|---|
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.messageMetadata.messageId |
string הוצא משימוש. מזהה ההודעה של השרשור פתיחה בממשק המשתמש של Gmail.
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
eventObject.clientPlatform |
string הוצא משימוש. מציין את מיקום האירוע שמקורו (באינטרנט, ב-iOS או ב-Android).
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
eventObject.formInput |
object הוצא משימוש. מפה של הערכים הנוכחיים מכל הווידג'טים בטופס, מוגבל לערך אחד לכל ווידג'ט. מפתחות הם מזהי המחרוזת שמשויכים לווידג'טים, והערכים מחרוזות. אובייקט האירוע מספק את formInput בתור
נוח יותר כשצריך לקרוא נתונים מכמה ווידג'טים
הערכים הייחודיים הצפויים, כמו קלט טקסט ומתגים. עבור
ווידג'טים בעלי ערכים מרובים, כמו תיבות סימון, אפשר לקרוא כל ערך
יש גם אפשרות formInputs .
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
eventObject.formInputs |
object הוצא משימוש. מפה של הערכים הנוכחיים של ווידג'טים בכרטיס, שמוצגים כרשימות של מחרוזות. המפתחות הם מזהי מחרוזות המשויכים לווידג'ט. בווידג'טים עם ערך יחיד, הפונקציה מוצג במערך של רכיב יחיד. לווידג'טים בעלי ערכים מרובים כמו קבוצות של תיבות סימון, כל הערכים מוצגים ברשימה.
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
eventObject.parameters |
object הוצא משימוש. מפה של כל מיקום נוסף פרמטרים שאתם מספקים Action משתמשים
Action.setParameters() המקשים והערכים במפה הם
מחרוזות.
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
eventObject.userCountry |
string הוצא משימוש והושבת כברירת מחדל. קוד בן שתי אותיות המציין את המדינה או האזור של המשתמש. אפשר גם מספר קוד מדינה בפורמט UN M49.
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
eventObject.userLocale |
string הוצא משימוש והושבת כברירת מחדל. שתי אותיות ISO 639 שמציין את שפת המשתמש. צפייה גישה למשתמש של שפה ואזור זמן לפרטים נוספים.
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
eventObject.userTimezone.id |
string הוצא משימוש והושבת כברירת מחדל. מזהה אזור הזמן של אזור הזמן של המשתמש. דוגמאות: America/New_York , Europe/Vienna וגם
Asia/Seoul . צפייה
גישה ללוקאל ולאזור הזמן של המשתמש כדי לקבל פרטים נוספים.
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
eventObject.userTimezone.offset |
string הוצא משימוש והושבת כברירת מחדל. הפרש הזמן מזמן אוניברסלי מתואם (UTC) אזור זמן, שנמדד באלפיות השנייה. צפייה גישה ללוקאל ולאזור הזמן של המשתמש כדי לקבל פרטים נוספים.
לתוספים ל-Google Workspace, תוכלו למצוא את המידע הזה
|
אובייקט אירוע נפוץ
אובייקט האירוע המשותף הוא החלק מתוך אובייקט האירוע הכולל שנושא את מידע כללי שאינו תלוי במארח לתוסף מהלקוח של המשתמש. הזה המידע כולל פרטים כמו הלוקאל, האפליקציה המארחת והפלטפורמה של המשתמש.
בנוסף לטריגרים לדף הבית ולטריגרים לפי הקשר, התוספים בונים ומעבירים
אובייקטים של אירוע לפונקציות קריאה לפעולה (callback)
כשהמשתמש מקיים אינטראקציה עם ווידג'טים. פונקציית הקריאה החוזרת של התוסף יכולה לשלוח שאילתה
אובייקט האירוע המשותף כדי לקבוע את התוכן של ווידג'טים פתוחים
הלקוח. לדוגמה, התוסף יכול לאתר את הטקסט שמשתמש הזין
הווידג'ט TextInput
ב
אובייקט eventObject.commentEventObject.formInputs
.
שדות של אובייקטים נפוצים של אירועים | |
---|---|
commonEventObject.platform |
string מציין את מקור האירוע (`WEB`, 'IOS' או 'ANDROID). |
commonEventObject.formInputs |
object מפה שמכילה את הערכים הנוכחיים של הווידג'טים של הכרטיס שמוצג. מפתחות המפה הם מזהי המחרוזת שהוקצו לכל ווידג'ט. המבנה של אובייקט הערך במפה הוא בהתאם לסוג הווידג'ט:
|
commonEventObject.hostApp |
string מציין את האפליקציה המארחת שבה התוסף פעיל כשאובייקט האירוע נוצר. הערכים האפשריים כוללים את הבאים:
|
commonEventObject.parameters |
object פרמטרים נוספים אספקה ל-
Action באמצעות
Action.setParameters()
|
commonEventObject.userLocale |
string מושבת כברירת מחדל. השפה של המשתמש ומזהה המדינה/האזור, בפורמט של ISO 639 קוד שפה – ISO 3166 של קוד המדינה/האזור. לדוגמה: en-US .
כדי להפעיל את השדה הזה, צריך להגדיר את |
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) של המשתמש אזור זמן, שנמדד באלפיות השנייה. צפייה גישה ללוקאל ולאזור הזמן של המשתמש כדי לקבל פרטים נוספים. |
קלטים בטופס לבחירת תאריך ושעה
פונקציות קריאה חוזרת (callback)
יכול לקבל את ערכי הווידג'ט הנוכחיים בשדה commonEventObject.formInputs
.
המידע הזה כולל את ערכי התאריך או השעה שהמשתמש בוחר בחלונית לבחירת תאריך או שעה
הווידג'טים האלה.
עם זאת, מבנה המידע משתנה בהתאם
הווידג'ט הוגדר כבורר תאריך ושעה, חלונית לבחירת תאריך בלבד או כלי של שעה בלבד
בוחר. ההבדלים המבניים מתוארים בטבלה הבאה:
אובייקט של אירוע ביומן
אובייקט האירוע ביומן הוא החלק מתוך האובייקט הכולל של האירוע כולל מידע על האירועים ביומן והאירועים ביומן של המשתמש. זה רק קיים באובייקט אירוע אם האפליקציה המארחת היא יומן 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 מידע על המשתתפים השונים
אירועים. המידע הזה יופיע באובייקט האירוע אך ורק אם הנתונים
מופיע באירוע ביומן, והתוסף מגדיר
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 סטטוס התשובה של המשתתף. אפשרית כוללים את הערכים הבאים:
|
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 סוג הפתרון לשיחת ועידה. ערכים אפשריים כוללים את הפרטים הבאים:
|
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 מפה של מפתחות וערכים של מחרוזות פרמטרים. המפתחות והערכים האלה מוגדרים על ידי מפתח התוסף ומצרפים אותם פרטים על שיחת ועידה ספציפית לשימוש התוסף. |
נקודת כניסה
אובייקטים של נקודת כניסה נושאים מידע על אמצעי הגישה הקיימים
שיחת ועידה מסוימת, למשל בטלפון או בווידאו. המידע הזה נמצא ב
אובייקט האירוע רק אם הנתונים קיימים באירוע ביומן
התוסף מגדיר את addOns.calendar.currentEventAccess
שלו
מניפסט
שדה ל
READ
או READ_WRITE
.
אובייקט נקודת הכניסה | |
---|---|
entryPoint.accessCode |
string קוד הגישה המשמש לגישה לשיחת הוועידה. האורך המקסימלי הוא 128 תווים. בדרך כלל ספקים של שיחות ועידה משתמשים רק בקבוצת משנה של { accessCode , meetingCode ,
passcode , password , pin } עד
לספק גישה לשיחות ועידה. התאמת השדות והצגתם רק
שהספק של שיחת הוועידה משתמש בו.
|
entryPoint.entryPointFeatures |
list תכונות של נקודת הכניסה. כרגע אלה התכונות חלות רק על phone נקודות כניסה:
|
entryPoint.entryPointType |
string סוג נקודת הכניסה. הערכים האפשריים הם: הבאים:
|
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 תווים. הפורמט תלוי בנקודת הכניסה :type
|
אובייקט של אירוע ב-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 מושבת כברירת מחדל. הרשימה של "CC:" את כתובות האימייל של הנמענים שכלולות כרגע בטיוטה כותבים. כדי להפעיל את השדה הזה, צריך להגדיר את השדה 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
קיים רק אם התנאים הבאים מתקיימים:
כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Docs. כדי להשתמש בשדה הזה, צריך להגדיר את LinkPreviewTriggers במניפסט של התוסף. אפשר לקרוא פרטים נוספים במאמר בנושא תצוגה מקדימה של קישורים באמצעות צ'יפים חכמים.
מטען ייעודי (payload) לדוגמה למקרה שבו משתמש מציג תצוגה מקדימה של הקישור "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
קיים רק אם התנאים הבאים מתקיימים:
כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Sheets. כדי להשתמש בשדה הזה, צריך להגדיר את LinkPreviewTriggers במניפסט של התוסף. אפשר לקרוא פרטים נוספים במאמר בנושא תצוגה מקדימה של קישורים באמצעות צ'יפים חכמים.
מטען ייעודי (payload) לדוגמה למקרה שבו משתמש מציג תצוגה מקדימה של הקישור "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
קיים רק אם התנאים הבאים מתקיימים:
כתובת ה-URL של הקישור שיוצר תצוגה מקדימה ב-Google Slides. כדי להשתמש בשדה הזה, צריך להגדיר את LinkPreviewTriggers במניפסט של התוסף.
אפשר לקרוא פרטים נוספים במאמר בנושא תצוגה מקדימה של קישורים באמצעות צ'יפים חכמים.
מטען ייעודי (payload) לדוגמה למקרה שבו משתמש מציג תצוגה מקדימה של הקישור "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |