Class Spreadsheet

試算表

存取及修改 Google 試算表檔案。常見的操作包括新增工作表和新增協作者。

方法

方法	傳回類型	簡短說明
addDeveloperMetadata(key)	Spreadsheet	將含有指定鍵的開發人員中繼資料新增至頂層試算表。
addDeveloperMetadata(key, visibility)	Spreadsheet	將開發人員中繼資料新增至試算表，並指定鍵和瀏覽權限。
addDeveloperMetadata(key, value)	Spreadsheet	將開發人員中繼資料 (含指定鍵和值) 新增至試算表。
addDeveloperMetadata(key, value, visibility)	Spreadsheet	在試算表中新增開發人員中繼資料，並指定鍵、值和瀏覽權限。
addEditor(emailAddress)	Spreadsheet	將指定使用者新增至 Spreadsheet 的編輯者清單。
addEditor(user)	Spreadsheet	將指定使用者新增至 Spreadsheet 的編輯者清單。
addEditors(emailAddresses)	Spreadsheet	將指定的使用者陣列新增至 Spreadsheet 的編輯者清單。
addMenu(name, subMenus)	void	在試算表 UI 中建立新選單。
addViewer(emailAddress)	Spreadsheet	將指定使用者新增至 Spreadsheet 的觀眾名單。
addViewer(user)	Spreadsheet	將指定使用者新增至 Spreadsheet 的觀眾名單。
addViewers(emailAddresses)	Spreadsheet	將指定的使用者陣列新增至 Spreadsheet 的觀眾清單。
appendRow(rowContents)	Sheet	將資料列附加至工作表中目前資料區域的底部。
autoResizeColumn(columnPosition)	Sheet	將指定欄的寬度設為適合其內容的寬度。
copy(name)	Spreadsheet	複製試算表並傳回新試算表。
createDeveloperMetadataFinder()	DeveloperMetadataFinder	傳回 DeveloperMetadataFinder，用於在這個試算表的範圍內尋找開發人員中繼資料。
createTextFinder(findText)	TextFinder	為試算表建立文字尋找器，可用於尋找及取代試算表中的文字。
deleteActiveSheet()	Sheet	刪除目前的活頁。
deleteColumn(columnPosition)	Sheet	刪除指定欄位置的資料欄。
deleteColumns(columnPosition, howMany)	void	從指定的欄位開始，刪除多個欄。
deleteRow(rowPosition)	Sheet	刪除指定資料列位置的資料列。
deleteRows(rowPosition, howMany)	void	從指定的資料列位置開始，刪除多個資料列。
deleteSheet(sheet)	void	刪除指定的工作表。
duplicateActiveSheet()	Sheet	複製使用中的試算表，並將其設為使用中的試算表。
getActiveCell()	Range	傳回這個工作表中目前的儲存格。
getActiveRange()	Range	傳回有效工作表中的選取範圍，如果沒有有效範圍，則傳回 null。
getActiveRangeList()	RangeList	傳回有效工作表中有效範圍的清單，如果沒有有效範圍，則傳回 null。
getActiveSheet()	Sheet	取得試算表中的活動工作表。
getAs(contentType)	Blob	將此物件內的資料傳回為轉換為指定內容類型的 Blob。
getBandings()	Banding[]	傳回此試算表中的所有頻帶。
getBlob()	Blob	將此物件內的資料以 blob 格式傳回。
getColumnWidth(columnPosition)	Integer	取得指定欄的寬度 (以像素為單位)。
getCurrentCell()	Range	傳回目前工作表中的目前儲存格，如果沒有目前儲存格，則傳回 null。
getDataRange()	Range	傳回與資料所在維度相對應的 Range。
getDataSourceFormulas()	DataSourceFormula[]	取得所有資料來源公式。
getDataSourcePivotTables()	DataSourcePivotTable[]	取得所有資料來源資料透視表。
getDataSourceRefreshSchedules()	DataSourceRefreshSchedule[]	取得此試算表的重新整理時間表。
getDataSourceSheets()	DataSourceSheet[]	傳回試算表中的所有資料來源工作表。
getDataSourceTables()	DataSourceTable[]	取得所有資料來源資料表。
getDataSources()	DataSource[]	傳回試算表中的所有資料來源。
getDeveloperMetadata()	DeveloperMetadata[]	取得與頂層試算表相關聯的開發人員中繼資料。
getEditors()	User[]	取得這個 Spreadsheet 的編輯者清單。
getFormUrl()	String	傳回表單的網址，該表單會將回覆傳送至此試算表；如果此試算表沒有關聯的表單，則傳回 null。
getFrozenColumns()	Integer	傳回已凍結欄的數量。
getFrozenRows()	Integer	傳回已凍結的資料列數。
getId()	String	取得這個試算表的專屬 ID。
getImages()	OverGridImage[]	傳回工作表上所有格線外的圖片。
getIterativeCalculationConvergenceThreshold()	Number	傳回迭代計算期間使用的閾值。
getLastColumn()	Integer	傳回最後一列內容的位置。
getLastRow()	Integer	傳回含有內容的最後一列位置。
getMaxIterativeCalculationCycles()	Integer	傳回在疊代計算期間要使用的疊代次數上限。
getName()	String	取得文件名稱。
getNamedRanges()	NamedRange[]	取得這份試算表中的所有命名範圍。
getNumSheets()	Integer	傳回這個試算表中的工作表數量。
getOwner()	User	傳回文件的擁有者，或共用雲端硬碟中文件的 null。
getPredefinedSpreadsheetThemes()	SpreadsheetTheme[]	傳回預先定義主題的清單。
getProtections(type)	Protection[]	取得代表試算表中所有受保護範圍或工作表的物件陣列。
getRange(a1Notation)	Range	傳回 A1 或 R1C1 符號指定的範圍。
getRangeByName(name)	Range	傳回命名範圍，如果找不到具有指定名稱的範圍，則傳回 null。
getRangeList(a1Notations)	RangeList	傳回 RangeList 集合，代表由非空白的 A1 符號或 R1C1 符號指定的同一工作表中的範圍。
getRecalculationInterval()	RecalculationInterval	傳回此試算表的計算間隔。
getRowHeight(rowPosition)	Integer	取得指定資料列的高度 (以像素為單位)。
getSelection()	Selection	傳回試算表中目前的 Selection。
getSheetByName(name)	Sheet	傳回具有指定名稱的工作表。
getSheetId()	Integer	傳回此物件所代表的工作表 ID。
getSheetName()	String	傳回工作表名稱。
getSheetValues(startRow, startColumn, numRows, numColumns)	Object[][]	傳回這個範圍的矩形格狀值，從指定座標開始。
getSheets()	Sheet[]	取得此試算表中的所有工作表。
getSpreadsheetLocale()	String	取得試算表語言代碼。
getSpreadsheetTheme()	SpreadsheetTheme	傳回試算表目前的主題，如果未套用主題，則傳回 null。
getSpreadsheetTimeZone()	String	取得試算表的時區。
getUrl()	String	傳回指定試算表的網址。
getViewers()	User[]	取得這個 Spreadsheet 的檢視者和加註者清單。
hideColumn(column)	void	隱藏指定範圍內的資料欄。
hideRow(row)	void	隱藏指定範圍內的資料列。
insertColumnAfter(afterPosition)	Sheet	在指定的資料欄位置後插入資料欄。
insertColumnBefore(beforePosition)	Sheet	在指定的資料欄位置前插入資料欄。
insertColumnsAfter(afterPosition, howMany)	Sheet	在指定的資料欄位置後方插入指定數量的資料欄。
insertColumnsBefore(beforePosition, howMany)	Sheet	在指定的資料欄位置前插入多個資料欄。
insertDataSourceSheet(spec)	DataSourceSheet	在試算表中插入新的 DataSourceSheet，並開始執行資料。
insertImage(blobSource, column, row)	OverGridImage	在指定的資料列和欄中，將 Spreadsheet 插入文件中做為圖片。
insertImage(blobSource, column, row, offsetX, offsetY)	OverGridImage	在指定的資料列和資料欄中，以圖片形式插入 Spreadsheet，並加上像素偏移。
insertImage(url, column, row)	OverGridImage	在文件中插入圖片，位置為指定的列和欄。
insertImage(url, column, row, offsetX, offsetY)	OverGridImage	在文件中插入圖片，並指定圖片的列和欄以及像素偏移量。
insertRowAfter(afterPosition)	Sheet	在指定的資料列位置後插入資料列。
insertRowBefore(beforePosition)	Sheet	在指定的資料列位置前插入資料列。
insertRowsAfter(afterPosition, howMany)	Sheet	在指定的資料列位置後插入多個資料列。
insertRowsBefore(beforePosition, howMany)	Sheet	在指定的資料列位置前插入多個資料列。
insertSheet()	Sheet	使用預設工作表名稱，在試算表中插入新的工作表。
insertSheet(sheetIndex)	Sheet	在指定索引處，將新工作表插入試算表中。
insertSheet(sheetIndex, options)	Sheet	在指定索引處，將新工作表插入試算表中，並使用選用的進階引數。
insertSheet(options)	Sheet	使用預設工作表名稱和選用的進階引數，在試算表中插入新的工作表。
insertSheet(sheetName)	Sheet	在試算表中插入指定名稱的新工作表。
insertSheet(sheetName, sheetIndex)	Sheet	在指定索引中，將新工作表插入試算表中，並使用指定名稱。
insertSheet(sheetName, sheetIndex, options)	Sheet	在指定索引處，將新工作表插入試算表中，並使用選用的進階引數。
insertSheet(sheetName, options)	Sheet	在試算表中插入新工作表，並使用指定名稱和選用的進階引數。
insertSheetWithDataSourceTable(spec)	Sheet	在試算表中插入新工作表，使用指定的資料來源規格建立跨越整個試算表的 DataSourceTable，並開始執行資料。
isColumnHiddenByUser(columnPosition)	Boolean	傳回使用者是否隱藏指定資料欄。
isIterativeCalculationEnabled()	Boolean	傳回這個試算表中是否啟用反覆運算功能。
isRowHiddenByFilter(rowPosition)	Boolean	傳回指定資料列是否遭到篩選器 (而非篩選器檢視畫面) 隱藏。
isRowHiddenByUser(rowPosition)	Boolean	傳回使用者是否隱藏指定資料列。
moveActiveSheet(pos)	void	將目前的活頁移至工作表清單中的指定位置。
moveChartToObjectSheet(chart)	Sheet	建立新的 SheetType.OBJECT 工作表，並將提供的圖表移至該工作表。
refreshAllDataSources()	void	重新整理所有支援的資料來源及其連結的資料來源物件，並略過無效的資料來源物件。
removeEditor(emailAddress)	Spreadsheet	將指定使用者從 Spreadsheet 的編輯者清單中移除。
removeEditor(user)	Spreadsheet	將指定使用者從 Spreadsheet 的編輯者清單中移除。
removeMenu(name)	void	移除 addMenu(name, subMenus) 新增的選單。
removeNamedRange(name)	void	刪除具有指定名稱的已命名範圍。
removeViewer(emailAddress)	Spreadsheet	將指定使用者從 Spreadsheet 的觀眾和留言者名單中移除。
removeViewer(user)	Spreadsheet	將指定使用者從 Spreadsheet 的觀眾和留言者名單中移除。
rename(newName)	void	重新命名文件。
renameActiveSheet(newName)	void	將目前的活動工作表重新命名為指定的新名稱。
resetSpreadsheetTheme()	SpreadsheetTheme	移除已套用的主題，並在試算表中設定預設主題。
setActiveRange(range)	Range	將指定的範圍設為有效工作表中的 active range，範圍內左上角的儲存格為 current cell。
setActiveRangeList(rangeList)	RangeList	將指定的範圍清單設為作用中工作表中的 active ranges。
setActiveSelection(range)	Range	設定此工作表的有效選取區域。
setActiveSelection(a1Notation)	Range	根據 A1 或 R1C1 符號指定，設定有效的選取範圍。
setActiveSheet(sheet)	Sheet	將指定的工作表設為試算表中的活動工作表。
setActiveSheet(sheet, restoreSelection)	Sheet	將指定的工作表設為試算表中的有效工作表，並提供選項，可還原該工作表中最近的選取項目。
setColumnWidth(columnPosition, width)	Sheet	以像素為單位，設定指定欄的寬度。
setCurrentCell(cell)	Range	將指定的儲存格設為 current cell。
setFrozenColumns(columns)	void	凍結指定數量的資料欄。
setFrozenRows(rows)	void	凍結指定的資料列數。
setIterativeCalculationConvergenceThreshold(minThreshold)	Spreadsheet	設定迭代計算的最低門檻值。
setIterativeCalculationEnabled(isEnabled)	Spreadsheet	設定是否在試算表中啟用反覆運算。
setMaxIterativeCalculationCycles(maxIterations)	Spreadsheet	設定在疊代計算期間應執行的計算疊代次數上限。
setNamedRange(name, range)	void	為範圍命名。
setRecalculationInterval(recalculationInterval)	Spreadsheet	設定這個試算表的重新計算頻率。
setRowHeight(rowPosition, height)	Sheet	以像素為單位，設定指定資料列的行高。
setSpreadsheetLocale(locale)	void	設定試算表語言代碼。
setSpreadsheetTheme(theme)	SpreadsheetTheme	設定試算表的主題。
setSpreadsheetTimeZone(timezone)	void	設定試算表的時區。
show(userInterface)	void	在使用者瀏覽器的檢視區中，以對稱方式在對話方塊中顯示自訂使用者介面元件。
sort(columnPosition)	Sheet	依欄遞增排序工作表。
sort(columnPosition, ascending)	Sheet	依欄排序工作表。
toast(msg)	void	在試算表的右下角顯示彈出式視窗，並顯示指定的訊息。
toast(msg, title)	void	在試算表的右下角顯示彈出式視窗，內含指定的訊息和標題。
toast(msg, title, timeoutSeconds)	void	在試算表的右下角顯示彈出式視窗，其中顯示指定的標題和訊息，並維持一段時間。
unhideColumn(column)	void	取消隱藏指定範圍內的資料欄。
unhideRow(row)	void	取消隱藏指定範圍中的資料列。
updateMenu(name, subMenus)	void	更新由 addMenu(name, subMenus) 新增的選單。
waitForAllDataExecutionsCompletion(timeoutInSeconds)	void	等待試算表中所有目前執行作業完成，並在指定秒數後逾時。

