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

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

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

אירועים ב-Google Sheets

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

פתיחה

(פשוט וניתן להתקנה)
authMode

ערך מ-enum ScriptApp.AuthMode.

LIMITED
source

אובייקט Spreadsheet, שמייצג את קובץ Google Sheets שאליו הסקריפט מקושר.

Spreadsheet
triggerUid

מזהה הטריגר שיצר את האירוע הזה (רק טריגרים שניתנים להתקנה).

4034124084959907503
user

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

amin@example.com

שינוי

(ניתנת להתקנה)
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, שמייצג את המשתמש הפעיל, אם הוא זמין (בהתאם לקבוצה מורכבת של הגבלות אבטחה).

amin@example.com

עריכה

(פשוט וניתן להתקנה)
authMode

ערך מ-enum ScriptApp.AuthMode.

LIMITED
oldValue

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

1234
range

אובייקט Range, שמייצג את התא או טווח התאים שנערכו.

Range
source

אובייקט Spreadsheet, שמייצג את קובץ Google Sheets שאליו הסקריפט מקושר.

Spreadsheet
triggerUid

מזהה הטריגר שיצר את האירוע הזה (רק טריגרים שניתנים להתקנה).

4034124084959907503
user

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

amin@example.com
value

הערך החדש של התא אחרי העריכה. האפשרות הזו זמינה רק אם הטווח שערכת הוא תא יחיד.

10

שליחת טופס

(ניתנת להתקנה)
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', 'amin@example.com', 'Bob', '27', 'Bill',
'28', 'Susan', '25']

אירועים ב-Google Docs

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

פתיחה

(פשוט וניתן להתקנה)
authMode

ערך מ-enum ScriptApp.AuthMode.

LIMITED
source

אובייקט Document, שמייצג את הקובץ ב-Google Docs שאליו הסקריפט מקושר.

Document
triggerUid

מזהה הטריגר שיצר את האירוע הזה (רק טריגרים שניתנים להתקנה).

4034124084959907503
user

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

amin@example.com

אירועים ב-Google Slides

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

פתיחה

(פשוט)
authMode

ערך מ-enum ScriptApp.AuthMode.

LIMITED
source

אובייקט Presentation, שמייצג את הקובץ ב-Google Slides שאליו הסקריפט מקושר.

Presentation
user

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

amin@example.com

אירועים ב-Google Forms

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

פתיחה

* (פשוט וניתן להתקנה)
authMode

ערך מ-enum ScriptApp.AuthMode.

LIMITED
source

אובייקט Form, שמייצג את הקובץ ב-Google Forms שאליו הסקריפט מקושר.

Form
triggerUid

מזהה הטריגר שיצר את האירוע הזה (רק טריגרים שניתנים להתקנה).

4034124084959907503
user

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

amin@example.com

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

שליחת טופס

(ניתנת להתקנה)
authMode

ערך מ-enum ScriptApp.AuthMode.

FULL
response

אובייקט FormResponse, שמייצג את תגובת המשתמש לטופס באופן כללי.

FormResponse
source

אובייקט Form, שמייצג את הקובץ ב-Google Forms שאליו הסקריפט מקושר.

Form
triggerUid

המזהה של הטריגר שהפיק את האירוע הזה.

4034124084959907503

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

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

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

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

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

EventUpdated

(ניתנת להתקנה)
authMode

ערך מ-enum ScriptApp.AuthMode.

FULL
calendarId

מזהה המחרוזת של היומן שבו אירע עדכון האירוע.

susan@example.com
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