Script Service

סקריפט

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

שיעורים

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

AuthMode

מאפיינים

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

AuthorizationInfo

Methods

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

AuthorizationStatus

מאפיינים

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

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

מאפיינים

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

FormTriggerBuilder

Methods

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

Methods

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

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

מאפיינים

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