已淘汰的方法

方法	傳回類型	簡短說明
getSheetProtection()	PageProtection	傳回 PageProtection 例項，說明目前工作表的權限。
isAnonymousView()	Boolean	指出文件是否允許匿名瀏覽。
isAnonymousWrite()	Boolean	指出文件是否允許匿名使用者編輯。
setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)	void	設定文件的匿名讀取和寫入政策。
setSheetProtection(permissions)	void	設定目前工作表的權限。

內容詳盡的說明文件

addDeveloperMetadata(key)

將含有指定鍵的開發人員中繼資料新增至頂層試算表。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

參數

名稱	類型	說明
key	String	新的開發人員中繼資料鍵。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addDeveloperMetadata(key, visibility)

將含有指定鍵和瀏覽權限的開發人員中繼資料新增至試算表。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

參數

名稱	類型	說明
key	String	新的開發人員中繼資料鍵。
visibility	DeveloperMetadataVisibility	新開發人員中繼資料的瀏覽權限。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addDeveloperMetadata(key, value)

將含有指定鍵和值的開發人員中繼資料新增至試算表。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

參數

名稱	類型	說明
key	String	新的開發人員中繼資料鍵。
value	String	新開發人員中繼資料的值。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addDeveloperMetadata(key, value, visibility)

