Base Service

底座

這項服務可存取電子郵件地址和使用者名稱等使用者資訊。此外，這個設定也會控管 Google Workspace 應用程式中的指令碼記錄和對話方塊。

類別

名稱	簡短說明
Blob	Apps Script 服務的資料交換物件。
BlobSource	介面，適用於可將資料匯出為 Blob 的物件。
Browser	這個類別可存取 Google 試算表專用的對話方塊。
Button	這個列舉代表 alert 或 PromptResponse.getSelectedButton() 傳回的預先決定本地化對話方塊按鈕，指出使用者點選對話方塊中的哪個按鈕。
ButtonSet	列舉代表預先決定的本地化一或多個對話方塊按鈕集，可新增至 alert 或 prompt。
ColorType	顏色類型
Logger	如果指令碼與標準 Cloud 專案相關聯，開發人員就能使用這個類別寫入執行記錄和 Google Cloud Logging。
Menu	Google 應用程式使用者介面執行個體中的自訂選單。
MimeType	列舉，可存取 MIME 類型宣告，不必明確輸入字串。
Month	代表一年中各月份的列舉。
PromptResponse	對 Google 應用程式使用者介面環境中顯示的 prompt 對話方塊做出回應。
RgbColor	由紅、綠、藍色通道定義的顏色。
Session	Session 類別可存取工作階段資訊，例如使用者的電子郵件地址 (在某些情況下) 和語言設定。
Ui	Google 應用程式的使用者介面環境例項，可讓指令碼新增選單、對話方塊和側欄等功能。
User	適合用於指令碼的使用者代表。
Weekday	代表星期幾的列舉。
console	如果指令碼與標準 Cloud 專案相關聯，開發人員就能使用這個類別寫入執行記錄和 Google Cloud Logging。

Blob

方法

方法	傳回類型	簡短說明
copyBlob()	Blob	傳回這個 Blob 的副本。
getAs(contentType)	Blob	以轉換為指定內容類型的 Blob 形式，傳回這個物件內的資料。
getBytes()	Byte[]	取得儲存在這個 Blob 中的資料。
getContentType()	String	取得這個 Blob 中位元組的內容類型。
getDataAsString()	String	以 UTF-8 編碼取得這個 Blob 的資料做為字串。
getDataAsString(charset)	String	以指定編碼方式取得這個 Blob 的資料 (字串形式)。
getName()	String	取得這個 Blob 的名稱。
isGoogleType()	Boolean	傳回這個 Blob 是否為 Google Workspace 檔案 (試算表、文件等)。
setBytes(data)	Blob	設定儲存在這個 Blob 中的資料。
setContentType(contentType)	Blob	設定這個 Blob 中位元組的內容類型。
setContentTypeFromExtension()	Blob	根據副檔名，設定這個 Blob 中位元組的內容類型。
setDataFromString(string)	Blob	從採用 UTF-8 編碼的字串設定這個 Blob 的資料。
setDataFromString(string, charset)	Blob	從具有指定編碼的字串設定這個 Blob 的資料。
setName(name)	Blob	設定這個 Blob 的名稱。

BlobSource

方法

方法	傳回類型	簡短說明
getAs(contentType)	Blob	以轉換為指定內容類型的 Blob 形式，傳回這個物件內的資料。
getBlob()	Blob	將這個物件內的資料以 Blob 形式傳回。

Browser

屬性

屬性	類型	說明
Buttons	ButtonSet

方法

方法	傳回類型	簡短說明
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

方法

方法	傳回類型	簡短說明
clear()	void	清除記錄。
getLog()	String	傳回目前記錄檔中的完整訊息清單。
log(data)	Logger	將資料寫入記錄。
log(format, values)	Logger	使用提供的格式和值，將格式化字串寫入記錄主控台。

Menu

方法

方法	傳回類型	簡短說明
addItem(caption, functionName)	Menu	在選單中新增項目。
addSeparator()	Menu	在選單中新增視覺分隔符。
addSubMenu(menu)	Menu	在選單中新增子選單。
addToUi()	void	將選單插入編輯器使用者介面的例項。

MimeType

屬性

