Script Service

סקריפט

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

שיעורים

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

AuthMode

מאפיינים

נכססוגתיאור
NONEEnumמצב שבו אין גישה לשירותים שדורשים הרשאה.
CUSTOM_FUNCTIONEnumמצב שמאפשר גישה לקבוצת משנה מוגבלת של שירותים לשימוש בפונקציות בהתאמה אישית של גיליונות אלקטרוניים.
LIMITEDEnumמצב שמאפשר גישה לקבוצת משנה מוגבלת של שירותים.
FULLEnumמצב שמאפשר גישה לכל השירותים שדורשים הרשאה.

AuthorizationInfo

Methods

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

AuthorizationStatus

מאפיינים

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

CalendarTriggerBuilder

Methods

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

ClockTriggerBuilder

Methods

שיטהסוג הערך המוחזרתיאור קצר
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

Methods

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

EventType

מאפיינים

נכססוגתיאור
CLOCKEnumהטריגר מופעל כשהאירוע המבוסס-זמן מגיע לשעה ספציפית.
ON_OPENEnumהטריגר מופעל ברגע שהמשתמש פותח את הקובץ ב-Google Docs‏, ב-Sheets או ב-Forms.
ON_EDITEnumהטריגר מופעל אחרי שהמשתמש עורך את הקובץ ב-Google Sheets (לדוגמה, מזין ערך חדש בתא, שנחשב לעריכה במקום לשינוי).
ON_FORM_SUBMITEnumהטריגר מופעל אחרי שהמשתמש משיב לטופס Google.
ON_CHANGEEnumהטריגר מופעל ברגע שהמשתמש משנה את הקובץ ב-Google Sheets (לדוגמה, הוספת שורה, שנחשבת לשינוי במקום לעריכה).
ON_EVENT_UPDATEDEnumהטריגר יופעל אחרי שייווצר, יתעדכן או יימחק אירוע ביומן Google שצוין.

FormTriggerBuilder

Methods

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

InstallationSource

מאפיינים

נכססוגתיאור
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumהאדמין התקין את התוסף בדומיין של המשתמש.
NONEEnumהסקריפט לא פועל כתוסף.
WEB_STORE_ADD_ONEnumהמשתמש התקין את התוסף מחנות האינטרנט של Chrome.

ScriptApp

מאפיינים

נכססוגתיאור
AuthModeAuthModeספירה שמזהה את הקטגוריות של השירותים המורשים ש-Apps Script יכול להריץ באמצעות פונקציה מופעלת.
AuthorizationStatusAuthorizationStatusספירה שמציינת את סטטוס ההרשאה של סקריפט.
EventTypeEventTypeספירה שמציינת את סוג האירוע שהופעל.
InstallationSourceInstallationSourceספירה שמציינת איך הסקריפט הותקן אצל המשתמש כתוסף.
TriggerSourceTriggerSourceספירה שמציינת את מקור האירוע שגורם להפעלת הטריגר.
WeekDayWeekdayEnumeration שמייצג את ימי השבוע.

Methods

שיטהסוג הערך המוחזרתיאור קצר
deleteTrigger(trigger)voidהסרת הטריגר הנתון כדי שהוא לא יפעל יותר.
getAuthorizationInfo(authMode)AuthorizationInfoהפונקציה מקבלת אובייקט שבודק אם המשתמש העניק הרשאה לכל הדרישות של הסקריפט.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoהפונקציה מקבלת אובייקט שבודק אם המשתמש העניק הרשאה להיקפי ההרשאות המבוקשים.
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התחלת התהליך של יצירת טריגר שניתן להתקנה, שמפעיל פונקציה נתונה.
requireAllScopes(authMode)voidבדיקה אם המשתמש נתן הסכמה לכל ההיקפים שבהם ביקש הסקריפט להשתמש.
requireScopes(authMode, oAuthScopes)voidבדיקה אם המשתמש נתן הסכמה להיקפי הגישה המבוקשים.

Service

Methods

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

SpreadsheetTriggerBuilder

Methods

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

StateTokenBuilder

Methods

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

Trigger

Methods

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

TriggerBuilder

Methods

שיטהסוג הערך המוחזרתיאור קצר
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

מאפיינים

נכססוגתיאור
SPREADSHEETSEnumGoogle Sheets גורם להפעלת הטריגר.
CLOCKEnumאירוע מבוסס-זמן גורם להפעלת הטריגר.
FORMSEnumGoogle Forms גורם להפעלת הטריגר.
DOCUMENTSEnumGoogle Docs גורם להפעלת הטריגר.
CALENDAREnumיומן Google גורם להפעלת הטריגר.