Base Service

Base

השירות הזה מספק גישה לפרטי משתמשים כמו כתובות אימייל ושמות משתמשים. ההגדרה הזו שולטת גם ביומני סקריפטים ובתיבות דו-שיח באפליקציות של Google Workspace.

שיעורים

שם	תיאור קצר
Blob	אובייקט להחלפת נתונים בשירותי Apps Script.
BlobSource	ממשק לאובייקטים שיכולים לייצא את הנתונים שלהם כ-Blob.
Browser	המחלקות האלה מספקות גישה לתיבות דו-שיח שספציפיות ל-Google Sheets.
Button	סוג enum שמייצג לחצני דו-שיח מקומיים ומוגדרים מראש שמוחזרים על ידי alert או PromptResponse.getSelectedButton() כדי לציין על איזה לחצן בתיבת דו-שיח המשתמש לחץ.
ButtonSet	סוג enum שמייצג קבוצות קבועות מראש של לחצני תיבת דו-שיח, שמותאמות לשוק המקומי וניתן להוסיף אותן ל-alert או ל-prompt.
ColorType	סוגי הצבעים
Logger	המחלק הזה מאפשר למפתח לכתוב ביומן הביצוע ול-Google Cloud Logging אם הסקריפט משויך לפרויקט רגיל ב-Cloud.
Menu	תפריט מותאם אישית במופע של ממשק המשתמש של אפליקציית Google.
MimeType	ספירה שמאפשרת גישה להצהרות של סוגי MIME בלי להקליד את המחרוזות באופן מפורש.
Month	סוג enum שמייצג את חודשי השנה.
PromptResponse	תשובה לתיבת דו-שיח prompt שמוצגת בסביבת ממשק המשתמש של אפליקציית Google.
RgbColor	צבע שמוגדר על ידי ערוצי צבע אדום, ירוק וכחול.
Session	המחלק Session מספק גישה לפרטי הסשן, כמו כתובת האימייל של המשתמש (במקרים מסוימים) והגדרת השפה.
Ui	מופע של סביבת ממשק המשתמש לאפליקציית Google שמאפשר לסקריפט להוסיף תכונות כמו תפריטים, תיבות דו-שיח וסרגלי צד.
User	ייצוג של משתמש, שמתאים לסקריפטים.
Weekday	סוג enum שמייצג את ימי השבוע.
console	המחלק הזה מאפשר למפתח לכתוב ביומן הביצוע ול-Google Cloud Logging אם הסקריפט משויך לפרויקט רגיל ב-Cloud.