屬性	類型	說明
GOOGLE_APPS_SCRIPT	Enum	Google Apps Script 專案的 MIME 類型表示法。
GOOGLE_DRAWINGS	Enum	Google 繪圖檔案的 MIME 類型表示法。
GOOGLE_DOCS	Enum	Google 文件檔案的 MIME 類型表示法。
GOOGLE_FORMS	Enum	Google 表單檔案的 MIME 類型表示法。
GOOGLE_SHEETS	Enum	Google 試算表檔案的 MIME 類型表示法。
GOOGLE_SITES	Enum	Google 協作平台檔案的 MIME 類型表示法。
GOOGLE_SLIDES	Enum	Google 簡報檔案的 MIME 類型表示法。
FOLDER	Enum	Google 雲端硬碟資料夾的 MIME 類型表示法。
SHORTCUT	Enum	Google 雲端硬碟捷徑的 MIME 類型表示法。
BMP	Enum	BMP 圖片檔案的 MIME 類型表示法 (通常為 .bmp)。
GIF	Enum	GIF 圖片檔案的 MIME 類型表示法 (通常為 .gif)。
JPEG	Enum	JPEG 圖片檔案 (通常為 .jpg) 的 MIME 類型表示法。
PNG	Enum	PNG 圖片檔的 MIME 類型表示法 (通常為 .png)。
SVG	Enum	SVG 圖片檔的 MIME 類型表示法 (通常為 .svg)。
PDF	Enum	PDF 檔案的 MIME 類型表示法 (通常為 .pdf)。
CSS	Enum	CSS 文字檔的 MIME 類型表示法 (通常為 .css)。
CSV	Enum	CSV 文字檔案的 MIME 類型表示法 (通常為 .csv)。
HTML	Enum	HTML 文字檔的 MIME 類型表示法 (通常為 .html)。
JAVASCRIPT	Enum	JavaScript 文字檔案 (通常為 .js) 的 MIME 類型表示法。
PLAIN_TEXT	Enum	純文字檔案 (通常為 .txt) 的 MIME 類型表示法。
RTF	Enum	代表 RTF 檔案的 MIME 類型 (通常為 .rtf)。
OPENDOCUMENT_GRAPHICS	Enum	OpenDocument 圖像檔案 (通常為 .odg) 的 MIME 類型表示法。
OPENDOCUMENT_PRESENTATION	Enum	OpenDocument 簡報檔案的 MIME 類型表示法 (通常為 .odp)。
OPENDOCUMENT_SPREADSHEET	Enum	OpenDocument 試算表檔案 (通常為 .ods) 的 MIME 類型表示法。
OPENDOCUMENT_TEXT	Enum	OpenDocument 文書處理檔案 (通常為 .odt) 的 MIME 類型表示法。
MICROSOFT_EXCEL	Enum	Microsoft Excel 試算表檔案的 MIME 類型表示法 (通常為 .xlsx)。
MICROSOFT_EXCEL_LEGACY	Enum	Microsoft Excel 舊版檔案 (通常為 .xls) 的 MIME 類型表示法。
MICROSOFT_POWERPOINT	Enum	Microsoft PowerPoint 簡報檔案的 MIME 類型表示法 (通常為 .pptx)。
MICROSOFT_POWERPOINT_LEGACY	Enum	Microsoft PowerPoint 舊版檔案 (通常為 .ppt) 的 MIME 類型表示法。
MICROSOFT_WORD	Enum	Microsoft Word 文件檔案 (通常為 .docx) 的 MIME 類型表示法。
MICROSOFT_WORD_LEGACY	Enum	Microsoft Word 舊版檔案 (通常為 .doc) 的 MIME 類型表示法。
ZIP	Enum	ZIP 封存檔案的 MIME 類型表示法 (通常為 .zip)。

Month

屬性

屬性	類型	說明
JANUARY	Enum	1 月 (第 1 個月)。
FEBRUARY	Enum	2 月 (第 2 個月)。
MARCH	Enum	3 月 (第 3 個月)。
APRIL	Enum	4 月 (第 4 個月)。
MAY	Enum	5 月。
JUNE	Enum	6 月 (第 6 個月)。
JULY	Enum	7 月 (第 7 個月)。
AUGUST	Enum	8 月。
SEPTEMBER	Enum	9 月 (第 9 個月)。
OCTOBER	Enum	10 月 (第 10 個月)。
NOVEMBER	Enum	11 月 (第 11 個月)。
DECEMBER	Enum	12 月 (第 12 個月)。

PromptResponse

方法

方法	傳回類型	簡短說明
getResponseText()	String	取得使用者在對話方塊輸入欄位中輸入的文字。
getSelectedButton()	Button	取得使用者點選以關閉對話方塊的按鈕。

RgbColor

方法

方法	傳回類型	簡短說明
asHexString()	String	以 CSS 樣式的 7 個字元十六進位字串 (#rrggbb) 或 9 個字元十六進位字串 (#aarrggbb) 傳回顏色。
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

屬性

屬性	類型	說明
Button	Button	這個列舉代表 alert 或 PromptResponse.getSelectedButton() 傳回的預先決定本地化對話方塊按鈕，用於指出使用者點選對話方塊中的哪個按鈕。
ButtonSet	ButtonSet	列舉代表預先決定的本地化一或多個對話方塊按鈕集，可新增至快訊或提示。

方法

方法	傳回類型	簡短說明
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

屬性

屬性	類型	說明
SUNDAY	Enum	週日。
MONDAY	Enum	星期一。
TUESDAY	Enum	星期二。
WEDNESDAY	Enum	星期三。
THURSDAY	Enum	星期四。
FRIDAY	Enum	星期五。
SATURDAY	Enum	相同格式。

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	將空白的 DEBUG 層級訊息輸出至 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。