דף זה תורגם על ידי Cloud Translation API.

Script Service

השירות הזה מספק גישה לטריגרים של סקריפטים ולפרסום סקריפטים.

מחלקות

שם	תיאור קצר
`AuthMode`	ספירה שבה מצוין אילו קטגוריות של שירותים מורשים אפשר להפעיל באמצעות Apps Script באמצעות פונקציה מופעלת.
`AuthorizationInfo`	אובייקט שמשמש כדי לקבוע אם המשתמש צריך לאשר לסקריפט הזה להשתמש בשירות אחד או יותר, וכדי לספק את כתובת ה-URL של תיבת דו-שיח להרשאה.
`AuthorizationStatus`	ספירה שמציינת את סטטוס ההרשאה של סקריפט.
`CalendarTriggerBuilder`	כלי ליצירת טריגרים של היומן.
`ClockTriggerBuilder`	כלי לבניית טריגרים של שעון.
`DocumentTriggerBuilder`	כלי ליצירת טריגרים של מסמכים.
`EventType`	ספירה שמציינת את סוג האירוע שהופעל.
`FormTriggerBuilder`	כלי לבניית טריגרים של טפסים.
`InstallationSource`	ספירה שמציינת איך הסקריפט הותקן כתוסף עבור המשתמש הנוכחי.
`ScriptApp`	גישה לפרסום סקריפטים וטריגרים, ושינוי שלהם.
`Service`	גישה לפרסום סקריפטים וביצוע שינויים בהם.
`SpreadsheetTriggerBuilder`	כלי לטריגרים של גיליונות אלקטרוניים.
`StateTokenBuilder`	סקריפטים יכולים ליצור אסימוני מצב שניתן להשתמש בהם בממשקי API לקריאה חוזרת (כמו תהליכי OAuth).
`Trigger`	טריגר לסקריפט.
`TriggerBuilder`	כלי כללי לטריגרים של סקריפטים.
`TriggerSource`	ספירה שמציינת את מקור האירוע שגורם להפעלה של הטריגר.

`AuthMode`

תכונות

נכס	תיאור	התיאור
`NONE`	`Enum`	מצב שלא מאפשר גישה לשירותים שדורשים הרשאה.
`CUSTOM_FUNCTION`	`Enum`	מצב שמאפשר גישה לקבוצת משנה מוגבלת של שירותים לשימוש בפונקציות של גיליונות אלקטרוניים בהתאמה אישית.
`LIMITED`	`Enum`	מצב שמאפשר גישה לקבוצת משנה מוגבלת של שירותים.
`FULL`	`Enum`	מצב שמאפשר גישה לכל השירותים שנדרשת להם הרשאה.

`AuthorizationInfo`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`getAuthorizationStatus()`	`AuthorizationStatus`	הפונקציה מקבלת ערך שמציין אם המשתמש צריך לאשר לסקריפט הזה להשתמש בשירות אחד או יותר (לדוגמה, `ScriptApp.AuthorizationStatus.REQUIRED`).
`getAuthorizationUrl()`	`String`	הפונקציה מקבלת את כתובת ה-URL להרשאה שניתן להשתמש בה כדי להעניק גישה לסקריפט.

`AuthorizationStatus`

תכונות

נכס	תיאור	התיאור
`REQUIRED`	`Enum`	המשתמש צריך לאשר לסקריפט הזה להשתמש בשירות אחד או יותר.
`NOT_REQUIRED`	`Enum`	המשתמש העניק לסקריפט הזה את כל ההרשאות הנדרשות כרגע.

`CalendarTriggerBuilder`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`create()`	`Trigger`	יוצרת את הטריגר ומחזירה אותו.
`onEventUpdated()`	`CalendarTriggerBuilder`	מציינת טריגר שיופעל בכל פעם שרשומה ביומן נוצרת, מתעדכנת או נמחקת.

