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

טריגרים פשוטים וטריגרים שניתן להתקין מאפשרים להריץ פונקציה ב-Apps Script באופן אוטומטי אם מתרחש אירוע מסוים. כשטריגר מופעל, ‏Apps Script מעביר לפונקציה אובייקט אירוע כארגומנט, שבדרך כלל נקרא e. אובייקט האירוע מכיל מידע על ההקשר שגרם להפעלת הטריגר. לדוגמה, בקוד לדוגמה שבהמשך מוצג טריגר onEdit(e) פשוט לסקריפט ב-Google Sheets שמשתמש באובייקט האירוע כדי לקבוע איזו תא עברו עריכה.

function onEdit(e){
  // Set a comment on the edited cell to indicate when it was changed.
  var range = e.range;
  range.setNote('Last modified: ' + new Date());
}

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

אירועים שנוצרו על ידי טריגרים שניתן להתקין מכילים את הערך triggerUid שמזהה את הטריגר שיצר את האירוע. האפשרות הזו שימושית לסקריפטים שיש להם כמה טריגרים שניתן להתקין.

אירועים ב-Google Sheets

הטריגרים השונים שספציפיים ל-Google Sheets מאפשרים לסקריפטים להגיב לפעולות של משתמשים בגיליון אלקטרוני.

פתיחה (פשוט וניתן להתקנה)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. LIMITED
source	אובייקט Spreadsheet שמייצג את קובץ Google Sheets שאליו הסקריפט קשור. Spreadsheet
triggerUid	המזהה של הטריגר שהניב את האירוע הזה (טריגרים שניתן להתקין בלבד). 4034124084959907503
user	אובייקט User, שמייצג את המשתמש הפעיל, אם הוא זמין (בהתאם לקבוצה מורכבת של הגבלות אבטחה). [e-mail]

שינוי (installable)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. FULL
changeType	סוג השינוי (EDIT,‏ INSERT_ROW,‏ INSERT_COLUMN,‏ REMOVE_ROW,‏ REMOVE_COLUMN,‏ INSERT_GRID,‏ REMOVE_GRID,‏ FORMAT או OTHER). INSERT_ROW
source	אובייקט Spreadsheet שמייצג את קובץ Google Sheets שאליו מחויב הסקריפט. Spreadsheet
triggerUid	המזהה של הטריגר שיצר את האירוע הזה. 4034124084959907503
user	אובייקט User, שמייצג את המשתמש הפעיל, אם הוא זמין (בהתאם לקבוצה מורכבת של הגבלות אבטחה). [e-mail]

עריכה (פשוט וניתן להתקנה)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. LIMITED
oldValue	ערך התא לפני העריכה, אם יש כזה. האפשרות הזו זמינה רק אם הטווח שעורכים הוא תא יחיד. הערך לא יוגדר אם לא היה לתא תוכן קודם. 1234
range	אובייקט Range שמייצג את התא או את טווח התאים שערכתם. Range
source	אובייקט Spreadsheet שמייצג את קובץ Google Sheets שאליו הסקריפט קשור. Spreadsheet
triggerUid	המזהה של הטריגר שהניב את האירוע הזה (טריגרים שניתן להתקין בלבד). 4034124084959907503
user	אובייקט User, שמייצג את המשתמש הפעיל, אם הוא זמין (בהתאם לקבוצה מורכבת של הגבלות אבטחה). [e-mail]
value	הערך החדש של התא אחרי העריכה. האפשרות הזו זמינה רק אם הטווח שערכתם הוא תא יחיד. 10

שליחת טופס (installable)
זהירות: חשוב להשתמש בטריגר הזה לשליחת טופס עם SpreadsheetTriggerBuilder.
authMode	ערך מ-enum‏ ScriptApp.AuthMode. FULL
namedValues	אובייקט שמכיל את השמות והערכים של השאלות מהטופס שנשלח. { 'First Name': ['Jane'], 'Timestamp': ['6/7/2015 20:54:13'], 'Last Name': ['Doe'] }
range	אובייקט Range שמייצג את התא או את טווח התאים שערכתם. Range
triggerUid	המזהה של הטריגר שיצר את האירוע הזה. 4034124084959907503
values	מערך עם ערכים באותו סדר שבו הם מופיעים בגיליון האלקטרוני. ['2015/05/04 15:00', '[e-mail]', 'Bob', '27', 'Bill', '28', 'Susan', '25']

אירועים ב-Google Docs

טריגרים מאפשרים ל-Google Docs להגיב כשמשתמש פותח מסמך.

פתיחה (פשוט וניתן להתקנה)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. LIMITED
source	אובייקט Document שמייצג את קובץ Google Docs שאליו מחויב הסקריפט. Document
triggerUid	המזהה של הטריגר שהניב את האירוע הזה (טריגרים שניתן להתקין בלבד). 4034124084959907503
user	אובייקט User, שמייצג את המשתמש הפעיל, אם הוא זמין (בהתאם לקבוצה מורכבת של הגבלות אבטחה). [e-mail]

אירועים ב-Google Slides

טריגרים מאפשרים ל-Google Slides להגיב כשמשתמש פותח מצגת.

