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

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`	在使用者的瀏覽器中彈出對話方塊，其中包含文字輸入方塊。
`inputBox(prompt, buttons)`	`String`	在使用者的瀏覽器中彈出對話方塊，其中包含文字輸入方塊。
`inputBox(title, prompt, buttons)`	`String`	在使用者的瀏覽器中彈出對話方塊，其中包含文字輸入方塊。
`msgBox(prompt)`	`String`	在使用者的瀏覽器中彈出對話方塊，其中包含指定訊息和「OK」按鈕。
`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`	「確定」和「取消」按鈕，可讓使用者繼續或停止操作。
`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 Sites 檔案的 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 圖片檔案 (通常為 .svg) 的 MIME 類型表示法。
`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) 的 MIME 類型表示法。
`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 月。
`APRIL`	`Enum`	4 月 (第 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`

方法

方法	傳回類型	簡短說明
`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`	建立可用於在編輯器的「Extensions」選單中插入子選單的建構工具。
`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。