`ClockTriggerBuilder`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`after(durationMilliseconds)`	`ClockTriggerBuilder`	מציינת את משך הזמן המינימלי (באלפיות שנייה) לאחר הזמן הנוכחי שבו הטריגר פועל.
`at(date)`	`ClockTriggerBuilder`	מציינת מתי הטריגר פועל.
`atDate(year, month, day)`	`ClockTriggerBuilder`	מציין שהטריגר יופעל בתאריך הנתון, כברירת מחדל בקרבת חצות (+/- 15 דקות).
`atHour(hour)`	`ClockTriggerBuilder`	מציין את השעה שבה הטריגר פועל.
`create()`	`Trigger`	יוצר את הטריגר.
`everyDays(n)`	`ClockTriggerBuilder`	המדיניות קובעת אם יופעל הטריגר כל יומיים (`n`).
`everyHours(n)`	`ClockTriggerBuilder`	המדיניות קובעת אם יופעל הטריגר כל שעתיים (`n`).
`everyMinutes(n)`	`ClockTriggerBuilder`	המדיניות קובעת אם יופעל הטריגר כל `n` דקות.
`everyWeeks(n)`	`ClockTriggerBuilder`	מציינת שיש להריץ את הטריגר כל `n` שבועות.
`inTimezone(timezone)`	`ClockTriggerBuilder`	מציינת את אזור הזמן עבור התאריכים/השעות שצוינו שבהם הטריגר מופעל.
`nearMinute(minute)`	`ClockTriggerBuilder`	מציין את הדקה שבה הטריגר פועל (יותר או מינוס 15 דקות).
`onMonthDay(day)`	`ClockTriggerBuilder`	מציין את התאריך בחודש שבו מופעל הטריגר.
`onWeekDay(day)`	`ClockTriggerBuilder`	מציין את היום בשבוע שבו הטריגר פועל.

`DocumentTriggerBuilder`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`create()`	`Trigger`	הפונקציה יוצרת ומחזירה את הטריגר החדש.
`onOpen()`	`DocumentTriggerBuilder`	מציינת טריגר שיופעל כשהמסמך נפתח.

`EventType`

תכונות

נכס	תיאור	התיאור
`CLOCK`	`Enum`	הטריגר מופעל ברגע שהאירוע מבוסס-הזמן מגיע למועד מסוים.
`ON_OPEN`	`Enum`	הטריגר מופעל ברגע שהמשתמש פותח את הקובץ ב-Google Docs , Sheets או Forms.
`ON_EDIT`	`Enum`	הטריגר מופעל ברגע שהמשתמש עורך את הקובץ ב-Google Sheets (לדוגמה, על ידי הזנת ערך חדש בתא שנספר כעריכה במקום כשינוי).
`ON_FORM_SUBMIT`	`Enum`	הטריגר מופעל ברגע שהמשתמש מגיב לטופס ב-Google Forms.
`ON_CHANGE`	`Enum`	הטריגר מופעל כשהמשתמש משנה את הקובץ ב-Google Sheets (לדוגמה, על ידי הוספת שורה שנחשבת לשינוי במקום עריכה).
`ON_EVENT_UPDATED`	`Enum`	הטריגר מופעל אחרי שיוצרים, מעדכנים או מוחקים אירוע ביומן Google שצוין.

`FormTriggerBuilder`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`create()`	`Trigger`	הפונקציה יוצרת ומחזירה את הטריגר החדש.
`onFormSubmit()`	`FormTriggerBuilder`	מציין טריגר שיופעל כשנשלחת תגובה לטופס.
`onOpen()`	`FormTriggerBuilder`	מציינת טריגר שיופעל כשתצוגת העריכה של הטופס תיפתח.

`InstallationSource`

תכונות

נכס	תיאור	התיאור
`APPS_MARKETPLACE_DOMAIN_ADD_ON`	`Enum`	האדמין התקין את התוסף עבור הדומיין של המשתמש.
`NONE`	`Enum`	הסקריפט לא פועל כתוסף.
`WEB_STORE_ADD_ON`	`Enum`	המשתמש התקין את התוסף מחנות האינטרנט של Chrome.

`ScriptApp`

תכונות