將開發人員中繼資料新增至試算表，並指定鍵、值和瀏覽權限。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

參數

名稱	類型	說明
key	String	新的開發人員中繼資料鍵。
value	String	新開發人員中繼資料的值。
visibility	DeveloperMetadataVisibility	新開發人員中繼資料的瀏覽權限。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addEditor(emailAddress)

將指定使用者新增至 Spreadsheet 的編輯者清單。如果使用者已在觀看者名單中，這個方法會將使用者從觀看者名單中移除。

參數

名稱	類型	說明
emailAddress	String	要新增的使用者電子郵件地址。

回攻員

Spreadsheet：這個 Spreadsheet，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addEditor(user)

將指定使用者新增至 Spreadsheet 的編輯者清單。如果使用者已在觀看者名單中，這個方法會將使用者從觀看者名單中移除。

參數

名稱	類型	說明
user	User	要新增的使用者代表。

回攻員

Spreadsheet：這個 Spreadsheet，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addEditors(emailAddresses)

將指定的使用者陣列新增至 Spreadsheet 的編輯者清單。如果有任何使用者已在觀眾名單中，這個方法會將他們從觀眾名單中移除。

參數

名稱	類型	說明
emailAddresses	String[]	要新增的使用者電子郵件地址陣列。

回攻員

Spreadsheet：這個 Spreadsheet，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addMenu(name, subMenus)

在試算表 UI 中建立新選單。

每個選單項目都會執行使用者定義的函式。通常，您會想從 onOpen() 函式呼叫這個函式，這樣系統就會在載入試算表時自動建立選單。

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

參數

名稱	類型	說明
name	String	要建立的選單名稱。
subMenus	Object[]	含有 name 和 functionName 參數的 JavaScript 地圖陣列。您可以使用所納入程式庫的函式，例如 Library.libFunction1。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addViewer(emailAddress)

將指定使用者新增至 Spreadsheet 的觀眾名單。如果使用者已在編輯者名單中，這個方法就不會生效。

參數

名稱	類型	說明
emailAddress	String	要新增的使用者電子郵件地址。

回攻員

Spreadsheet：這個 Spreadsheet，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addViewer(user)

將指定使用者新增至 Spreadsheet 的觀眾名單。如果使用者已在編輯者名單中，這個方法就不會生效。

參數

名稱	類型	說明
user	User	要新增的使用者代表。

回攻員

Spreadsheet：這個 Spreadsheet，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

addViewers(emailAddresses)

將指定的使用者陣列新增至 Spreadsheet 的觀眾清單。如果有任何使用者已在編輯者清單中，則此方法對他們不會有任何影響。

參數

名稱	類型	說明
emailAddresses	String[]	要新增的使用者電子郵件地址陣列。

回攻員

Spreadsheet：這個 Spreadsheet，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

appendRow(rowContents)

將資料列附加至工作表中目前資料區域的底部。如果儲存格內容開頭為 =，系統會將其解讀為公式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

參數

名稱	類型	說明
rowContents	Object[]	要插入工作表最後一列後方的值陣列。

回攻員

Sheet：工作表，可用於方法鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

autoResizeColumn(columnPosition)

將指定欄的寬度設為適合其內容的寬度。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

參數

名稱	類型	說明
columnPosition	Integer	要調整大小的指定欄位置。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

copy(name)

複製試算表並傳回新試算表。

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

參數

名稱	類型	說明
name	String	副本名稱。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

createDeveloperMetadataFinder()

傳回 DeveloperMetadataFinder，用於在這個試算表的範圍內尋找開發人員中繼資料。根據預設，這項功能會考量與試算表、工作表、列和欄相關聯的所有中繼資料。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

回攻員

DeveloperMetadataFinder：開發人員中繼資料搜尋工具，可搜尋試算表範圍內的中繼資料。

---

createTextFinder(findText)

為試算表建立文字尋找器，可用於尋找及取代試算表中的文字。搜尋作業會從試算表的第一個工作表開始。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
var textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

參數

名稱	類型	說明
findText	String	要搜尋的文字。

回攻員

TextFinder：試算表的 TextFinder。

---

deleteActiveSheet()

刪除目前的活頁。

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

回攻員

Sheet：新的有效工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

deleteColumn(columnPosition)

刪除指定欄位置的資料欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

參數

名稱	類型	說明
columnPosition	Integer	資料欄的位置，從第一個資料欄開始，編號為 1。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

deleteColumns(columnPosition, howMany)

從指定的欄位開始刪除多個欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

參數

名稱	類型	說明
columnPosition	Integer	要刪除的第一個資料欄的位置。
howMany	Integer	要刪除的欄數。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

deleteRow(rowPosition)

刪除指定資料列位置的資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

參數

名稱	類型	說明
rowPosition	Integer	資料列的位置，第一列為 1。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

deleteRows(rowPosition, howMany)

從指定的資料列位置開始，刪除多個資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

參數

名稱	類型	說明
rowPosition	Integer	要刪除的第一個資料列的位置。
howMany	Integer	要刪除的資料列數量。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

deleteSheet(sheet)

刪除指定的工作表。

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

參數

名稱	類型	說明
sheet	Sheet	要刪除的工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

duplicateActiveSheet()

複製使用中的工作表，並將其設為使用中工作表。

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getActiveCell()

傳回此工作表中的目前儲存格。

注意：建議使用 getCurrentCell()，這個函式會傳回目前醒目顯示的儲存格。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

回攻員

