Script Service

סקריפט

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

שיעורים

שםתיאור קצר
AuthModeספירה שמזהה אילו קטגוריות של שירותים מורשים יכולות לפעול ב-Apps Script באמצעות פונקציה שהופעלה על ידי טריגר.
AuthorizationInfoאובייקט שבודק אם המשתמש העניק הרשאה להיקפי ההרשאות הנדרשים של הסקריפט.
AuthorizationStatusספירה שמציינת את סטטוס ההרשאה של סקריפט.
CalendarTriggerBuilder‫Builder לטריגרים של היומן.
ClockTriggerBuilder‫Builder להפעלות חוזרות לפי שעון.
DocumentTriggerBuilder‫builder לטריגרים של מסמכים.
EventTypeספירה שמציינת את סוג האירוע שהופעל.
FormTriggerBuilderכלי ליצירת טריגרים לטפסים.
InstallationSourceספירה שמציינת איך הסקריפט הותקן כתוסף עבור המשתמש הנוכחי.
ScriptAppגישה לפרסום סקריפטים ולטריגרים וביצוע פעולות בהם.
Serviceגישה לפרסום סקריפטים וביצוע שינויים בו.
SpreadsheetTriggerBuilder‫Builder לטריגרים של גיליונות אלקטרוניים.
StateTokenBuilderמאפשרת לסקריפטים ליצור אסימוני מצב שאפשר להשתמש בהם בממשקי API של קריאה חוזרת (כמו תהליכי OAuth).
Triggerטריגר לסקריפט.
TriggerBuilder‫builder גנרי לטריגרים של סקריפטים.
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 Forms.
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מחזירה builder ליצירת טריגרים של יומן.
timeBased()ClockTriggerBuilderיוצרת ומחזירה ClockTriggerBuilder ליצירת טריגרים מבוססי-זמן.

TriggerSource

מאפיינים

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