פתיחה (פשוט)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. LIMITED
source	אובייקט Presentation שמייצג את קובץ Google Slides שאליו מצורף הסקריפט. Presentation
user	אובייקט User, שמייצג את המשתמש הפעיל, אם הוא זמין (בהתאם לקבוצה מורכבת של הגבלות אבטחה). [e-mail]

אירועים ב-Google Forms

הטריגרים הספציפיים ל-Google Forms מאפשרים לסקריפטים להגיב כשמשתמש עורך טופס או שולח תשובה.

פתיחה * (פשוט וניתן להתקנה)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. LIMITED
source	אובייקט Form שמייצג את קובץ Google Forms שאליו הסקריפט קשור. Form
triggerUid	המזהה של הטריגר שהניב את האירוע הזה (טריגרים שניתן להתקין בלבד). 4034124084959907503
user	אובייקט User, שמייצג את המשתמש הפעיל, אם הוא זמין (בהתאם לקבוצה מורכבת של הגבלות אבטחה). [e-mail]

* האירוע הזה לא מתרחש כשמשתמש פותח טופס כדי להשיב, אלא כשעריכה פותח את הטופס כדי לשנות אותו.

שליחת טופס (installable)
זהירות: חשוב להשתמש בטריגר הזה לשליחת טופס עם FormTriggerBuilder.
authMode	ערך מ-enum‏ ScriptApp.AuthMode. FULL
response	אובייקט FormResponse, שמייצג את התשובה של המשתמש לטופס כולו. FormResponse
source	אובייקט Form שמייצג את קובץ Google Forms שאליו הסקריפט קשור. Form
triggerUid	המזהה של הטריגר שיצר את האירוע הזה. 4034124084959907503

אירועים ביומן Google

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

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

כדי לסנכרן עם יומן Google ב-Apps Script, מבצעים את השלבים הבאים:

1. מפעילים את השירות המתקדם של יומן Google בפרויקט הסקריפט. שירות יומן Google המובנה לא מספיק לתהליך העבודה הזה.
2. קובעים אילו יומנים צריך לסנכרן. לכל יומן כזה, מבצעים פעולת סנכרון ראשוני באמצעות השיטה Events.list() של השירות המתקדם של יומן Google.
3. תוצאת הסנכרון הראשוני מחזירה nextSyncToken עבור היומן הזה. שומרים את האסימון לשימוש מאוחר יותר.
4. כשהטריגר EventUpdated ב-Apps Script מופעל ומציין שינוי באירוע ביומן, מבצעים סנכרון מצטבר של היומן המושפע באמצעות nextSyncToken השמור. זוהי למעשה בקשה נוספת של Events.list(), אבל הוספת nextSyncToken מגבילה את התגובה רק לאירועים שהשתנו מאז הסנכרון האחרון.
5. בודקים את התגובה של הסנכרון כדי לבדוק אילו אירועים עודכנו, ומגדירים את התגובה של הקוד בהתאם. לדוגמה, אפשר לתעד את השינוי, לעדכן גיליון אלקטרוני, לשלוח התראות באימייל או לבצע פעולות אחרות.
6. מעדכנים את הערך של nextSyncToken ששמרתם ביומן הזה בערך שהוחזר על ידי בקשת הסנכרון המצטבר. כך פעולת הסנכרון הבאה תחזיר רק את השינויים העדכניים ביותר.

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

EventUpdated (installable)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. FULL
calendarId	מזהה המחרוזת של היומן שבו בוצע עדכון האירוע. [e-mail]
triggerUid	המזהה של הטריגר שיצר את האירוע הזה. 4034124084959907503

אירועים של תוספים ל-Google Workspace

הטריגר onInstall() פועל באופן אוטומטי כשמשתמש מתקין תוסף.

התקנה (פשוט)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. FULL

אירועים באפליקציית Google Chat

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

אירועים מבוססי-זמן

טריגרים מבוססי-זמן (שנקראים גם טריגרים מבוססי-שעון) מאפשרים להריץ סקריפטים בזמן מסוים או במרווח זמן קבוע.

מבוסס זמן (ניתן להתקנה)
authMode	ערך מ-enum‏ ScriptApp.AuthMode. FULL
day-of-month	בין 1 ל-31. מכיוון ששם הנכס הזה מכיל מקפים, צריך לגשת אליו באמצעות e['day-of-month'] ולא באמצעות סימן הנקודה. 31
day-of-week	בין 1 (שני) ל-7 (שבת). מכיוון ששם הנכס הזה מכיל מקפים, צריך לגשת אליו באמצעות e['day-of-week'] ולא באמצעות סימן הנקודה. 7
hour	בין 0 ל-23. 23
minute	בין 0 ל-59. 59
month	בין 1 ל-12. 12
second	בין 0 ל-59. 59
timezone	אזור הזמן. UTC
triggerUid	המזהה של הטריגר שהניב את האירוע הזה. 4034124084959907503
week-of-year	בין 1 ל-52. מכיוון ששם הנכס הזה מכיל מקפים, צריך לגשת אליו באמצעות e['week-of-year'] ולא באמצעות סימן הנקודה. 52
year	השנה. 2015