Range：目前的活動儲存格

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getActiveRange()

傳回有效工作表中的選取範圍，如果沒有有效範圍，則傳回 null。如果選取多個範圍，這個方法只會傳回最後一個所選範圍。

「有效範圍」一詞是指使用者在有效工作表中選取的範圍，但在自訂函式中，則是指正在重新計算的儲存格。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

回攻員

Range：有效範圍

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

另請參閱

• setActiveRange(range)

---

getActiveRangeList()

傳回有效工作表中有效範圍的清單，如果沒有有效範圍，則傳回 null。

如果選取單一範圍，這會以 getActiveRange() 呼叫的形式運作。

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

回攻員

RangeList：有效範圍清單

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

另請參閱

• setActiveRangeList(rangeList)

---

getActiveSheet()

取得試算表中的活動工作表。

試算表中的「目前工作表」是指在試算表 UI 中顯示的工作表。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

回攻員

Sheet：試算表中的目前工作表。

---

getAs(contentType)

將此物件內的資料傳回為轉換為指定內容類型的 Blob。這個方法會在檔案名稱中加入適當的副檔名，例如「myfile.pdf」。不過，系統會假設檔案名稱中最後一個句點 (如有) 後面的部分是應取代的現有副檔名。因此，「ShoppingList.12.25.2014」會變成「ShoppingList.12.25.pdf」。

如要查看轉換的每日配額，請參閱「Google 服務的配額」。新建立的 Google Workspace 網域可能會暫時受到更嚴格的配額限制。

參數

名稱	類型	說明
contentType	String	要轉換的 MIME 類型。對於大多數 Blob 而言，'application/pdf' 是唯一有效的選項。如果圖片為 BMP、GIF、JPEG 或 PNG 格式，'image/bmp'、'image/gif'、'image/jpeg' 或 'image/png' 也適用。如果是 Google 文件，'text/markdown' 也是有效的。

回攻員

Blob：資料為 Blob。

---

getBandings()

傳回此試算表中的所有頻帶。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

回攻員

Banding[]：這份試算表中的頻帶。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getBlob()

將此物件內的資料以 blob 格式傳回。

回攻員

Blob：資料為 Blob。

---

getColumnWidth(columnPosition)

取得指定欄的寬度 (以像素為單位)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

參數

名稱	類型	說明
columnPosition	Integer	要檢查的資料欄位置。

回攻員

Integer：欄寬度 (以像素為單位)

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getCurrentCell()

傳回目前工作表中的目前儲存格，如果沒有目前儲存格，則傳回 null。目前儲存格是 Google 試算表 UI 中聚焦的儲存格，並以深色邊框醒目顯示。目前的儲存格永遠不會超過一個。當使用者選取一或多個儲存格範圍時，選取範圍中的其中一個儲存格即為目前儲存格。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.getCurrentCell();

回攻員

Range：目前的儲存格

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDataRange()

傳回與資料所在維度相對應的 Range。

這在功能上等同於建立以 A1 和 (Sheet.getLastColumn(), Sheet.getLastRow()) 為界線的 Range。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

回攻員

Range：包含試算表中所有資料的範圍

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDataSourceFormulas()

取得所有資料來源公式。

// Opens the spreadsheet by its ID. If you created your script from within a Google Sheets
// file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

回攻員

DataSourceFormula[]：資料來源公式清單。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDataSourcePivotTables()

取得所有資料來源資料透視表。

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

回攻員

DataSourcePivotTable[]：資料來源資料透視表清單。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDataSourceRefreshSchedules()

取得此試算表的重新整理時間表。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

回攻員

DataSourceRefreshSchedule[]：這份試算表的重新整理時間表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDataSourceSheets()

傳回試算表中的所有資料來源工作表。

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

回攻員

DataSourceSheet[]：所有資料來源工作表的陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDataSourceTables()

取得所有資料來源資料表。

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

回攻員

DataSourceTable[]：資料來源表清單。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDataSources()

傳回試算表中的所有資料來源。

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

回攻員

DataSource[]：所有資料來源的陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getDeveloperMetadata()

取得與頂層試算表相關聯的開發人員中繼資料。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

回攻員

DeveloperMetadata[]：與這個範圍相關聯的開發人員中繼資料。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getEditors()

取得這個 Spreadsheet 的編輯者清單。

回攻員

User[]：具備編輯權限的使用者陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getFormUrl()

傳回表單的網址，該表單會將回覆傳送至此試算表；如果此試算表沒有關聯的表單，則傳回 null。如果有多份表單傳送回應至這個試算表，系統會傳回不確定的表單網址。或者，您也可以透過 Sheet.getFormUrl() 方法擷取每個工作表表單網址關聯。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

回攻員

String：表單的網址，會將回覆放入這個試算表；如果這個試算表沒有相關聯的表單，則為 null。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getFrozenColumns()

傳回已凍結欄的數量。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

回攻員

Integer：凍結欄數

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getFrozenRows()

傳回已凍結的資料列數。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

回攻員

Integer：凍結列數

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getId()

取得這個試算表的專屬 ID。您可以從試算表網址擷取試算表 ID。舉例來說，在網址 https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 中，試算表 ID 為「abc1234567」。

// The code below logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

回攻員

String：試算表的專屬 ID (或索引鍵)。

---

getImages()

傳回工作表上所有格線外的圖片。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

回攻員

OverGridImage[]：格線上方圖片的陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getIterativeCalculationConvergenceThreshold()

傳回迭代計算期間使用的閾值。當後續計算結果的差異小於這個值時，迴圈計算就會停止。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

回攻員

Number：收斂門檻。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getLastColumn()

傳回最後一個含有內容的資料欄位置。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

回攻員

Integer：試算表中含有內容的最後一欄

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getLastRow()

傳回最後一列的內容位置。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

回攻員

Integer：含有內容的試算表最後一列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getMaxIterativeCalculationCycles()

傳回在疊代計算期間要使用的疊代次數上限。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

回攻員

Integer：計算疊代次數上限。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getName()

取得文件名稱。

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

回攻員

String：試算表名稱。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getNamedRanges()

取得這個試算表中的所有命名範圍。

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

回攻員

NamedRange[]：試算表中所有已命名範圍的陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getNumSheets()

傳回這個試算表中的工作表數量。

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

回攻員

Integer：試算表中的工作表數量。

---

getOwner()

傳回文件的擁有者，或共用雲端硬碟中文件的 null。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

回攻員

User：文件擁有者，如果文件位於共用雲端硬碟中，則為 null。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getPredefinedSpreadsheetThemes()

傳回預先定義主題的清單。

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

回攻員

SpreadsheetTheme[]：預先定義的主題清單。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getProtections(type)

取得代表試算表中所有受保護範圍或工作表的物件陣列。

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

參數

名稱	類型	說明
type	ProtectionType	受保護區的類型，可能是 SpreadsheetApp.ProtectionType.RANGE 或 SpreadsheetApp.ProtectionType.SHEET。

回攻員

Protection[]：代表試算表中所有受保護範圍或工作表的物件陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getRange(a1Notation)

傳回 A1 或 R1C1 符號指定的範圍。

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

