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

טריגרים פשוטים וגם טריגרים שניתנים להתקנה מאפשרים ל-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]

שינוי (ניתנת להתקנה)
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

שליחת טופס (ניתנת להתקנה)
זהירות: הקפידו להשתמש בטריגר לשליחת הטופס הזה באמצעות 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]

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

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

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

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

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

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

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

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

EventUpdated (ניתנת להתקנה)
authMode	ערך מ- ScriptApp.AuthMode טיפוסים בני מנייה (enum) 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