Base Service

Base

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

מחלקות

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

Blob

שיטות

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

שיטות

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

Browser

תכונות

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

שיטות

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

תכונות

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

ButtonSet

תכונות

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

ColorType

תכונות

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

Logger

שיטות

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

שיטות

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

שיטות

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

RgbColor

שיטות

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

Session

שיטות

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

Ui

תכונות

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

שיטות

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

שיטות

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

Weekday

תכונות

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

console

שיטות

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