參數

名稱	類型	說明
a1Notation	String	要傳回的範圍，如 A1 標記法或 R1C1 標記法所指定。

回攻員

Range：指定位置的範圍

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getRangeByName(name)

傳回命名範圍，如果找不到具有指定名稱的範圍，則傳回 null。如果試算表的多個工作表使用相同的範圍名稱，請指定工作表名稱，但不要加上額外的引號，例如 getRangeByName('TaxRates') 或 getRangeByName('Sheet Name!TaxRates')，但不要使用 getRangeByName('"Sheet Name"!TaxRates')。

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

參數

名稱	類型	說明
name	String	要取得的範圍名稱。

回攻員

Range：具有指定名稱的儲存格範圍。

---

getRangeList(a1Notations)

傳回 RangeList 集合，代表由非空白的 A1 符號或 R1C1 符號指定的同一工作表中的範圍。

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

參數

名稱	類型	說明
a1Notations	String[]	要傳回的範圍清單，如 A1 或 R1C1 符號所指定。

回攻員

RangeList：指定位置的範圍清單

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getRecalculationInterval()

傳回此試算表的計算間隔。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

回攻員

RecalculationInterval：這個試算表的計算間隔。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getRowHeight(rowPosition)

取得指定資料列的高度 (以像素為單位)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

參數

名稱	類型	說明
rowPosition	Integer	要檢查的資料列位置。

回攻員

Integer：列高 (以像素為單位)

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSelection()

傳回試算表中目前的 Selection。

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

回攻員

Selection：目前選取的項目

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSheetByName(name)

傳回具有指定名稱的工作表。

如果有多個工作表具有相同的名稱，系統會傳回最左邊的工作表。如果沒有指定名稱的工作表，就會傳回 null。

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

參數

名稱	類型	說明
name	String	要取得的試算表名稱。

回攻員

Sheet：具有指定名稱的工作表。

---

getSheetId()

傳回此物件所代表的工作表 ID。

這是試算表的專屬試算表 ID。ID 是指在建立工作表時指派的單調遞增整數，與工作表位置無關。這在搭配 Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) 等方法時非常實用，因為這些方法會採用 gridId 參數，而非 Sheet 例項。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

回攻員

Integer：試算表專屬的試算表 ID

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSheetName()

傳回工作表名稱。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

回攻員

String - 工作表名稱

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSheetValues(startRow, startColumn, numRows, numColumns)

傳回這個範圍的矩形格狀值，從指定座標開始。以資料列或資料欄位置指定 -1 值，等同於取得工作表中含有資料的最後一列或最後一欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

參數

名稱	類型	說明
startRow	Integer	起始資料列的位置。
startColumn	Integer	起始資料欄的位置。
numRows	Integer	代表要傳回值的列數。
numColumns	Integer	代表要傳回值的欄數。

回攻員

Object[][]：值的二維陣列

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSheets()

取得此試算表中的所有工作表。

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

回攻員

Sheet[]：試算表中所有工作表的陣列。

---

getSpreadsheetLocale()

取得試算表語言代碼。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

回攻員

String：試算表語言代碼。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSpreadsheetTheme()

傳回試算表目前的主題，如果未套用主題，則傳回 null。

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

回攻員

SpreadsheetTheme：目前套用的主題。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getSpreadsheetTimeZone()

取得試算表的時區。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

回攻員

String：時區，以「long」格式指定 (例如「America/New_York」，如 Joda.org 所列)。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getUrl()

傳回指定試算表的網址。

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

回攻員

String：指定試算表的網址。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

getViewers()

取得這個 Spreadsheet 的檢視者和加註者清單。

回攻員

User[]：具有查看或註解權限的使用者陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

hideColumn(column)

隱藏指定範圍內的資料欄。

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

參數

名稱	類型	說明
column	Range	要隱藏的資料欄範圍。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

hideRow(row)

隱藏指定範圍內的資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

參數

名稱	類型	說明
row	Range	要隱藏的資料列範圍。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertColumnAfter(afterPosition)

在指定的資料欄位置後方插入資料欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

參數

名稱	類型	說明
afterPosition	Integer	新資料欄應插入的資料欄。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertColumnBefore(beforePosition)

在指定的資料欄位置前插入資料欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

參數

名稱	類型	說明
beforePosition	Integer	要新增資料欄之前的資料欄。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertColumnsAfter(afterPosition, howMany)

在指定的資料欄位置後方插入指定數量的資料欄。

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

參數

名稱	類型	說明
afterPosition	Integer	新資料欄應插入的資料欄。
howMany	Integer	要插入的資料欄數。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertColumnsBefore(beforePosition, howMany)

在指定的欄位置前插入多個資料欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

參數

名稱	類型	說明
beforePosition	Integer	要新增資料欄之前的資料欄。
howMany	Integer	要插入的資料欄數。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertDataSourceSheet(spec)

在試算表中插入新的 DataSourceSheet，並開始執行資料。這會導致新試算表成為有效試算表。

如果未啟用資料來源類型，系統會擲回例外狀況。使用 SpreadsheetApp#enable...Execution() 方法，為特定資料來源類型啟用資料執行程序。

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setTableProjectId('bigquery-public-data')
 .setDatasetId('ncaa_basketball')
 .setTableId('mbb_historical_teams_games')
 .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

參數

名稱	類型	說明
spec	DataSourceSpec	要插入的資料來源規格。

回攻員

DataSourceSheet：新資料來源工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertImage(blobSource, column, row)

在文件中插入 Spreadsheet 做為圖片，並放置在指定的列和欄中。系統會從 Blob 內容擷取圖片大小。支援的 blob 大小上限為 2 MB。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

參數

名稱	類型	說明
blobSource	BlobSource	包含圖片內容、MIME 類型和 (選用) 名稱的 Blob。
column	Integer	資料欄位置。
row	Integer	資料列位置。

回攻員

OverGridImage：已插入的圖片。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertImage(blobSource, column, row, offsetX, offsetY)

在指定的資料列和資料欄中，以圖片形式插入 Spreadsheet，並加上像素偏移。系統會從 Blob 內容擷取圖片大小。支援的 blob 大小上限為 2 MB。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

參數

名稱	類型	說明
blobSource	BlobSource	包含圖片內容、MIME 類型和 (選用) 名稱的 Blob。
column	Integer	資料欄位置。
row	Integer	資料列位置。
offsetX	Integer	以像素為單位的單元格角落水平偏移。
offsetY	Integer	以像素為單位的單元格角落垂直偏移。

回攻員

OverGridImage：已插入的圖片。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertImage(url, column, row)

在文件中插入圖片，位置為指定的列和欄。

提供的網址必須可供所有人存取。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

參數

名稱	類型	說明
url	String	圖片的網址。
column	Integer	格線欄位。
row	Integer	格線資料列位置。

回攻員

OverGridImage：已插入的圖片。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertImage(url, column, row, offsetX, offsetY)

在文件中插入圖片，並指定圖片的列和欄位置，以及像素偏移量。

提供的網址必須可供所有人存取。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

參數

