Script Service

סקריפט

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

שיעורים

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

AuthMode

מאפיינים

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

AuthorizationInfo

Methods

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

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מספור שמציין את המקור של האירוע שגורם להפעלת הטריגר.
WeekDayWeekdayספירה שמייצגת את ימות השבוע.

Methods

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

מאפיינים

נכססוגתיאור
SPREADSHEETSEnumהפעולה ב-Google Sheets גורמת להפעלת הטריגר.
CLOCKEnumאירוע שמבוסס על זמן גורם להפעלת הטריגר.
FORMSEnumהטריגר מופעל על ידי Google Forms.
DOCUMENTSEnum‫Google Docs גורם להפעלת הטריגר.
CALENDAREnumיומן Google גורם להפעלת הטריגר.