נכס	תיאור	התיאור
`AuthMode`	`AuthMode`	ספירה שבה מצוין אילו קטגוריות של שירותים מורשים אפשר להפעיל באמצעות Apps Script באמצעות פונקציה מופעלת.
`AuthorizationStatus`	`AuthorizationStatus`	ספירה שמציינת את סטטוס ההרשאה של סקריפט.
`EventType`	`EventType`	ספירה שמציינת את סוג האירוע שהופעל.
`InstallationSource`	`InstallationSource`	ספירה שמציינת את האופן שבו הסקריפט הותקן למשתמש כתוסף.
`TriggerSource`	`TriggerSource`	ספירה שמציינת את מקור האירוע שגורם להפעלה של הטריגר.
`WeekDay`	`Weekday`	ספירה שמייצגת את הימים בשבוע.

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`deleteTrigger(trigger)`	`void`	מסיר את הטריגר הנתון כך שהוא לא יפעל יותר.
`getAuthorizationInfo(authMode)`	`AuthorizationInfo`	הפונקציה מחזירה אובייקט כדי לקבוע אם המשתמש צריך לאשר לסקריפט הזה להשתמש בשירות אחד או יותר, וכדי לספק את כתובת ה-URL של תיבת דו-שיח להרשאה.
`getIdentityToken()`	`String`	מקבל אסימון זהות של OpenID Connect עבור המשתמש האפקטיבי, אם הוענק ההיקף `openid`.
`getInstallationSource()`	`InstallationSource`	הפונקציה מחזירה ערך enum שמציין איך הסקריפט הותקן כתוסף למשתמש הנוכחי (לדוגמה, אם המשתמש התקין אותו באופן אישי דרך חנות האינטרנט של Chrome או אם מנהל הדומיין התקין אותו לכל המשתמשים).
`getOAuthToken()`	`String`	מקבל את אסימון הגישה של OAuth 2.0 עבור המשתמש בפועל.
`getProjectTriggers()`	`Trigger[]`	מקבל את כל הטריגרים שניתנים להתקנה, שמשויכים לפרויקט הנוכחי ולמשתמש הנוכחי.
`getScriptId()`	`String`	הפונקציה מקבלת את המזהה הייחודי של פרויקט הסקריפט.
`getService()`	`Service`	הפונקציה מקבלת אובייקט שמשמש לשליטה בפרסום הסקריפט כאפליקציית אינטרנט.
`getUserTriggers(document)`	`Trigger[]`	הפונקציה מקבלת את כל הטריגרים שניתנים להתקנה שבבעלות המשתמש הזה במסמך הנתון, רק לסקריפט או לתוסף הזה.
`getUserTriggers(form)`	`Trigger[]`	הפונקציה מקבלת את כל הטריגרים שניתנים להתקנה שבבעלות המשתמש הזה בטופס הנתון, לסקריפט או לתוסף הזה בלבד.
`getUserTriggers(spreadsheet)`	`Trigger[]`	הפונקציה מקבלת את כל הטריגרים שניתנים להתקנה שבבעלות המשתמש הזה בגיליון האלקטרוני הנתון, רק לסקריפט או לתוסף הזה.
`invalidateAuth()`	`void`	מבטל את התוקף של ההרשאה שיש למשתמש בפועל כדי להפעיל את הסקריפט הנוכחי.
`newStateToken()`	`StateTokenBuilder`	יוצרת כלי לבניית אסימון מצב שיכול לשמש ב-API של קריאה חוזרת (כמו תהליך OAuth).
`newTrigger(functionName)`	`TriggerBuilder`	מתחיל את תהליך היצירה של טריגר שניתן להתקנה, כאשר הוא מופעל, הוא מפעיל פונקציה נתונה.