名稱	類型	說明
url	String	圖片的網址。
column	Integer	資料欄位置。
row	Integer	資料列位置。
offsetX	Integer	以像素為單位的單元格角落水平偏移。
offsetY	Integer	以像素為單位的單元格角落垂直偏移。

回攻員

OverGridImage：已插入的圖片。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertRowAfter(afterPosition)

在指定的資料列位置後插入資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

參數

名稱	類型	說明
afterPosition	Integer	新列要新增的位置。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertRowBefore(beforePosition)

在指定的資料列位置前插入資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

參數

名稱	類型	說明
beforePosition	Integer	新列要新增的位置。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertRowsAfter(afterPosition, howMany)

在指定的資料列位置後插入多個資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

參數

名稱	類型	說明
afterPosition	Integer	新列應新增的位置。
howMany	Integer	要插入的資料列數量。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertRowsBefore(beforePosition, howMany)

在指定的資料列位置前插入多個資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

參數

名稱	類型	說明
beforePosition	Integer	新資料列應插入的資料列。
howMany	Integer	要插入的資料列數量。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheet()

使用預設工作表名稱，在試算表中插入新的工作表。新工作表會變成有效工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheet(sheetIndex)

在指定索引處，將新工作表插入試算表中。新工作表會變成有效工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

參數

名稱	類型	說明
sheetIndex	Integer	新建工作表的索引。如要將工作表插入試算表的第一個工作表，請將該值設為 0。

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheet(sheetIndex, options)

在指定索引處，將新工作表插入試算表中，並使用選用的進階引數。新工作表會變成有效工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

參數

名稱	類型	說明
sheetIndex	Integer	新建工作表的索引。如要將工作表插入試算表的第一個工作表，請將該值設為 0。
options	Object	選用的 JavaScript 進階引數。

進階參數

名稱	類型	說明
template	Sheet	系統會將範本工作表物件中的所有資料複製到新工作表。工作表範本必須是試算表物件的其中一個工作表。

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheet(options)

使用預設工作表名稱和選用的進階引數，在試算表中插入新的工作表。新工作表會變成有效工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

參數

名稱	類型	說明
options	Object	選用的 JavaScript 進階引數，請參閱下方說明。

進階參數

名稱	類型	說明
template	Sheet	系統會將範本工作表物件中的所有資料複製到新工作表。工作表範本必須是這個試算表物件的其中一個工作表。

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheet(sheetName)

在試算表中插入新工作表，並使用指定的名稱。新工作表會變成有效工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

參數

名稱	類型	說明
sheetName	String	新工作表的名稱。

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheet(sheetName, sheetIndex)

在指定索引中，將新工作表插入試算表中，並使用指定名稱。新工作表會成為有效工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

參數

名稱	類型	說明
sheetName	String	新工作表的名稱。
sheetIndex	Integer	新建工作表的索引。如要將工作表插入試算表的第一個工作表，請將該值設為 0。

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheet(sheetName, sheetIndex, options)

在指定索引處，將新工作表插入試算表中，並使用選用的進階引數。新工作表會變成有效工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

參數

名稱	類型	說明
sheetName	String	新工作表的名稱。
sheetIndex	Integer	新插入工作表的索引。如要將工作表插入試算表的第一個工作表，請將該值設為 0。
options	Object	選用的 JavaScript 進階引數。

進階參數

名稱	類型	說明
template	Sheet	系統會將範本工作表物件中的所有資料複製到新工作表。工作表範本必須是試算表物件的其中一個工作表。

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheet(sheetName, options)

在試算表中插入新工作表，並使用指定名稱和選用的進階引數。新工作表會變成有效工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

參數

名稱	類型	說明
sheetName	String	新工作表的名稱。
options	Object	選用的 JavaScript 進階引數。

進階參數

名稱	類型	說明
template	Sheet	系統會將範本工作表物件中的所有資料複製到新工作表。工作表範本必須是試算表物件的其中一個工作表。

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

insertSheetWithDataSourceTable(spec)

在試算表中插入新工作表，使用指定的資料來源規格建立跨越整個試算表的 DataSourceTable，並開始執行資料。並將新試算表設為活動試算表。

如果未啟用資料來源類型，系統會擲回例外狀況。使用 SpreadsheetApp#enable...Execution() 方法，為特定資料來源類型啟用資料執行程序。

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

參數

名稱	類型	說明
spec	DataSourceSpec	要插入的資料來源規格。

回攻員

Sheet：新工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

isColumnHiddenByUser(columnPosition)

傳回使用者是否隱藏指定的資料欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

參數

名稱	類型	說明
columnPosition	Integer	要檢查的資料欄位置。

回攻員

Boolean：如果資料欄已隱藏，則為 true；否則為 false。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

isIterativeCalculationEnabled()

會傳回這個試算表是否已啟用反覆運算功能。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

回攻員

Boolean：如果啟用反覆運算，則為 true；否則為 false。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

isRowHiddenByFilter(rowPosition)

傳回指定資料列是否遭到篩選器 (而非篩選器檢視畫面) 隱藏。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

參數

名稱	類型	說明
rowPosition	Integer	要檢查的資料列位置。

回攻員

Boolean：如果是隱藏的資料列，則為 true；否則為 false。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

isRowHiddenByUser(rowPosition)

傳回使用者是否隱藏指定資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

參數

名稱	類型	說明
rowPosition	Integer	要檢查的資料列位置。

回攻員

Boolean：如果是隱藏的資料列，則為 true；否則為 false。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

moveActiveSheet(pos)

將目前的活頁移至工作表清單中的指定位置。如果位置為負值或大於工作表數量，系統會擲回例外狀況。

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

參數

名稱	類型	說明
pos	Integer	在工作表清單中，要將目前使用中的工作表移至第 1 個索引位置。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

moveChartToObjectSheet(chart)

建立新的 SheetType.OBJECT 工作表，並將提供的圖表移至該工作表。如果圖表已位於其專屬工作表中，系統會傳回該工作表，而不會建立新工作表。

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

參數

名稱	類型	說明
chart	EmbeddedChart	要移動的圖表。

回攻員

Sheet：圖表所在的工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

refreshAllDataSources()

重新整理所有支援的資料來源及其連結的資料來源物件，並略過無效的資料來源物件。

使用 SpreadsheetApp#enable...Execution() 方法，為特定資料來源類型啟用資料執行程序。

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(`Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`);

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

removeEditor(emailAddress)

將指定使用者從 Spreadsheet 的編輯者清單中移除。如果使用者屬於擁有一般存取權的使用者類別，這個方法就不會阻止他們存取 Spreadsheet，例如 Spreadsheet 與使用者的整個網域共用，或是 Spreadsheet 位於使用者可存取的共用雲端硬碟中。

對於雲端硬碟檔案，這也會將使用者從檢視者清單中移除。

參數

名稱	類型	說明
emailAddress	String	要移除的使用者電子郵件地址。

回攻員

Spreadsheet：這個 Spreadsheet，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

removeEditor(user)

將指定使用者從 Spreadsheet 的編輯者清單中移除。如果使用者屬於擁有一般存取權的使用者類別，這個方法就不會阻止他們存取 Spreadsheet，例如 Spreadsheet 與使用者的整個網域共用，或是 Spreadsheet 位於使用者可存取的共用雲端硬碟中。