Blob

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
copyBlob()	Blob	מחזירה עותק של ה-blob הזה.
getAs(contentType)	Blob	החזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין.
getBytes()	Byte[]	מקבל את הנתונים שמאוחסנים ב-blob הזה.
getContentType()	String	מחזירה את סוג התוכן של הבייטים ב-Blob הזה.
getDataAsString()	String	מחזירה את הנתונים של ה-blob הזה כמחרוזת עם קידוד UTF-8.
getDataAsString(charset)	String	הפונקציה מחזירה את הנתונים של ה-blob הזה כמחרוזת עם הקידוד שצוין.
getName()	String	מחזירה את השם של ה-blob הזה.
isGoogleType()	Boolean	הפונקציה מחזירה אם ה-blob הזה הוא קובץ Google Workspace (Sheets,‏ Docs וכו').
setBytes(data)	Blob	מגדיר את הנתונים שמאוחסנים ב-blob הזה.
setContentType(contentType)	Blob	מגדיר את סוג התוכן של הבייטים ב-Blob הזה.
setContentTypeFromExtension()	Blob	ההגדרה קובעת את סוג התוכן של הבייטים ב-blob הזה על סמך סיומת הקובץ.
setDataFromString(string)	Blob	הפונקציה מגדירה את הנתונים של ה-blob הזה ממחרוזת עם קידוד UTF-8.
setDataFromString(string, charset)	Blob	מגדירה את הנתונים של ה-blob הזה ממחרוזת עם הקידוד שצוין.
setName(name)	Blob	מגדיר את השם של ה-blob הזה.

BlobSource

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
getAs(contentType)	Blob	החזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין.
getBlob()	Blob	החזרת הנתונים בתוך האובייקט הזה כ-blob.

Browser

מאפיינים

נכס	סוג	תיאור
Buttons	ButtonSet

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
inputBox(prompt)	String|null	מוצגת תיבת דו-שיח עם תיבת הזנת טקסט בדפדפן של המשתמש.
inputBox(prompt, buttons)	String|null	מוצגת תיבת דו-שיח עם תיבת הזנת טקסט בדפדפן של המשתמש.
inputBox(title, prompt, buttons)	String|null	מוצגת תיבת דו-שיח עם תיבת הזנת טקסט בדפדפן של המשתמש.
msgBox(prompt)	String|null	מוצגת תיבת דו-שיח עם ההודעה שצוינה וכפתור 'אישור' בדפדפן של המשתמש.
msgBox(prompt, buttons)	String|null	תיבת דו-שיח קופצת עם ההודעה שצוינה והלחצנים שצוינו בדפדפן של המשתמש.
msgBox(title, prompt, buttons)	String|null	תיבת דו-שיח קופצת עם הכותרת, ההודעה והלחצנים שצוינו בדפדפן של המשתמש.

Button

מאפיינים

נכס	סוג	תיאור
CLOSE	Enum	לחצן הסגירה הרגיל שמוצג בסרגל הכותרת של כל תיבת דו-שיח.
OK	Enum	לחצן 'אישור', שמציין שצריך להמשיך בפעולה.
CANCEL	Enum	לחצן 'ביטול', שמציין שאין להמשיך בפעולה.
YES	Enum	כפתור 'כן' שמציין תשובה חיובית לשאלה.
NO	Enum	כפתור עם הכיתוב 'לא', שמציין תשובה שלילית לשאלה.

ButtonSet

מאפיינים

נכס	סוג	תיאור
OK	Enum	כפתור 'אישור' יחיד, שמציין הודעת מידע שאפשר רק לסגור.
OK_CANCEL	Enum	לחצן 'אישור' ולחצן 'ביטול', שמאפשרים למשתמש להמשיך בפעולה או להפסיק אותה.
YES_NO	Enum	לחצן 'כן' ולחצן 'לא', שמאפשרים למשתמש לענות על שאלה בתשובה 'כן' או 'לא'.
YES_NO_CANCEL	Enum	כפתור 'כן', כפתור 'לא' וכפתור 'ביטול', שמאפשרים למשתמש לענות על שאלה בחיוב או בשלילה או להפסיק פעולה.

ColorType

מאפיינים

נכס	סוג	תיאור
UNSUPPORTED	Enum	סוג צבע שלא נתמך.
RGB	Enum	צבע שמוגדר על ידי ערוצי צבע אדום, ירוק וכחול.
THEME	Enum	צבע שמפנה לרשומה בערכת הצבעים של העיצוב.

Logger

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
clear()	void	ניקוי היומן.
getLog()	String	הפונקציה מחזירה רשימה מלאה של ההודעות ביומן הנוכחי.
log(data)	Logger	הנתונים נכתבים ביומן.
log(format, values)	Logger	כותבת מחרוזת בפורמט מסוים במסוף הרישום ביומן, באמצעות הפורמט והערכים שסופקו.

Menu

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
addItem(caption, functionName)	Menu	הוספת פריט לתפריט.
addSeparator()	Menu	הוספת מפריד חזותי לתפריט.
addSubMenu(menu)	Menu	הוספת תפריט משנה לתפריט.
addToUi()	void	התפריט מוכנס למופע של ממשק המשתמש של הכלי לעריכה.

MimeType

מאפיינים

נכס	סוג	תיאור
GOOGLE_APPS_SCRIPT	Enum	ייצוג של סוג MIME לפרויקט של סקריפט של Google Apps.
GOOGLE_DRAWINGS	Enum	ייצוג של סוג MIME לקובץ Google Drawings.
GOOGLE_DOCS	Enum	ייצוג של סוג MIME לקובץ Google Docs.
GOOGLE_FORMS	Enum	ייצוג של סוג MIME לקובץ של Google Forms.
GOOGLE_SHEETS	Enum	ייצוג של סוג MIME לקובץ Google Sheets.
GOOGLE_SITES	Enum	ייצוג של סוג MIME של קובץ Google Sites.
GOOGLE_SLIDES	Enum	ייצוג של סוג MIME לקובץ Google Slides.
FOLDER	Enum	ייצוג של סוג MIME לתיקייה ב-Google Drive.
SHORTCUT	Enum	ייצוג של סוג MIME לקיצור דרך ב-Google Drive.
BMP	Enum	ייצוג של סוג MIME של קובץ תמונה בפורמט BMP (בדרך כלל ‎ .bmp).
GIF	Enum	ייצוג של סוג MIME של קובץ תמונה בפורמט GIF (בדרך כלל ‎ .gif).
JPEG	Enum	ייצוג של סוג MIME של קובץ תמונה בפורמט JPEG (בדרך כלל ‎ .jpg).
PNG	Enum	ייצוג של סוג MIME של קובץ תמונה בפורמט PNG (בדרך כלל ‎ .png).
SVG	Enum	ייצוג של סוג MIME לקובץ תמונה בפורמט SVG (בדרך כלל ‎ .svg).
PDF	Enum	ייצוג של סוג MIME לקובץ PDF (בדרך כלל ‎ .pdf).
CSS	Enum	ייצוג של סוג MIME לקובץ טקסט CSS (בדרך כלל ‎ .css).
CSV	Enum	ייצוג של סוג MIME לקובץ טקסט בפורמט CSV (בדרך כלל ‎ .csv).
HTML	Enum	ייצוג של סוג MIME לקובץ טקסט HTML (בדרך כלל ‎ .html).
JAVASCRIPT	Enum	ייצוג של סוג MIME לקובץ טקסט JavaScript (בדרך כלל ‎ .js).
PLAIN_TEXT	Enum	ייצוג של סוג MIME לקובץ טקסט פשוט (בדרך כלל ‎ .txt).
RTF	Enum	ייצוג של סוג MIME לקובץ טקסט עשיר (בדרך כלל ‎ .rtf).
OPENDOCUMENT_GRAPHICS	Enum	ייצוג של סוג MIME של קובץ גרפיקה של OpenDocument (בדרך כלל ‎ .odg).
OPENDOCUMENT_PRESENTATION	Enum	ייצוג של סוג MIME לקובץ מצגת OpenDocument (בדרך כלל ‎ .odp).
OPENDOCUMENT_SPREADSHEET	Enum	ייצוג של סוג MIME עבור קובץ גיליון אלקטרוני של OpenDocument (בדרך כלל ‎ .ods).
OPENDOCUMENT_TEXT	Enum	ייצוג של סוג MIME לקובץ עיבוד תמלילים של OpenDocument (בדרך כלל ‎ .odt).
MICROSOFT_EXCEL	Enum	ייצוג של סוג MIME של קובץ גיליון אלקטרוני של Microsoft Excel (בדרך כלל ‎ .xlsx).
MICROSOFT_EXCEL_LEGACY	Enum	ייצוג של סוג MIME לקובץ מדור קודם של Microsoft Excel (בדרך כלל ‎ .xls).
MICROSOFT_POWERPOINT	Enum	ייצוג של סוג MIME לקובץ מצגת של Microsoft PowerPoint (בדרך כלל ‎ .pptx).
MICROSOFT_POWERPOINT_LEGACY	Enum	ייצוג של סוג MIME לקובץ מדור קודם של Microsoft PowerPoint (בדרך כלל ‎ .ppt).
MICROSOFT_WORD	Enum	ייצוג של סוג MIME לקובץ מסמך של Microsoft Word (בדרך כלל ‎ .docx).
MICROSOFT_WORD_LEGACY	Enum	ייצוג של סוג MIME לקובץ מדור קודם של Microsoft Word (בדרך כלל ‎ .doc).
ZIP	Enum	ייצוג של סוג MIME לקובץ ארכיון ZIP (בדרך כלל ‎ .zip).

Month

מאפיינים

נכס	סוג	תיאור
JANUARY	Enum	ינואר (חודש 1).
FEBRUARY	Enum	פברואר (חודש 2).
MARCH	Enum	מרץ (חודש 3).
APRIL	Enum	אפריל (חודש 4).
MAY	Enum	מאי (חודש 5).
JUNE	Enum	יוני (חודש 6).
JULY	Enum	יולי (חודש 7).
AUGUST	Enum	אוגוסט (חודש 8).
SEPTEMBER	Enum	ספטמבר (חודש 9).
OCTOBER	Enum	אוקטובר (חודש 10).
NOVEMBER	Enum	נובמבר (חודש 11).
DECEMBER	Enum	דצמבר (חודש 12).

PromptResponse

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
getResponseText()	String	מחזירה את הטקסט שהמשתמש הזין בשדה הקלט של תיבת הדו-שיח.
getSelectedButton()	Button	מחזירה את הכפתור שהמשתמש לחץ עליו כדי לסגור את תיבת הדו-שיח.

RgbColor

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
asHexString()	String	הפונקציה מחזירה את הצבע כמחרוזת הקסדצימלית בת 7 תווים בסגנון CSS‏ (‎#rrggbb) או כמחרוזת הקסדצימלית בת 9 תווים (‎#aarrggbb).
getBlue()	Integer	הערוץ הכחול של הצבע הזה, כמספר מ-0 עד 255.
getColorType()	ColorType	קבלת הסוג של הצבע הזה.
getGreen()	Integer	הערוץ הירוק של הצבע הזה, כמספר מ-0 עד 255.
getRed()	Integer	הערוץ האדום של הצבע הזה, כמספר מ-0 עד 255.

Session

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
getActiveUser()	User	קבלת מידע על המשתמש הנוכחי.
getActiveUserLocale()	String	מחזירה את הגדרת השפה של המשתמש הנוכחי כמחרוזת – לדוגמה, en לאנגלית.
getEffectiveUser()	User	מקבל מידע על המשתמש שהסקריפט פועל תחת הסמכות שלו.
getScriptTimeZone()	String	הפונקציה מחזירה את אזור הזמן של הסקריפט.
getTemporaryActiveUserKey()	String	מקבלים מפתח זמני שייחודי למשתמש הפעיל, אבל לא חושף את זהות המשתמש.

Ui

מאפיינים

נכס	סוג	תיאור
Button	Button	סוג enum שמייצג לחצנים קבועים מראש בתיבת דו-שיח, שמותאמים לשפה המקומית ומוחזרים על ידי alert או PromptResponse.getSelectedButton() כדי לציין על איזה לחצן בתיבת הדו-שיח המשתמש לחץ.
ButtonSet	ButtonSet	סוג enum שמייצג קבוצות קבועות מראש של לחצני תיבת דו-שיח, שמותאמות לשוק מקומי ויכולות להכיל לחצן אחד או יותר. אפשר להוסיף אותן להתראה או להנחיה.

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
alert(prompt)	Button	תיבת דו-שיח נפתחת בכלי העריכה של המשתמש עם ההודעה שצוינה וכפתור 'אישור'.
alert(prompt, buttons)	Button	פותח תיבת דו-שיח בעורך של המשתמש עם ההודעה וסט הלחצנים שצוינו.
alert(title, prompt, buttons)	Button	פותח תיבת דו-שיח בעורך של המשתמש עם הכותרת, ההודעה וסט הלחצנים שצוינו.
createAddonMenu()	Menu	יוצר בונה שאפשר להשתמש בו כדי להוסיף תפריט משנה לתפריט התוספים של הכלי לעריכה.
createMenu(caption)	Menu	יוצר builder שאפשר להשתמש בו כדי להוסיף תפריט לממשק המשתמש של הכלי לעריכה.
prompt(prompt)	PromptResponse	פותח תיבת דו-שיח להזנת קלט בעורך של המשתמש עם ההודעה שצוינה וכפתור 'אישור'.
prompt(prompt, buttons)	PromptResponse	פותחת תיבת דו-שיח לקלט בעורך של המשתמש עם ההודעה וסט הכפתורים שצוינו.
prompt(title, prompt, buttons)	PromptResponse	פותח תיבת דו-שיח להזנת נתונים בעורך של המשתמש עם הכותרת, ההודעה וסט הלחצנים שצוינו.
showModalDialog(userInterface, title)	void	פותח תיבת דו-שיח מודאלית בכלי העריכה של המשתמש עם תוכן מותאם אישית בצד הלקוח.
showModelessDialog(userInterface, title)	void	פותח תיבת דו-שיח לא מודאלית בעורך של המשתמש עם תוכן מותאם אישית בצד הלקוח.
showSidebar(userInterface)	void	פותח סרגל צד בעורך של המשתמש עם תוכן מותאם אישית בצד הלקוח.

User

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
getEmail()	String	מקבל את כתובת האימייל של המשתמש, אם היא זמינה.

Weekday

מאפיינים

נכס	סוג	תיאור
SUNDAY	Enum	יום ראשון.
MONDAY	Enum	יום שני.
TUESDAY	Enum	יום שלישי.
WEDNESDAY	Enum	יום רביעי.
THURSDAY	Enum	יום חמישי.
FRIDAY	Enum	יום שישי.
SATURDAY	Enum	שבת.

console

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
error()	void	הפונקציה מוציאה הודעה ריקה ברמת השגיאה ל-Stackdriver Logging.
error(formatOrObject, values)	void	הפונקציה מוציאה הודעה ברמת ERROR ל-Stackdriver Logging.
info()	void	פלט של הודעה ריקה ברמת INFO ל-Stackdriver Logging.
info(formatOrObject, values)	void	הפונקציה מוציאה הודעה ברמת INFO ל-Stackdriver Logging.
log()	void	הפלט הוא הודעה ריקה ברמת DEBUG ב-Stackdriver Logging.
log(formatOrObject, values)	void	הפונקציה מוציאה הודעה ברמת DEBUG ל-Stackdriver Logging.
time(label)	void	הפעלת טיימר שאפשר להשתמש בו כדי לעקוב אחרי משך הזמן של פעולה.
timeEnd(label)	void	מפסיק טיימר שהופעל קודם לכן על ידי קריאה ל-console.time().
warn()	void	הפונקציה מוציאה הודעה ריקה ברמת אזהרה ל-Stackdriver Logging.
warn(formatOrObject, values)	void	הפונקציה מוציאה הודעה ברמת אזהרה ל-Stackdriver Logging.