`Service`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`getUrl()`	`String`	מחזירה את כתובת ה-URL של אפליקציית האינטרנט, אם היא נפרסה. אחרת, מחזירה `null`.
`isEnabled()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם הסקריפט זמין כאפליקציית אינטרנט.

`SpreadsheetTriggerBuilder`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`create()`	`Trigger`	יוצרת את הטריגר ומחזירה אותו.
`onChange()`	`SpreadsheetTriggerBuilder`	מציינת טריגר שיופעל לאחר שינוי התוכן או המבנה של הגיליון האלקטרוני.
`onEdit()`	`SpreadsheetTriggerBuilder`	מציין טריגר שיופעל לאחר עריכת הגיליון האלקטרוני.
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	מציינת טריגר שיופעל אם יישלח אליו טופס בגיליון האלקטרוני.
`onOpen()`	`SpreadsheetTriggerBuilder`	מציינת טריגר שיופעל כשהגיליון האלקטרוני ייפתח.

`StateTokenBuilder`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`createToken()`	`String`	יוצרת ייצוג של מחרוזת מוצפנת של אסימון המצב.
`withArgument(name, value)`	`StateTokenBuilder`	הוספת ארגומנט לאסימון.
`withMethod(method)`	`StateTokenBuilder`	מגדירה פונקציית קריאה חוזרת.
`withTimeout(seconds)`	`StateTokenBuilder`	מגדיר את משך הזמן (בשניות) שעבורו האסימון תקף.

`Trigger`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`getEventType()`	`EventType`	מחזירה את סוג האירוע שבו הטריגר מופעל.
`getHandlerFunction()`	`String`	מחזירה את הפונקציה שתיקרא כשהטריגר מופעל.
`getTriggerSource()`	`TriggerSource`	מחזירה את המקור של האירועים שיגרמו להפעלה של הטריגר.
`getTriggerSourceId()`	`String`	מחזירה את המזהה הספציפי למקור.
`getUniqueId()`	`String`	הפונקציה מחזירה מזהה ייחודי שאפשר להשתמש בו כדי להבדיל בין טריגרים אחד מהשני.

`TriggerBuilder`

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`forDocument(document)`	`DocumentTriggerBuilder`	יוצרת ומחזירה `DocumentTriggerBuilder` שקשורה למסמך הנתון.
`forDocument(key)`	`DocumentTriggerBuilder`	הפונקציה יוצרת ומחזירה `DocumentTriggerBuilder` שמקושר למסמך עם המזהה הנתון.
`forForm(form)`	`FormTriggerBuilder`	הפונקציה יוצרת ומחזירה `FormTriggerBuilder` שקשורה לטופס הנתון.
`forForm(key)`	`FormTriggerBuilder`	הפונקציה יוצרת ומחזירה `FormTriggerBuilder` שמקושר לטופס עם המזהה הנתון.
`forSpreadsheet(sheet)`	`SpreadsheetTriggerBuilder`	הפונקציה יוצרת ומחזירה `SpreadsheetTriggerBuilder` שמקושר לגיליון האלקטרוני הנתון.
`forSpreadsheet(key)`	`SpreadsheetTriggerBuilder`	הפונקציה יוצרת ומחזירה `SpreadsheetTriggerBuilder` שמקושר לגיליון האלקטרוני עם המזהה הנתון הזה.
`forUserCalendar(emailId)`	`CalendarTriggerBuilder`	מחזירה כלי לבניית טריגרים של יומן.
`timeBased()`	`ClockTriggerBuilder`	הפונקציה יוצרת ומחזירה `ClockTriggerBuilder` לבניית טריגרים מבוססי-זמן.

`TriggerSource`

תכונות

נכס	תיאור	התיאור
`SPREADSHEETS`	`Enum`	Google Sheets גורם לטריגר לפעול.
`CLOCK`	`Enum`	אירוע מבוסס-זמן גורם להפעלה של הטריגר.
`FORMS`	`Enum`	Google Forms גורם להפעלה של הטריגר.
`DOCUMENTS`	`Enum`	Google Docs גורם להפעלת הטריגר.
`CALENDAR`	`Enum`	הטריגר יופעל ביומן Google.

אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers‏.‏ Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.

עדכון אחרון: 2023-12-01 (שעון UTC).

בלוג
לקריאה בבלוג Google Workspace Developers
Stack Overflow
שואלים שאלה מתחת לתג google-apps-script
דוגמאות קוד
יש לך אפשרות לעיין בדוגמאות הקוד שלנו או להעתיק אותן כדי ליצור אחת משלך
סרטונים
צפייה במדריכים של Apps Script