對於雲端硬碟檔案，這也會將使用者從檢視者清單中移除。

參數

名稱	類型	說明
user	User	要移除的使用者代表。

回攻員

Spreadsheet：這個 Spreadsheet，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

removeMenu(name)

移除 addMenu(name, subMenus) 新增的選單。name 引數的值應與對應的 addMenu(name, subMenus) 呼叫相同。

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

參數

名稱	類型	說明
name	String	要移除的選單名稱。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

removeNamedRange(name)

刪除具有指定名稱的已命名範圍。如果試算表中沒有找到具有指定名稱的範圍，就會擲回例外狀況。

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

參數

名稱	類型	說明
name	String	範圍名稱。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

removeViewer(emailAddress)

將指定使用者從 Spreadsheet 的觀眾和留言者名單中移除。如果使用者是編輯者，而非觀眾或評論者，則這個方法不會生效。使用者如果屬於具有一般存取權的使用者類別，這項方法也不會阻止使用者存取 Spreadsheet，例如 Spreadsheet 與使用者的整個網域共用，或是 Spreadsheet 位於使用者可存取的共用雲端硬碟中。

對於雲端硬碟檔案，這也會將使用者從編輯者清單中移除。

參數

名稱	類型	說明
emailAddress	String	要移除的使用者電子郵件地址。

回攻員

Spreadsheet：用於鏈結的 Spreadsheet。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

removeViewer(user)

將指定使用者從 Spreadsheet 的觀眾和留言者名單中移除。如果使用者是編輯者而非觀眾，這個方法就不會生效。如果使用者屬於具有一般存取權的使用者類別，這項方法也不會阻止使用者存取 Spreadsheet，例如 Spreadsheet 與使用者的整個網域共用，或是 Spreadsheet 位於使用者可存取的共用雲端硬碟中。

對於雲端硬碟檔案，這也會將使用者從編輯者清單中移除。

參數

名稱	類型	說明
user	User	要移除的使用者代表。

回攻員

Spreadsheet：用於鏈結的 Spreadsheet。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

rename(newName)

重新命名文件。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

參數

名稱	類型	說明
newName	String	文件的新名稱。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

renameActiveSheet(newName)

將目前的活動工作表重新命名為指定的新名稱。

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

參數

名稱	類型	說明
newName	String	目前處於活動狀態的工作表的新名稱。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

resetSpreadsheetTheme()

移除已套用的主題，並在試算表中設定預設主題。

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

回攻員

SpreadsheetTheme：預設主題。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setActiveRange(range)

將指定的範圍設為有效工作表中的 active range，範圍內左上角的儲存格為 current cell。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D4
var activeRange = selection.getActiveRange();

參數

名稱	類型	說明
range	Range	要設為有效範圍的範圍。

回攻員

Range：新啟用的範圍

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setActiveRangeList(rangeList)

將指定的範圍清單設為作用中工作表中的 active ranges。清單中的最後一個範圍會設為 active range。

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

參數

名稱	類型	說明
rangeList	RangeList	要選取的範圍清單。

回攻員

RangeList：新選取的區間清單

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setActiveSelection(range)

設定此工作表的有效選取區域。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

參數

名稱	類型	說明
range	Range	要設為有效選取範圍的範圍。

回攻員

Range：新啟用的範圍

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setActiveSelection(a1Notation)

根據 A1 或 R1C1 符號指定，設定有效的選取範圍。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.setActiveSelection("A1:D4");

參數

名稱	類型	說明
a1Notation	String	要設為有效的範圍，請參考 A1 或 R1C1 標記法。

回攻員

Range：新啟用的範圍

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setActiveSheet(sheet)

將指定的工作表設為試算表中的有效工作表。除非所選工作表屬於其他試算表，否則 Google 試算表 UI 會顯示所選工作表。

// The code below makes the first sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

參數

名稱	類型	說明
sheet	Sheet	要設為有效工作表的工作表。

回攻員

Sheet：使用中的工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setActiveSheet(sheet, restoreSelection)

將指定的工作表設為試算表中的有效工作表，並提供選項，可還原該工作表中最近的選取項目。除非工作表屬於其他試算表，否則 Google 試算表 UI 會顯示所選的工作表。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

參數

名稱	類型	說明
sheet	Sheet	新的活動工作表。
restoreSelection	Boolean	如果為 true，新的工作表啟用後，最近一次選取的工作表會再次選取；如果為 false，新的工作表會啟用，但不會變更目前的選取項目。

回攻員

Sheet：新的有效工作表。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setColumnWidth(columnPosition, width)

以像素為單位，設定指定欄的寬度。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

參數

名稱	類型	說明
columnPosition	Integer	要設定的指定資料欄位置。
width	Integer	要設為的寬度 (以像素為單位)。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setCurrentCell(cell)

將指定的儲存格設為 current cell。

如果指定的儲存格位於已選取的範圍中，該範圍就會成為有效範圍，而儲存格則會成為目前的儲存格。

如果指定的儲存格不在任何所選範圍內，系統會移除所有現有選取項目，並將該儲存格設為目前的儲存格和有效範圍。

注意：指定的 Range 必須包含一個儲存格，否則會擲回例外狀況。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

參數

名稱	類型	說明
cell	Range	要設為目前儲存格的儲存格。

回攻員

Range：新設定的目前儲存格

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setFrozenColumns(columns)

凍結指定數量的欄。如果為零，則不會凍結任何資料欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

參數

名稱	類型	說明
columns	Integer	要凍結的欄數。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setFrozenRows(rows)

凍結指定數量的資料列。如果為零，則不會凍結任何資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

參數

名稱	類型	說明
rows	Integer	要凍結的資料列數量。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setIterativeCalculationConvergenceThreshold(minThreshold)

設定重複計算作業的最低門檻值。當後續計算結果的差異值低於此值時，迴圈計算就會停止。這個值必須為非負值，預設為 0.05。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

參數

名稱	類型	說明
minThreshold	Number	最小收斂臨界值 (必須為非負值)。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setIterativeCalculationEnabled(isEnabled)

設定是否在這個試算表中啟用反覆運算。如果在啟用計算時，先前未設定計算週期上限和收斂門檻，則預設值分別為 50 和 0.05。如果先前已設定其中任一值，則會保留先前的值。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

參數

名稱	類型	說明
isEnabled	Boolean	true：如果應啟用反覆運算功能；否則為 false。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setMaxIterativeCalculationCycles(maxIterations)

設定在疊代計算期間應執行的計算疊代次數上限。這個值必須介於 1 到 10,000 (含首尾)，預設值為 50。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

參數

名稱	類型	說明
maxIterations	Integer	計算疊代次數上限 (介於 1 到 10,000 之間)。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setNamedRange(name, range)

為範圍命名。

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

參數

名稱	類型	說明
name	String	要為範圍指定的名稱。
range	Range	範圍規格。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setRecalculationInterval(recalculationInterval)

設定這個試算表的重新計算頻率。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

參數

