本頁面由 Cloud Translation API 翻譯而成。

Base Service

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

類別

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

`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 檔案 (試算表、文件等)。
`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`	在使用者的瀏覽器中彈出對話方塊。
`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`	「OK」按鈕，表示應繼續作業。
`CANCEL`	`Enum`	顯示「取消」按鈕，表示不應繼續執行作業。
`YES`	`Enum`	「是」按鈕，表示對問題有正面回覆。
`NO`	`Enum`	「否」按鈕，表示對問題有負面回覆。

`ButtonSet`

屬性

屬性	類型	說明
`OK`	`Enum`	一個「確定」按鈕，表示只能關閉的資訊訊息。
`OK_CANCEL`	`Enum`	「OK」按鈕和「取消」按鈕，可讓使用者繼續執行或停止作業。
`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 圖片檔 (通常為 .bmp) 的 MIME 類型。
`GIF`	`Enum`	GIF 圖片檔 (通常是 .gif) 的 MIME 類型表示。
`JPEG`	`Enum`	JPEG 圖片檔 (通常是 .jpg) 的 MIME 類型表示。
`PNG`	`Enum`	PNG 圖片檔 (通常為 .png) 的 MIME 類型表示。
`SVG`	`Enum`	SVG 圖片檔的 MIME 類型 (通常是 .svg)。
`PDF`	`Enum`	PDF 檔案 (通常是 .pdf) 的 MIME 類型。
`CSS`	`Enum`	CSS 文字檔案 (通常是 .css) 的 MIME 類型表示。
`CSV`	`Enum`	CSV 文字檔 (通常為 .csv) 的 MIME 類型。
`HTML`	`Enum`	HTML 文字檔案 (通常是 .html) 的 MIME 類型表示。
`JAVASCRIPT`	`Enum`	表示 JavaScript 文字檔 (通常是 .js) 的 MIME 類型。
`PLAIN_TEXT`	`Enum`	表示純文字檔案 (通常是 .txt) 的 MIME 類型。
`RTF`	`Enum`	表示 RTF 類型為 RTF 格式的檔案 (通常是 .rtf)。
`OPENDOCUMENT_GRAPHICS`	`Enum`	OpenDocument 圖形檔案 (通常是 .odg) 的 MIME 類型表示。
`OPENDOCUMENT_PRESENTATION`	`Enum`	OpenDocument 呈現檔案 (通常是 .odp) 的 MIME 類型表示。
`OPENDOCUMENT_SPREADSHEET`	`Enum`	OpenDocument 試算表檔案 (通常是 .ods) 的 MIME 類型表示。
`OPENDOCUMENT_TEXT`	`Enum`	OpenDocument 文書處理檔案 (通常是 .odt) 的 MIME 類型表示。
`MICROSOFT_EXCEL`	`Enum`	Microsoft Excel 試算表檔案 (通常是 .xlsx) 的 MIME 類型。
`MICROSOFT_EXCEL_LEGACY`	`Enum`	Microsoft Excel 舊版檔案 (通常是 .xls) 的 MIME 類型。
`MICROSOFT_POWERPOINT`	`Enum`	Microsoft PowerPoint 簡報檔案 (通常是 .pptx) 的 MIME 類型。
`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 封存檔案 (通常是 .zip) 的 MIME 類型。

`Month`

屬性

屬性	類型	說明
`JANUARY`	`Enum`	1 月 (第 1 個月)。
`FEBRUARY`	`Enum`	2 月 (第 2 個月)。
`MARCH`	`Enum`	3 月 (第 3 個月)。
`APRIL`	`Enum`	4 月 (第 4 個月)。
`MAY`	`Enum`	5 月 (第 5 個月)。
`JUNE`	`Enum`	6 月 (第 6 個月)。
`JULY`	`Enum`	7 月 (月 7 日)。
`AUGUST`	`Enum`	8 月 (月 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`	將空白的偵錯層級訊息輸出至 Stackdriver Logging。
`log(formatOrObject, values)`	`void`	將偵錯層級訊息輸出至 Stackdriver Logging。
`time(label)`	`void`	啟動計時器，以便追蹤作業花費的時間。
`timeEnd(label)`	`void`	呼叫 `console.time()` 停止先前啟動的計時器。
`warn()`	`void`	將空白警告等級訊息輸出至 Stackdriver Logging。
`warn(formatOrObject, values)`	`void`	將警告層級訊息輸出至 Stackdriver Logging。