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

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

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

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

אירועים ב-Google Slides

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

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

אירועים ב-Google Forms

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

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

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

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

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

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

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

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

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

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

EventUpdated (ניתן להתקנה)
authMode	ערך מהטיפוסים בני ScriptApp.AuthMode. FULL
calendarId	מזהה המחרוזת של היומן שבו התרחש עדכון האירוע. [e-mail]
triggerUid	המזהה של הטריגר שהפעיל את האירוע הזה. 4034124084959907503

אירועים שקשורים לתוסף Google Workspace

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

התקנה (פשוט)
authMode	ערך מהטיפוסים בני ScriptApp.AuthMode. FULL

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

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

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

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

מבוסס זמן (ניתן להתקנה)
authMode	ערך מהטיפוסים בני 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