名稱	類型	說明
recalculationInterval	RecalculationInterval	新的重新計算間隔。

回攻員

Spreadsheet：這個試算表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setRowHeight(rowPosition, height)

以像素為單位，設定指定資料列的行高。根據預設，資料列會配合儲存格內容調整大小。如果您想強制將資料列設為指定高度，請使用 Sheet.setRowHeightsForced(startRow, numRows, height)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

參數

名稱	類型	說明
rowPosition	Integer	要變更的資料列位置。
height	Integer	要設定的高度 (以像素為單位)。

回攻員

Sheet：工作表，可用於方法鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setSpreadsheetLocale(locale)

設定試算表語言代碼。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

參數

名稱	類型	說明
locale	String	要使用的語言代碼 (例如「en」、「fr」或「en_US」)。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setSpreadsheetTheme(theme)

設定試算表的主題。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

參數

名稱	類型	說明
theme	SpreadsheetTheme	要套用的主題。

回攻員

SpreadsheetTheme：新的目前主題。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

setSpreadsheetTimeZone(timezone)

設定試算表的時區。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

參數

名稱	類型	說明
timezone	String	時區，以「長」格式指定 (例如「America/New_York」，如 Joda.org 所列)。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

show(userInterface)

在使用者瀏覽器的檢視區中，以對稱方式在對話方塊中顯示自訂使用者介面元件。伺服器端指令碼的執行作業不會暫停。如要與伺服器端通訊，使用者介面元件必須對伺服器端指令碼進行非同步回呼。

如果伺服器端指令碼先前顯示的對話方塊尚未關閉，則現有對話方塊會替換為新要求的對話方塊使用者介面。

以下程式碼片段會在對話方塊中顯示簡單的 HtmlService 應用程式，並指定標題、高度和寬度：

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

參數

名稱	類型	說明
userInterface	Object	HtmlOutput。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/script.container.ui

---

sort(columnPosition)

依欄遞增排序工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

參數

名稱	類型	說明
columnPosition	Integer	要依據的資料欄。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

sort(columnPosition, ascending)

依欄排序工作表。可接受參數，用來指定遞增或遞減排序。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

參數

名稱	類型	說明
columnPosition	Integer	要依據的資料欄。
ascending	Boolean	true 代表遞增排序，false 代表遞減排序。

回攻員

Sheet：工作表，可用於方法鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

toast(msg)

在試算表的右下角顯示彈出式視窗，並顯示指定的訊息。

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

參數

名稱	類型	說明
msg	String	要顯示在彈出式訊息中的訊息。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

toast(msg, title)

在試算表的右下角顯示彈出式視窗，內含指定的訊息和標題。

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

參數

名稱	類型	說明
msg	String	要顯示在彈出式訊息中的訊息。
title	String	彈出式通知的選用標題。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

toast(msg, title, timeoutSeconds)

在試算表的右下角顯示彈出式視窗，其中包含指定的標題和訊息，並在一定時間內持續顯示。

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

參數

名稱	類型	說明
msg	String	要顯示在彈出式訊息中的訊息。
title	String	彈出式通知的選用標題。
timeoutSeconds	Number	逾時時間 (以秒為單位)。如果為 null，則 Toast 的預設值為 5 秒；如果為負值，則 Toast 會持續顯示，直到使用者關閉為止。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

unhideColumn(column)

取消隱藏指定範圍內的資料欄。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

參數

名稱	類型	說明
column	Range	要取消隱藏的範圍 (如果隱藏)。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

unhideRow(row)

取消隱藏指定範圍中的資料列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

參數

名稱	類型	說明
row	Range	要取消隱藏的範圍 (如果隱藏)。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

updateMenu(name, subMenus)

更新由 addMenu(name, subMenus) 新增的選單。運作方式與 addMenu(name, subMenus) 完全相同。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

參數

名稱	類型	說明
name	String	要更新的選單名稱。
subMenus	Object[]	含有 name 和 functionName 參數的 JavaScript 地圖陣列。您可以使用所納入程式庫的函式，例如 Library.libFunction1。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

waitForAllDataExecutionsCompletion(timeoutInSeconds)

等待試算表中所有目前執行作業完成，並在提供的秒數後逾時。如果在逾時時未完成執行作業，則會擲回例外狀況，但不會取消資料執行作業。

參數

名稱	類型	說明
timeoutInSeconds	Integer	等待資料執行作業的時間 (以秒為單位)。上限為 300 秒。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

已淘汰的方法

getSheetProtection()

已淘汰。如果是使用較新版本的 Google 試算表建立的試算表，請使用 Sheet.getProtections(type)，因為這個函式會傳回功能更強大的 Protection 類別。雖然這個方法已淘汰，但仍可用於與舊版 Google 試算表的相容性

傳回 PageProtection 例項，說明目前工作表的權限。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser("[e-mail]");

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
var users = permissions.getUsers();
Logger.log(users);

回攻員

PageProtection：描述工作表存取權限的物件

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

---

isAnonymousView()

已淘汰。自 2014 年 1 月起，這項函式已淘汰，且在新版 Google 試算表中無法使用。

指出文件是否允許匿名瀏覽。新版 Google 試算表已不再支援這項功能，請改用 File.getSharingAccess() 和 File.getSharingPermission()。

// Determine if the document allows anonymous viewing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission != DriveApp.Permission.NONE;

回攻員

Boolean：如果文件允許匿名觀看，則為 true；否則為 false。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

另請參閱

• 雲端硬碟服務

---

isAnonymousWrite()

已淘汰。自 2014 年 1 月起，這項函式已淘汰，且在新版 Google 試算表中無法使用。

指出文件是否允許匿名使用者編輯。由於新版 Google 試算表不再支援這項功能，請改用 File.getSharingAccess() 和 File.getSharingPermission()。

// Determine if the document allow anonymous edits via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission == DriveApp.Permission.EDIT;

回攻員

Boolean：如果文件允許匿名編輯，則為 true；否則為 false。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

另請參閱

• 雲端硬碟服務

---

setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)

已淘汰。自 2014 年 1 月起，這項函式已淘汰，且在新版 Google 試算表中無法使用。

設定文件的匿名讀取和寫入政策。新版 Google 試算表已不再支援這項功能，請改用 File.setSharing(accessType, permissionType)。

// Set the document's policy on anonymous reading and writing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApi.Access.PRIVATE, file.getSharingPermission());

參數

名稱	類型	說明
anonymousReadAllowed	Boolean	true 表示允許匿名讀取；否則為 false。
anonymousWriteAllowed	Boolean	true 表示允許匿名讀取；否則為 false。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

另請參閱

• isAnonymousView()
• isAnonymousWrite()
• 雲端硬碟服務

---

setSheetProtection(permissions)

已淘汰。如果是使用新版 Google 試算表建立的試算表，請使用 Sheet.protect()，這個函式會傳回功能更強大的 Protection 類別。雖然這個方法已淘汰，但仍可用於與舊版 Google 試算表的相容性

設定目前工作表的權限。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
var sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

參數

名稱	類型	說明
permissions	PageProtection	要在這個工作表上設定的存取權限物件。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets