דף זה תורגם על ידי Cloud Translation API.

Base Service

השירות הזה מספק גישה למידע על משתמשים, כמו כתובות אימייל ושמות משתמשים. הוא גם קובע אם יוצגו יומני סקריפטים ותיבות דו-שיח באפליקציות של 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`	תיפתח תיבת דו-שיח עם תיבת קלט טקסט בדפדפן של המשתמש.
`inputBox(prompt, buttons)`	`String`	תיפתח תיבת דו-שיח עם תיבת קלט טקסט בדפדפן של המשתמש.
`inputBox(title, prompt, buttons)`	`String`	תיפתח תיבת דו-שיח עם תיבת קלט טקסט בדפדפן של המשתמש.
`msgBox(prompt)`	`String`	תיבת דו-שיח עם ההודעה הרלוונטית ועם לחצן אישור תופיע בדפדפן של המשתמש.
`msgBox(prompt, buttons)`	`String`	תיפתח תיבת דו-שיח עם ההודעה והלחצנים שצוינו בדפדפן של המשתמש.
`msgBox(title, prompt, buttons)`	`String`	תיבת דו-שיח עם השם, ההודעה והלחצנים שצוינו תופיע בדפדפן של המשתמש.

`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 Script.
`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`	יצירת בונה שאפשר להשתמש בו כדי להוסיף תפריט לממשק המשתמש של העורך.
`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`	הפלט הוא הודעה ריקה ברמה ERROR ביומן של Stackdriver.
`error(formatOrObject, values)`	`void`	הפונקציה כותבת הודעה ברמה ERROR ביומן של Stackdriver.
`info()`	`void`	הפונקציה מפיקה הודעה ריקה ברמה INFO ל-Stackdriver Logging.
`info(formatOrObject, values)`	`void`	הפונקציה מפיקה הודעה ברמת INFO ל-Stackdriver Logging.
`log()`	`void`	הפונקציה מפיקה הודעה ריקה ברמת DEBUG ל-Stackdriver Logging.
`log(formatOrObject, values)`	`void`	הפלט הוא הודעה ברמת DEBUG ביומן של Stackdriver.
`time(label)`	`void`	הפעלת טיימר שבעזרתו אפשר לעקוב אחרי משך הפעולה.
`timeEnd(label)`	`void`	הפונקציה מפסיקה טיימר שהופעל קודם לכן באמצעות קריאה ל-`console.time()`.
`warn()`	`void`	הפלט הוא הודעת אזהרה ריקה ביומן של Stackdriver.
`warn(formatOrObject, values)`	`void`	הפלט הוא הודעת אזהרה ברמה WARNING ב-Stackdriver Logging.