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

מאפיינים

נכססוגתיאור
ButtonsButtonSet

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

מאפיינים

נכססוגתיאור
CLOSEEnumלחצן הסגירה הרגיל שמוצג בסרגל הכותרת של כל תיבת דו-שיח.
OKEnumלחצן 'אישור', שמציין שצריך להמשיך בפעולה.
CANCELEnumלחצן 'ביטול', שמציין שאין להמשיך בפעולה.
YESEnumכפתור 'כן' שמציין תשובה חיובית לשאלה.
NOEnumכפתור עם הכיתוב 'לא', שמציין תשובה שלילית לשאלה.

ButtonSet

מאפיינים

נכססוגתיאור
OKEnumכפתור 'אישור' יחיד, שמציין הודעת מידע שאפשר רק לסגור.
OK_CANCELEnumלחצן 'אישור' ולחצן 'ביטול', שמאפשרים למשתמש להמשיך בפעולה או להפסיק אותה.
YES_NOEnumלחצן 'כן' ולחצן 'לא', שמאפשרים למשתמש לענות על שאלה בתשובה 'כן' או 'לא'.
YES_NO_CANCELEnumכפתור 'כן', כפתור 'לא' וכפתור 'ביטול', שמאפשרים למשתמש לענות על שאלה בחיוב או בשלילה או להפסיק פעולה.

ColorType

מאפיינים

נכססוגתיאור
UNSUPPORTEDEnumסוג צבע שלא נתמך.
RGBEnumצבע שמוגדר על ידי ערוצי צבע אדום, ירוק וכחול.
THEMEEnumצבע שמפנה לרשומה בערכת הצבעים של העיצוב.

Logger

Methods

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

Methods

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

MimeType

מאפיינים

נכססוגתיאור
GOOGLE_APPS_SCRIPTEnumייצוג של סוג MIME לפרויקט של סקריפט של Google Apps.
GOOGLE_DRAWINGSEnumייצוג של סוג MIME לקובץ Google Drawings.
GOOGLE_DOCSEnumייצוג של סוג MIME לקובץ Google Docs.
GOOGLE_FORMSEnumייצוג של סוג MIME לקובץ של Google Forms.
GOOGLE_SHEETSEnumייצוג של סוג MIME לקובץ Google Sheets.
GOOGLE_SITESEnumייצוג של סוג MIME של קובץ Google Sites.
GOOGLE_SLIDESEnumייצוג של סוג MIME לקובץ Google Slides.
FOLDEREnumייצוג של סוג MIME לתיקייה ב-Google Drive.
SHORTCUTEnumייצוג של סוג MIME לקיצור דרך ב-Google Drive.
BMPEnumייצוג של סוג MIME של קובץ תמונה בפורמט BMP (בדרך כלל ‎ .bmp).
GIFEnumייצוג של סוג MIME של קובץ תמונה בפורמט GIF (בדרך כלל ‎ .gif).
JPEGEnumייצוג של סוג MIME של קובץ תמונה בפורמט JPEG (בדרך כלל ‎ .jpg).
PNGEnumייצוג של סוג MIME של קובץ תמונה בפורמט PNG (בדרך כלל ‎ .png).
SVGEnumייצוג של סוג MIME לקובץ תמונה בפורמט SVG (בדרך כלל ‎ .svg).
PDFEnumייצוג של סוג MIME לקובץ PDF (בדרך כלל ‎ .pdf).
CSSEnumייצוג של סוג MIME לקובץ טקסט CSS (בדרך כלל ‎ .css).
CSVEnumייצוג של סוג MIME לקובץ טקסט בפורמט CSV (בדרך כלל ‎ .csv).
HTMLEnumייצוג של סוג MIME לקובץ טקסט HTML (בדרך כלל ‎ .html).
JAVASCRIPTEnumייצוג של סוג MIME לקובץ טקסט JavaScript (בדרך כלל ‎ .js).
PLAIN_TEXTEnumייצוג של סוג MIME לקובץ טקסט פשוט (בדרך כלל ‎ .txt).
RTFEnumייצוג של סוג MIME לקובץ טקסט עשיר (בדרך כלל ‎ .rtf).
OPENDOCUMENT_GRAPHICSEnumייצוג של סוג MIME של קובץ גרפיקה של OpenDocument (בדרך כלל ‎ .odg).
OPENDOCUMENT_PRESENTATIONEnumייצוג של סוג MIME לקובץ מצגת OpenDocument (בדרך כלל ‎ .odp).
OPENDOCUMENT_SPREADSHEETEnumייצוג של סוג MIME עבור קובץ גיליון אלקטרוני של OpenDocument (בדרך כלל ‎ .ods).
OPENDOCUMENT_TEXTEnumייצוג של סוג MIME לקובץ עיבוד תמלילים של OpenDocument (בדרך כלל ‎ .odt).
MICROSOFT_EXCELEnumייצוג של סוג MIME של קובץ גיליון אלקטרוני של Microsoft Excel (בדרך כלל ‎ .xlsx).
MICROSOFT_EXCEL_LEGACYEnumייצוג של סוג MIME לקובץ מדור קודם של Microsoft Excel (בדרך כלל ‎ .xls).
MICROSOFT_POWERPOINTEnumייצוג של סוג MIME לקובץ מצגת של Microsoft PowerPoint (בדרך כלל ‎ .pptx).
MICROSOFT_POWERPOINT_LEGACYEnumייצוג של סוג MIME לקובץ מדור קודם של Microsoft PowerPoint (בדרך כלל ‎ .ppt).
MICROSOFT_WORDEnumייצוג של סוג MIME לקובץ מסמך של Microsoft Word (בדרך כלל ‎ .docx).
MICROSOFT_WORD_LEGACYEnumייצוג של סוג MIME לקובץ מדור קודם של Microsoft Word (בדרך כלל ‎ .doc).
ZIPEnumייצוג של סוג MIME לקובץ ארכיון ZIP (בדרך כלל ‎ .zip).

Month

מאפיינים

נכססוגתיאור
JANUARYEnumינואר (חודש 1).
FEBRUARYEnumפברואר (חודש 2).
MARCHEnumמרץ (חודש 3).
APRILEnumאפריל (חודש 4).
MAYEnumמאי (חודש 5).
JUNEEnumיוני (חודש 6).
JULYEnumיולי (חודש 7).
AUGUSTEnumאוגוסט (חודש 8).
SEPTEMBEREnumספטמבר (חודש 9).
OCTOBEREnumאוקטובר (חודש 10).
NOVEMBEREnumנובמבר (חודש 11).
DECEMBEREnumדצמבר (חודש 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

מאפיינים

נכססוגתיאור
ButtonButtonסוג enum שמייצג לחצנים קבועים מראש בתיבת דו-שיח, שמותאמים לשפה המקומית ומוחזרים על ידי alert או PromptResponse.getSelectedButton() כדי לציין על איזה לחצן בתיבת הדו-שיח המשתמש לחץ.
ButtonSetButtonSetסוג 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

מאפיינים

נכססוגתיאור
SUNDAYEnumיום ראשון.
MONDAYEnumיום שני.
TUESDAYEnumיום שלישי.
WEDNESDAYEnumיום רביעי.
THURSDAYEnumיום חמישי.
FRIDAYEnumיום שישי.
SATURDAYEnumשבת.

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.