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

Class Range

存取及修改試算表範圍。範圍可以是工作表中的單一儲存格，也可以是一組儲存格工作表中相鄰的儲存格。

方法

方法	傳回類型	簡短說明
`activate()`	`Range`	將指定範圍設為 `active range`，其中最上方範圍左儲存格做為 `current cell`。
`activateAsCurrentCell()`	`Range`	將指定儲存格設為 `current cell`。
`addDeveloperMetadata(key)`	`Range`	將含有指定索引鍵的開發人員中繼資料新增至範圍。
`addDeveloperMetadata(key, visibility)`	`Range`	將開發人員中繼資料新增至範圍，具有指定索引鍵和瀏覽權限。
`addDeveloperMetadata(key, value)`	`Range`	將含有指定鍵和值的開發人員中繼資料新增至範圍。
`addDeveloperMetadata(key, value, visibility)`	`Range`	新增開發人員中繼資料，並指定範圍的指定鍵、值和瀏覽權限。
`applyColumnBanding()`	`Banding`	對範圍套用預設的欄頻帶主題。
`applyColumnBanding(bandingTheme)`	`Banding`	對範圍套用指定的欄頻帶主題。
`applyColumnBanding(bandingTheme, showHeader, showFooter)`	`Banding`	將指定的欄頻帶主題套用至含有指定頁首和頁尾的範圍可以管理叢集設定，像是節點資源調度、安全性和其他預先設定項目
`applyRowBanding()`	`Banding`	對範圍套用預設的列頻帶主題。
`applyRowBanding(bandingTheme)`	`Banding`	將指定的列頻帶主題套用到範圍。
`applyRowBanding(bandingTheme, showHeader, showFooter)`	`Banding`	將指定的列頻帶主題套用至指定標頭和頁尾設定的範圍。
`autoFill(destination, series)`	`void`	根據此範圍的資料，在 `destinationRange` 中填入資料。
`autoFillToNeighbor(series)`	`void`	計算範圍，根據鄰近儲存格填入新資料並自動填入，根據此範圍內的資料，設定新的值範圍。
`breakApart()`	`Range`	將範圍內的所有多欄儲存格，再次拆解成個別儲存格。
`canEdit()`	`Boolean`	決定使用者是否有權編輯範圍內的所有儲存格。
`check()`	`Range`	將範圍內核取方塊的狀態變更為「已勾選」。
`clear()`	`Range`	清除內容和格式範圍。
`clear(options)`	`Range`	清除使用顯示的進階選項
`clearContent()`	`Range`	清除範圍中的內容，保留格式不變。
`clearDataValidations()`	`Range`	清除這個範圍的資料驗證規則。
`clearFormat()`	`Range`	清除這個範圍的格式設定。
`clearNote()`	`Range`	清除指定儲存格或儲存格中的記事。
`collapseGroups()`	`Range`	收合屬於該範圍的所有群組。
`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	將範圍的格式複製到指定的位置。
`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	將範圍的格式複製到指定的位置。
`copyTo(destination)`	`void`	將特定儲存格範圍的資料複製到其他儲存格範圍。
`copyTo(destination, copyPasteType, transposed)`	`void`	將特定儲存格範圍的資料複製到其他儲存格範圍。
`copyTo(destination, options)`	`void`	將特定儲存格範圍的資料複製到其他儲存格範圍。
`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	將範圍的內容複製到指定位置。
`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	將範圍的內容複製到指定位置。
`createDataSourcePivotTable(dataSource)`	`DataSourcePivotTable`	從資料來源建立空白的資料來源資料透視表，固定在這個範圍
`createDataSourceTable(dataSource)`	`DataSourceTable`	從資料來源建立空白的資料來源表格，固定在以下內容的第一個儲存格範圍。
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	傳回 DeveloperMetadataFinderApi，以尋找此範圍內的開發人員中繼資料範圍。
`createFilter()`	`Filter`	建立篩選器，並套用至工作表中的指定範圍。
`createPivotTable(sourceData)`	`PivotTable`	從指定`sourceData` (固定在第一個儲存格) 建立空白資料透視表符合範圍內
`createTextFinder(findText)`	`TextFinder`	建立範圍的文字搜尋器，以便尋找和取代這個範圍中的文字。
`deleteCells(shiftDimension)`	`void`	刪除這個儲存格範圍。
`expandGroups()`	`Range`	展開範圍或控制項切換鈕與這個範圍交集的收合群組。
`getA1Notation()`	`String`	傳回範圍的字串說明 (使用 A1 標記法)。
`getBackground()`	`String`	傳回範圍中左上角儲存格的背景顏色 (例如 `'#ffffff'`)。
`getBackgroundObject()`	`Color`	傳回範圍中左上角儲存格的背景顏色。
`getBackgroundObjects()`	`Color[][]`	傳回範圍中儲存格的背景顏色。
`getBackgrounds()`	`String[][]`	傳回範圍中儲存格的背景顏色 (例如 `'#ffffff'`)。
`getBandings()`	`Banding[]`	傳回套用至這個範圍內任何儲存格的色帶。
`getCell(row, column)`	`Range`	傳回某範圍內的指定儲存格。
`getColumn()`	`Integer`	傳回這個範圍的起始欄位置。
`getDataRegion()`	`Range`	傳回四個基數 `Direction` 中展開的範圍副本，涵蓋所有相鄰儲存格中的資料，
`getDataRegion(dimension)`	`Range`	傳回 `Direction.UP` 和 `Direction.DOWN` 展開範圍的副本 (如果的指定維度是 `Dimension.ROWS`，或 `Direction.NEXT` 和 `Direction.PREVIOUS` (如果維度為 `Dimension.COLUMNS`)。
`getDataSourceFormula()`	`DataSourceFormula`	傳回範圍內第一個儲存格的 `DataSourceFormula`；如果傳回值，則傳回 `null` 儲存格不含資料來源公式。
`getDataSourceFormulas()`	`DataSourceFormula[]`	傳回範圍內儲存格的 `DataSourceFormula`。
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	取得與範圍交集的所有資料來源資料透視表。
`getDataSourceTables()`	`DataSourceTable[]`	取得與範圍交集的所有資料來源資料表。
`getDataSourceUrl()`	`String`	傳回這個範圍內資料的網址，可用來建立圖表和查詢。
`getDataTable()`	`DataTable`	以 DataTable 的形式傳回這個物件內的資料。
`getDataTable(firstRowIsHeader)`	`DataTable`	以資料表的形式傳回這個範圍內的資料。
`getDataValidation()`	`DataValidation`	傳回範圍內左上方的儲存格的資料驗證規則。
`getDataValidations()`	`DataValidation[][]`	傳回範圍內所有儲存格的資料驗證規則。
`getDeveloperMetadata()`	`DeveloperMetadata[]`	取得與這個範圍相關聯的開發人員中繼資料。
`getDisplayValue()`	`String`	傳回範圍左上角儲存格的顯示值。
`getDisplayValues()`	`String[][]`	傳回這個範圍值的矩形網格。
`getFilter()`	`Filter`	傳回這個範圍所屬工作表上的篩選器；如果沒有篩選器，則傳回 `null` 工作表。
`getFontColorObject()`	`Color`	傳回範圍左上角的儲存格字型顏色。
`getFontColorObjects()`	`Color[][]`	傳回範圍中儲存格的字型顏色。
`getFontFamilies()`	`String[][]`	傳回範圍中儲存格的字型系列。
`getFontFamily()`	`String`	傳回範圍左上角的儲存格字型系列。
`getFontLine()`	`String`	取得儲存格範圍左上角的儲存格線條樣式 (`'underline'`、 `'line-through'` 或 `'none'`)。
`getFontLines()`	`String[][]`	取得範圍中儲存格的線條樣式 (`'underline'`、`'line-through'` 或 `'none'`)。
`getFontSize()`	`Integer`	傳回範圍左上角儲存格的字型大小 (以點大小表示)。
`getFontSizes()`	`Integer[][]`	傳回範圍中儲存格的字型大小。
`getFontStyle()`	`String`	傳回左上角儲存格的字型樣式 (`'italic'` 或 `'normal'`) 音量大小
`getFontStyles()`	`String[][]`	傳回範圍中儲存格的字型樣式。
`getFontWeight()`	`String`	傳回儲存格範圍左上角的儲存格字型粗細 (一般/粗體)。
`getFontWeights()`	`String[][]`	傳回範圍內儲存格的字型粗細。
`getFormula()`	`String`	傳回範圍左上角儲存格的公式 (A1 標記法)，如果傳回空白字串，則傳回空白字串儲存格空白或不含公式。
`getFormulaR1C1()`	`String`	傳回指定儲存格的公式 (R1C1 標記法)；如果沒有，傳回 `null`。
`getFormulas()`	`String[][]`	傳回範圍內儲存格的公式 (A1 標記法)。
`getFormulasR1C1()`	`String[][]`	傳回範圍內儲存格的公式 (R1C1 標記法)。
`getGridId()`	`Integer`	傳回範圍父項工作表的格線 ID。
`getHeight()`	`Integer`	傳回範圍的高度。
`getHorizontalAlignment()`	`String`	傳回左上方的儲存格文字的水平對齊方式 (左側/中間/右側) 音量大小
`getHorizontalAlignments()`	`String[][]`	傳回儲存格範圍中儲存格的水平對齊方式。
`getLastColumn()`	`Integer`	傳回結束欄位置。
`getLastRow()`	`Integer`	傳回結束列位置。
`getMergedRanges()`	`Range[]`	傳回 `Range` 物件的陣列，代表已完全合併的儲存格在目前的範圍內，或目前範圍中至少有一個儲存格。
`getNextDataCell(direction)`	`Range`	從範圍第一欄和範圍中第一列的儲存格開始，傳回指定的方向，是指內含資料的連續儲存格範圍的邊緣，或是內含資料的儲存格設為「自動開啟」
`getNote()`	`String`	傳回與指定範圍相關聯的附註。
`getNotes()`	`String[][]`	傳回與範圍中儲存格相關的附註。
`getNumColumns()`	`Integer`	傳回這個範圍內的欄數。
`getNumRows()`	`Integer`	傳回這個範圍內的列數。
`getNumberFormat()`	`String`	取得指定範圍左上方的儲存格的數字或日期格式。
`getNumberFormats()`	`String[][]`	傳回範圍中儲存格的數字或日期格式。
`getRichTextValue()`	`RichTextValue`	傳回範圍左上方的儲存格的 RTF 格式值，如果儲存格中的儲存格，則傳回 `null` 值不是文字。
`getRichTextValues()`	`RichTextValue[][]`	傳回範圍中儲存格的 RTF 格式值。
`getRow()`	`Integer`	傳回這個範圍的列位置。
`getRowIndex()`	`Integer`	傳回這個範圍的列位置。
`getSheet()`	`Sheet`	傳回這個範圍所屬的工作表。
`getTextDirection()`	`TextDirection`	傳回範圍左上方的儲存格的文字方向。
`getTextDirections()`	`TextDirection[][]`	傳回儲存格範圍內儲存格的文字方向。
`getTextRotation()`	`TextRotation`	傳回範圍左上方的儲存格的文字旋轉設定。
`getTextRotations()`	`TextRotation[][]`	傳回範圍內儲存格的文字旋轉設定。
`getTextStyle()`	`TextStyle`	傳回範圍左上方的儲存格的文字樣式。
`getTextStyles()`	`TextStyle[][]`	傳回範圍中儲存格的文字樣式。
`getValue()`	`Object`	傳回範圍內左上方的儲存格的值。
`getValues()`	`Object[][]`	傳回這個範圍值的矩形網格。
`getVerticalAlignment()`	`String`	傳回儲存格左上角的垂直對齊方式 (頂端/中間/底部) 範圍。
`getVerticalAlignments()`	`String[][]`	傳回儲存格範圍中儲存格的垂直對齊方式。
`getWidth()`	`Integer`	傳回資料欄中範圍的寬度。
`getWrap()`	`Boolean`	傳回儲存格中的文字是否換行。
`getWrapStrategies()`	`WrapStrategy[][]`	傳回範圍內儲存格的文字換行策略。
`getWrapStrategy()`	`WrapStrategy`	傳回範圍左上方的儲存格的文字換行策略。
`getWraps()`	`Boolean[][]`	傳回儲存格內的文字是否換行。
`insertCells(shiftDimension)`	`Range`	在這個範圍內插入空白儲存格。
`insertCheckboxes()`	`Range`	在範圍中的每個儲存格中插入核取方塊，並已設定 `true` 的勾選和 `false` 為未勾選狀態。
`insertCheckboxes(checkedValue)`	`Range`	在範圍中的每個儲存格中插入核取方塊，並為勾選和未勾選的空字串。
`insertCheckboxes(checkedValue, uncheckedValue)`	`Range`	在範圍中的每個儲存格中插入核取方塊，並為勾選的項目設定自訂值以及未勾選狀態
`isBlank()`	`Boolean`	如果範圍完全空白，則傳回 `true`。
`isChecked()`	`Boolean`	傳回範圍內所有儲存格目前的核取方塊狀態是否為「已勾選」。
`isEndColumnBounded()`	`Boolean`	決定範圍的結尾是否繫結至特定資料欄。
`isEndRowBounded()`	`Boolean`	判斷範圍的結尾是否與特定資料列繫結。
`isPartOfMerge()`	`Boolean`	如果目前範圍內的儲存格與任何合併的儲存格重疊，則傳回 `true`。
`isStartColumnBounded()`	`Boolean`	決定範圍的開頭是否繫結至特定資料欄。
`isStartRowBounded()`	`Boolean`	判斷範圍的開頭是否與特定資料列繫結。
`merge()`	`Range`	將範圍中的儲存格合併成一個區塊。
`mergeAcross()`	`Range`	合併範圍內儲存格範圍中的儲存格。
`mergeVertically()`	`Range`	將範圍內的儲存格合併。
`moveTo(target)`	`void`	從這個範圍剪下並貼上 (格式和值) 到目標範圍。
`offset(rowOffset, columnOffset)`	`Range`	傳回新的範圍，該範圍是根據指定的列數和欄數，從這個範圍偏移可以是負數。
`offset(rowOffset, columnOffset, numRows)`	`Range`	傳回相對於目前範圍的新範圍，左側點會偏移以目前範圍為準並參考指定的欄數和儲存格高度。
`offset(rowOffset, columnOffset, numRows, numColumns)`	`Range`	傳回相對於目前範圍的新範圍，左側點會偏移從目前範圍根據指定的列與欄，輸入的高度和寬度儲存格。
`protect()`	`Protection`	建立可防止編輯範圍的物件 (具備以下特性的使用者除外) 權限。
`randomize()`	`Range`	隨機排列指定範圍內資料列的順序。
`removeCheckboxes()`	`Range`	移除範圍中的所有核取方塊。
`removeDuplicates()`	`Range`	移除這個範圍內含有與任一值重複的值的資料列。。
`removeDuplicates(columnsToCompare)`	`Range`	移除這個範圍內含有重複指定資料欄中值重複的資料列。
`setBackground(color)`	`Range`	設定 CSS 標記法範圍內所有儲存格的背景顏色 (例如 `'#ffffff'`) 或 `'white'`)。
`setBackgroundObject(color)`	`Range`	設定範圍內所有儲存格的背景顏色。
`setBackgroundObjects(color)`	`Range`	設定背景顏色的矩形格線 (必須與此範圍的尺寸相符)。
`setBackgroundRGB(red, green, blue)`	`Range`	使用 RGB 值 (介於 0 到 255 之間的整數) 將背景設為指定色彩。
`setBackgrounds(color)`	`Range`	設定背景顏色的矩形格線 (必須與此範圍的尺寸相符)。
`setBorder(top, left, bottom, right, vertical, horizontal)`	`Range`	設定邊框屬性。
`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`	`Range`	設定顏色和/或樣式的邊框屬性。
`setDataValidation(rule)`	`Range`	為範圍中的所有儲存格設定一項資料驗證規則。
`setDataValidations(rules)`	`Range`	為範圍內的所有儲存格設定資料驗證規則。
`setFontColor(color)`	`Range`	設定 CSS 標記法中的字型顏色 (例如 `'#ffffff'` 或 `'white'`)。
`setFontColorObject(color)`	`Range`	設定指定範圍的字型顏色。
`setFontColorObjects(colors)`	`Range`	設定字型顏色的矩形格線 (必須與此範圍的尺寸相符)。
`setFontColors(colors)`	`Range`	設定字型顏色的矩形格線 (必須與此範圍的尺寸相符)。
`setFontFamilies(fontFamilies)`	`Range`	設定字型系列的矩形格線 (必須與此範圍的尺寸相符)。
`setFontFamily(fontFamily)`	`Range`	設定字型系列，例如「myactivity」或「Helvetica」
`setFontLine(fontLine)`	`Range`	設定指定範圍 (`'underline'`、`'line-through'` 或 `'none'`)。
`setFontLines(fontLines)`	`Range`	設定線條樣式的矩形格線 (必須與此範圍的尺寸相符)。
`setFontSize(size)`	`Range`	設定字型大小，並將大小設為要使用的點大小。
`setFontSizes(sizes)`	`Range`	設定字型大小的矩形格線 (必須與此範圍的尺寸相符)。
`setFontStyle(fontStyle)`	`Range`	設定指定範圍 (`'italic'` 或 `'normal'`) 的字型樣式。
`setFontStyles(fontStyles)`	`Range`	設定字型樣式的矩形格線 (必須與此範圍的尺寸相符)。
`setFontWeight(fontWeight)`	`Range`	設定指定範圍的字型粗細 (一般/粗體)。
`setFontWeights(fontWeights)`	`Range`	設定字型粗細的矩形格線 (必須與此範圍的尺寸相符)。
`setFormula(formula)`	`Range`	更新這個範圍的公式。
`setFormulaR1C1(formula)`	`Range`	更新這個範圍的公式。
`setFormulas(formulas)`	`Range`	設定公式的矩形格線 (必須與這個範圍的尺寸相符)。
`setFormulasR1C1(formulas)`	`Range`	設定公式的矩形格線 (必須與這個範圍的尺寸相符)。
`setHorizontalAlignment(alignment)`	`Range`	設定指定範圍的水平 (從左到右) 對齊 (左/中/右)。
`setHorizontalAlignments(alignments)`	`Range`	設定水平對齊的矩形格線。
`setNote(note)`	`Range`	將記事設為指定值。
`setNotes(notes)`	`Range`	設定附註的矩形格線 (必須與這個範圍的尺寸相符)。
`setNumberFormat(numberFormat)`	`Range`	將數字或日期格式設為指定的格式字串。
`setNumberFormats(numberFormats)`	`Range`	設定矩形數字或日期格式的矩形網格 (必須與此範圍的尺寸相符)。
`setRichTextValue(value)`	`Range`	設定範圍中儲存格的 RTF 格式值。
`setRichTextValues(values)`	`Range`	設定 RTF 格式的矩形格線。
`setShowHyperlink(showHyperlink)`	`Range`	設定範圍是否應顯示超連結。
`setTextDirection(direction)`	`Range`	設定範圍中儲存格的文字方向。
`setTextDirections(directions)`	`Range`	設定文字方向的矩形格線。
`setTextRotation(degrees)`	`Range`	設定範圍中儲存格的文字旋轉設定。
`setTextRotation(rotation)`	`Range`	設定範圍中儲存格的文字旋轉設定。
`setTextRotations(rotations)`	`Range`	設定文字旋轉的矩形格線。
`setTextStyle(style)`	`Range`	設定範圍中儲存格的文字樣式。
`setTextStyles(styles)`	`Range`	設定文字樣式的矩形格線。
`setValue(value)`	`Range`	設定範圍的值。
`setValues(values)`	`Range`	設定矩形值的矩形網格 (必須與此範圍的尺寸相符)。
`setVerticalAlignment(alignment)`	`Range`	設定指定範圍 (頂端/中間/底部) 的垂直 (由上至下) 對齊。
`setVerticalAlignments(alignments)`	`Range`	設定垂直對齊的矩形格線 (必須與此範圍的尺寸相符)。
`setVerticalText(isVertical)`	`Range`	設定是否要堆疊範圍中的儲存格文字。
`setWrap(isWrapEnabled)`	`Range`	設定指定範圍的儲存格換行。
`setWrapStrategies(strategies)`	`Range`	設定環繞策略的矩形格線。
`setWrapStrategy(strategy)`	`Range`	為範圍中的儲存格設定文字換行策略。
`setWraps(isWrapEnabled)`	`Range`	設定文字換行政策的矩形格線 (必須與此範圍的尺寸相符)。
`shiftColumnGroupDepth(delta)`	`Range`	依指定幅度變更範圍的欄分組深度。
`shiftRowGroupDepth(delta)`	`Range`	依據指定的金額變更範圍的列群組深度。
`sort(sortSpecObj)`	`Range`	依指定欄和順序排序指定範圍內的儲存格。
`splitTextToColumns()`	`void`	這個外掛程式能根據自動偵測的分隔符號將文字欄分割為多個資料欄。
`splitTextToColumns(delimiter)`	`void`	使用指定的字串做為自訂分隔符號，將文字欄分割為多個資料欄。
`splitTextToColumns(delimiter)`	`void`	這個外掛程式能根據您指定的分隔符號將文字欄分割為多個資料欄。
`trimWhitespace()`	`Range`	移除這個範圍內每個儲存格中的空白字元 (例如空格、Tab 字元或換行字元)。
`uncheck()`	`Range`	將範圍內核取方塊的狀態變更為「未勾選」。

已淘汰的方法

方法	傳回類型	簡短說明
`getFontColor()`	`String`	以 CSS 標記法傳回儲存格在範圍左上角的字型顏色 (例如如 `'#ffffff'` 或 `'white'`)。
`getFontColors()`	`String[][]`	傳回 CSS 標記法範圍內的儲存格字型顏色 (例如 `'#ffffff'` 或 `'white'`)。

內容詳盡的說明文件

`activate()`

將指定範圍設為 active range，其中最上方範圍左儲存格做為 current cell。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:D10');
range.activate();

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

回攻員

Range：這個範圍用於鏈結。

`activateAsCurrentCell()`

將指定儲存格設為 current cell。

如果指定的儲存格位於現有範圍內，則該範圍會變成有效範圍範圍以目前儲存格為儲存格。

如果指定的儲存格不在任何現有範圍內，則現有的選取範圍會是這個儲存格就會變成目前的儲存格和使用中的範圍

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

// Gets the first sheet of the spreadsheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
var range = sheet.getRange('B5');
var currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`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');

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

參數

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

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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');

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

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

參數

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

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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');

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

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

參數

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

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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');

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
  'NAME',
  'GOOGLE',
  SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

參數

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

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`applyColumnBanding()`

對範圍套用預設的欄頻帶主題。根據預設，頻帶包含頁首和頁尾顏色。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject().asRgbColor().asHexString());

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

回攻員

Banding — 新頻帶。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`applyColumnBanding(bandingTheme)`

對範圍套用指定的欄頻帶主題。根據預設，頻帶具有標頭和無頁尾顏色。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

參數

名稱	類型	說明
`bandingTheme`	`BandingTheme`	要套用至範圍中資料欄的色彩主題。

回攻員

Banding — 新頻帶。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`applyColumnBanding(bandingTheme, showHeader, showFooter)`

將指定的欄頻帶主題套用至含有指定頁首和頁尾的範圍可以管理叢集設定，像是節點資源調度、安全性和其他預先設定項目

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.BLUE, false, true);

// Gets the banding color and logs it to the console.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

// Gets the header color object and logs it to the console. Returns null because the header
// visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(sheet.getBandings()[0].getFooterColumnColorObject().asRgbColor().asHexString());

參數

名稱	類型	說明
`bandingTheme`	`BandingTheme`	要套用至範圍中資料欄的色彩主題。
`showHeader`	`Boolean`	如果為 `true`，系統會對第一個套用色帶主題的標頭顏色。。
`showFooter`	`Boolean`	如果為 `true`，則色帶主題頁尾顏色會套用到最後一個。

回攻員

Banding — 新頻帶。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`applyRowBanding()`

對範圍套用預設的列頻帶主題。根據預設，頻帶包含頁首和頁尾顏色。

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

回攻員

Banding - 頻帶。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`applyRowBanding(bandingTheme)`

將指定的列頻帶主題套用到範圍。根據預設，頻帶包含頁首和頁尾顏色。

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

參數

名稱	類型	說明
`bandingTheme`	`BandingTheme`	要套用至範圍內資料列的色彩主題。

回攻員

Banding — 新頻帶。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`applyRowBanding(bandingTheme, showHeader, showFooter)`

將指定的列頻帶主題套用至指定標頭和頁尾設定的範圍。

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

參數

名稱	類型	說明
`bandingTheme`	`BandingTheme`	要套用至範圍內資料列的色彩主題。
`showHeader`	`Boolean`	如果設為 `true`，則色帶主題的標頭顏色會套用至第一列。
`showFooter`	`Boolean`	如果設為 `true`，則區塊主題頁尾顏色會套用至最後一列。

回攻員

Banding — 新頻帶。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`autoFill(destination, series)`

根據此範圍的資料，在 destinationRange 中填入資料。新的值也會由指定的 series 類型決定。目的地範圍必須包含並只往一個方向延伸。舉例來說，下列程式碼會填入 A1:A20 以及根據 A1:A4 中目前值的一連串遞增數字：

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var destination = sheet.getRange("A1:A20");

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

參數

名稱	類型	說明
`destination`	`Range`	要自動填入值的範圍。目的地範圍只包含這個範圍，而且只朝一個方向延伸 (向上、向下、向左或右邊)。
`series`	`AutoFillSeries`	用來計算新值的 AutoFill 系列類型。此系列的效果會因來源資料的類型和數量而異。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`autoFillToNeighbor(series)`

計算範圍，根據鄰近儲存格填入新資料並自動填入，根據此範圍內的資料，設定新的值範圍。這些新的值取決於指定的 series 類型

計算的目的地範圍會考量周遭資料，來判斷新的應該插入「值」：如果資料位於自動填入的新值只會延伸至這些資料相鄰的資料。

舉例來說，如果 A1:A20 填入了一連串遞增數字，而這個方法會在包含一系列日期的 B1:B4 上呼叫，但新值只會已插入 B5:B20。因此，這些新的值會「stick」包含值。

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var sourceRange = sheet.getRange("B1:B4");

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

參數

名稱	類型	說明
`series`	`AutoFillSeries`	用來計算新值的 AutoFill 系列類型。此系列的效果會因來源資料的類型和數量而異。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`breakApart()`

將範圍內的所有多欄儲存格，再次拆解成個別儲存格。

對範圍呼叫這個函式等同於選取範圍，然後按一下依序前往「格式」>「合併儲存格」>「取消合併」。

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`canEdit()`

決定使用者是否有權編輯範圍內的所有儲存格。試算表擁有者隨時可以編輯受保護的範圍和工作表。

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

回攻員

Boolean - true，如果使用者俱備編輯範圍中所有儲存格的權限；false 反之。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`check()`

將範圍內核取方塊的狀態變更為「已勾選」。忽略範圍中的儲存格但目前不包含已設定的勾選或未勾選值。

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'checked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`clear()`

清除內容和格式範圍。

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

var range = sheet.getRange("A1:D10");
range.clear();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`clear(options)`

清除使用顯示的進階選項根據預設，系統會清除所有資料。

// The code below clears range C2:G7 in the active sheet, but preserves the format,
// data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({contentsOnly: true});

參數

名稱	類型	說明
`options`	`Object`	指定進階參數的 JavaScript 物件，如下所示。

進階參數

名稱	類型	說明
`commentsOnly`	`Boolean`	是否僅清除留言。
`contentsOnly`	`Boolean`	是否僅清除內容。
`formatOnly`	`Boolean`	是否僅清除格式；請注意格式也會清除資料驗證規則。
`validationsOnly`	`Boolean`	是否僅清除資料驗證規則。
`skipFilteredRows`	`Boolean`	是否清除篩除的資料列。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`clearContent()`

清除範圍中的內容，保留格式不變。

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

var range = sheet.getRange("A1:D10");
range.clearContent();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`clearDataValidations()`

清除這個範圍的資料驗證規則。

// Clear the data validation rules for cells A1:B5.
var range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`clearFormat()`

清除這個範圍的格式設定。

這會清除範圍內儲存格或儲存格的文字格式設定，但不會重設任何數字格式設定規則

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

var range = sheet.getRange("A1:D10");
range.clearFormat();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`clearNote()`

清除指定儲存格或儲存格中的記事。

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

var range = sheet.getRange("A1:D10");
range.clearNote();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`collapseGroups()`

收合屬於該範圍的所有群組。如果沒有任何群組範圍中，有部分覆蓋的最深展開群組會收合。

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

// All row and column groups within the range are collapsed.
range.collapseGroups();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`

將範圍的格式複製到指定的位置。如果目的地較大或較小來源範圍中的值，系統就會重複或截斷來源。請注意，此方法只會複製格式。

如需 MeshId 參數的詳細說明，請參閱 getGridId()。

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

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

參數

名稱	類型	說明
`gridId`	`Integer`	試算表中的工作表專屬 ID (無論位置為何)。
`column`	`Integer`	目標範圍的第一欄。
`columnEnd`	`Integer`	目標範圍的結尾欄。
`row`	`Integer`	目標範圍的起始列。
`rowEnd`	`Integer`	目標範圍的結束列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

另請參閱

getGridId()

`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`

將範圍的格式複製到指定的位置。如果目的地較大或較小來源範圍中的值，系統就會重複或截斷來源。請注意，此方法只會複製格式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

參數

名稱	類型	說明
`sheet`	`Sheet`	目標工作表。
`column`	`Integer`	目標範圍的第一欄。
`columnEnd`	`Integer`	目標範圍的結尾欄。
`row`	`Integer`	目標範圍的起始列。
`rowEnd`	`Integer`	目標範圍的結束列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`copyTo(destination)`

將特定儲存格範圍的資料複製到其他儲存格範圍。值和格式設定已複製完成

// The code below copies the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

參數

名稱	類型	說明
`destination`	`Range`	複製目的地範圍；只有左上角的儲存格位置相關。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`copyTo(destination, copyPasteType, transposed)`

將特定儲存格範圍的資料複製到其他儲存格範圍。

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES,
false);

參數

名稱	類型	說明
`destination`	`Range`	複製目的地範圍；只有左上角的儲存格位置相關。
`copyPasteType`	`CopyPasteType`	指定如何將範圍內容貼到目的地。
`transposed`	`Boolean`	是否應將範圍貼上轉換方向貼上。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`copyTo(destination, options)`

將特定儲存格範圍的資料複製到其他儲存格範圍。根據預設的格式就會複製，但也可以使用進階引數覆寫這項設定。

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});

參數

名稱	類型	說明
`destination`	`Range`	複製目的地範圍；只有左上角的儲存格位置相關。
`options`	`Object`	指定進階參數的 JavaScript 物件，如下所示。

進階參數

名稱	類型	說明
`formatOnly`	`Boolean`	指定只應複製該格式
`contentsOnly`	`Boolean`	指定只應複製內容

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`

將範圍的內容複製到指定位置。如果目的地較大或較小來源範圍中的值，系統就會重複或截斷來源。

如需 MeshId 參數的詳細說明，請參閱 getGridId()。

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

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

參數

名稱	類型	說明
`gridId`	`Integer`	試算表中的工作表專屬 ID (無論位置為何)。
`column`	`Integer`	目標範圍的第一欄。
`columnEnd`	`Integer`	目標範圍的結尾欄。
`row`	`Integer`	目標範圍的起始列。
`rowEnd`	`Integer`	目標範圍的結束列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

另請參閱

getGridId()

`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`

將範圍的內容複製到指定位置。如果目的地較大或較小來源範圍中的值，系統就會重複或截斷來源。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

參數

名稱	類型	說明
`sheet`	`Sheet`	目標工作表。
`column`	`Integer`	目標範圍的第一欄。
`columnEnd`	`Integer`	目標範圍的結尾欄。
`row`	`Integer`	目標範圍的起始列。
`rowEnd`	`Integer`	目標範圍的結束列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`createDataSourcePivotTable(dataSource)`

從資料來源建立空白的資料來源資料透視表，固定在這個範圍

本例說明如何建立及設定新的資料來源資料透視表。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM);
pivotTable.addFilter('dataColumnA',
                     SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());

參數

名稱	類型	說明
`dataSource`	`DataSource`	要建立資料透視表的來源資料來源。

回攻員

DataSourcePivotTable：新建的資料來源資料透視表。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`createDataSourceTable(dataSource)`

從資料來源建立空白的資料來源表格，固定在以下內容的第一個儲存格範圍。

本例說明如何建立及設定新的資料來源資料表。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var dataSourceTable = anchorCell.createDataSourceTable(dataSource);
    .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
    .addSortSpec('dataColumnA', /* ascending= *\/ true)
    .addSortSpec('dataColumnB', /* ascending= *\/ false);

參數

名稱	類型	說明
`dataSource`	`DataSource`	要建立資料透視表的來源資料來源。

回攻員

DataSourceTable：新建的資料來源資料表。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`createDeveloperMetadataFinder()`

傳回 DeveloperMetadataFinderApi，以尋找此範圍內的開發人員中繼資料範圍。只有當中繼資料完全隸屬於該範圍時，中繼資料才會在範圍內範圍。舉例來說，與第 3:3 列相關聯的中繼資料不在範圍內「A1:D5」但位於「1:5」範圍內

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

回攻員

DeveloperMetadataFinder：開發人員中繼資料搜尋器，可搜尋這個範圍內的中繼資料。

`createFilter()`

建立篩選器，並套用至工作表中的指定範圍。您建立的數量上限一個篩選器如要在建立篩選器後存取及修改篩選器，請使用 getFilter() 或 Sheet.getFilter()。

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}

敬上請使用這個方法為 Grid 工作表 (預設類型的工作表) 建立篩選器。格狀工作表是未連結至資料庫的工作表。如要建立其他類型的篩選器請參閱下列資源：

使用「PivotTable.addFilter(sourceDataColumn, filterCriteria)」建立資料透視表篩選器
使用 DataSourceSheet.addFilter(columnName, filterCriteria) 為連結至資料庫的工作表建立篩選器
使用 DataSourcePivotTable.addFilter(columnName, filterCriteria) 為資料透視表建立篩選器，連結至資料庫

回攻員

Filter：新的篩選器。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`createPivotTable(sourceData)`

從指定sourceData (固定在第一個儲存格) 建立空白資料透視表符合範圍內

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

參數

名稱	類型	說明
`sourceData`	`Range`	要用來建立資料透視表的資料。

回攻員

PivotTable：新建立的 PivotTable。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`createTextFinder(findText)`

建立範圍的文字搜尋器，以便尋找和取代這個範圍中的文字。

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

// Creates  a text finder for the range.
var textFinder = range.createTextFinder('dog');

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

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

參數

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

回攻員

TextFinder：範圍的 TextFinder

`deleteCells(shiftDimension)`

刪除這個儲存格範圍。與所提供維度一起，工作表中的現有資料會隨著移動接近刪除範圍

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

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

參數

名稱	類型	說明
`shiftDimension`	`Dimension`	用於移轉現有資料的維度。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`expandGroups()`

展開範圍或控制項切換鈕與這個範圍交集的收合群組。控制項切換位置是指顯示控制項切換鈕的位置，緊接在視設定而定如果同一個營業地點有多個群組 Fitbit 團隊已展開

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

// All row and column groups within the range are expanded.
range.expandGroups();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getA1Notation()`

傳回範圍的字串說明 (使用 A1 標記法)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

回攻員

String：A1 標記法中的範圍字串說明。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getBackground()`

傳回範圍中左上角儲存格的背景顏色 (例如 '#ffffff')。

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackground());

回攻員

String：背景的顏色代碼。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getBackgroundObject()`

傳回範圍中左上角儲存格的背景顏色。

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

回攻員

Color：範圍左上角儲存格的背景顏色。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getBackgroundObjects()`

傳回範圍中儲存格的背景顏色。

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

回攻員

Color[][]：背景顏色的 2D 陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getBackgrounds()`

傳回範圍中儲存格的背景顏色 (例如 '#ffffff')。

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

回攻員

String[][]：背景色彩代碼的 2D 陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getBandings()`

傳回套用至這個範圍內任何儲存格的色帶。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (let banding of bandings) {
  console.log(banding.getSecondRowColor());
}

回攻員

Banding[] - 套用至這個範圍內任何儲存格的色帶。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getCell(row, column)`

傳回某範圍內的指定儲存格。

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

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

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
var cell = range.getCell(1, 1);
Logger.log(cell.getValue());

參數

名稱	類型	說明
`row`	`Integer`	儲存格相對於範圍的列。
`column`	`Integer`	儲存格相對於範圍的欄。

回攻員

Range：包含指定座標的單一儲存格範圍。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getColumn()`

傳回這個範圍的起始欄位置。

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

var range = sheet.getRange("B2:D4");
// Logs "2.0"
Logger.log(range.getColumn());

回攻員

Integer：試算表中該範圍的起始欄位置。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDataRegion()`

傳回四個基數 Direction 中展開的範圍副本，涵蓋所有相鄰儲存格中的資料，如果範圍包含空白儲存格 (不包含這些儲存格) 沿著對角線方向傳回範圍本身這與選取範圍在編輯器中輸入 Ctrl+A。

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());

回攻員

Range：整份試算表的範圍資料地區或範圍。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDataRegion(dimension)`

傳回 Direction.UP 和 Direction.DOWN 展開範圍的副本 (如果的指定維度是 Dimension.ROWS，或 Direction.NEXT 和 Direction.PREVIOUS (如果維度為 Dimension.COLUMNS)。範圍擴大是根據在表格形式整理出的範圍旁邊偵測資料。擴大範圍涵蓋所有相鄰儲存格中的資料，其中包含指定維度的資料，包括表格界定範圍如果原始範圍在指定維度周圍有空白儲存格，範圍本身。這個方法類似於在編輯器中選取範圍並輸入資料欄的 Ctrl+Space，或在編輯器中輸入 Shift+Space。

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "C2:C4"
Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation());
// Logs "B3:D3"
Logger.log(
    sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());

參數

名稱	類型	說明
`dimension`	`Dimension`	用來擴大範圍的維度。

回攻員

Range — 範圍的資料地區或範圍，涵蓋了每一欄或跨列的各列原始範圍。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDataSourceFormula()`

傳回範圍內第一個儲存格的 DataSourceFormula；如果傳回值，則傳回 null 儲存格不含資料來源公式。

// 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 the range A1 on Sheet1.
const range = sheet.getRange('A1');

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

回攻員

DataSourceFormula - 儲存格的 DataSourceFormula。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDataSourceFormulas()`

傳回範圍內儲存格的 DataSourceFormula。

// 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 the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

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

回攻員

DataSourceFormula[] — 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.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

`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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

回攻員

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

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDataSourceUrl()`

傳回這個範圍內資料的網址，可用來建立圖表和查詢。

Code.gs

function doGet() {
  var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c');
  var sheet = ss.getSheetByName('ContinentData');
  var range = sheet.getRange('A1:B8');

  var template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

piechart.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

回攻員

String：這個範圍的網址做為資料來源，可傳遞至其他 API (例如圖表)。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDataTable()`

以 DataTable 的形式傳回這個物件內的資料。

// 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 the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

// Gets the range A1:B7 as a data table. The values in each column must be of the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

回攻員

DataTable：以資料表形式呈現資料。

`getDataTable(firstRowIsHeader)`

以資料表的形式傳回這個範圍內的資料。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:B7");

// Calling this method with "true" sets the first line to be the title of the axes
var datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
var chart = Charts.newBarChart()
    .setDataTable(datatable)
    .setOption("title", "Your Title Here")
    .build();

參數

名稱	類型	說明
`firstRowIsHeader`	`Boolean`	是否將第一列設為標題。

回攻員

DataTable：以資料表格形式呈現的資料。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDataValidation()`

傳回範圍內左上方的儲存格的資料驗證規則。如果資料驗證作業已在儲存格中設定，則此方法會傳回 null。

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

回攻員

DataValidation：範圍左上角儲存格的資料驗證規則。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDataValidations()`

傳回範圍內所有儲存格的資料驗證規則。如果未驗證資料這個方法會針對該儲存格在陣列中的位置傳回 null。

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

回攻員

DataValidation[][]：與範圍。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

回攻員

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

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDisplayValue()`

傳回範圍左上角儲存格的顯示值。值為 String。顯示的值會考量日期、時間和貨幣格式設定，包括格式是由試算表的語言代碼設定自動套用。空白儲存格傳回空白值字串。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

回攻員

String：這個儲存格中顯示的值。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getDisplayValues()`

傳回這個範圍值的矩形網格。

傳回顯示值的二維陣列，先依列再依欄建立索引。值為 String 物件顯示的值會將日期、時間和貨幣格式，包括由試算表語言代碼自動套用的格式以及環境敘述空白儲存格會以陣列中的空字串表示。請記住，範圍索引從 1, 1 開始，JavaScript 陣列是從 [0][0] 建立索引。

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

回攻員

String[][]：值的二維陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFilter()`

傳回這個範圍所屬工作表上的篩選器；如果沒有篩選器，則傳回 null 工作表。

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

回攻員

Filter：篩選器。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontColorObject()`

傳回範圍左上角的儲存格字型顏色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

回攻員

Color：範圍左上角儲存格的字型顏色。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontColorObjects()`

傳回範圍中儲存格的字型顏色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColorObjects();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

回攻員

Color[][]：與範圍中的儲存格相關聯的 2D 字型顏色陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontFamilies()`

傳回範圍中儲存格的字型系列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontFamilies();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

String[][] — 與範圍中的儲存格相關聯的 2D 字型系列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontFamily()`

傳回範圍左上角的儲存格字型系列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontFamily());

回攻員

String — 儲存格的字型系列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontLine()`

取得儲存格範圍左上角的儲存格線條樣式 ('underline'、 'line-through' 或 'none')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontLine());

回攻員

String：字型行。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontLines()`

取得範圍中儲存格的線條樣式 ('underline'、'line-through' 或 'none')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontLines();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

String[][]：與範圍中的儲存格相關聯的二維字型陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontSize()`

傳回範圍左上角儲存格的字型大小 (以點大小表示)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontSize());

回攻員

Integer：點大小的字型大小。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontSizes()`

傳回範圍中儲存格的字型大小。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontSizes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

Integer[][]：範圍中儲存格相關文字的二維陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontStyle()`

傳回左上角儲存格的字型樣式 ('italic' 或 'normal') 音量大小

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontStyle());

回攻員

String：儲存格中文字的字型樣式。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontStyles()`

傳回範圍中儲存格的字型樣式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontStyles();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

String[][] — 範圍中與儲存格相關聯的文字字型樣式二維陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontWeight()`

傳回儲存格範圍左上角的儲存格字型粗細 (一般/粗體)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontWeight());

回攻員

String：儲存格中文字的字型粗細。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontWeights()`

傳回範圍內儲存格的字型粗細。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontWeights();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

String[][]：範圍中儲存格相關文字的 2D 字型粗細陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFormula()`

傳回範圍左上角儲存格的公式 (A1 標記法)，如果傳回空白字串，則傳回空白字串儲存格空白或不含公式。

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

// This assumes you have a function in B5 that sums up
// B2:B4
var range = sheet.getRange("B5");

// Logs the calculated value and the formula
Logger.log("Calculated value: %s Formula: %s",
           range.getValue(),
           range.getFormula());

回攻員

String：儲存格的公式。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFormulaR1C1()`

傳回指定儲存格的公式 (R1C1 標記法)；如果沒有，傳回 null。

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

var range = sheet.getRange("B5");
var formula = range.getFormulaR1C1();
Logger.log(formula);

回攻員

String：R1C1 標記法中的公式。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFormulas()`

傳回範圍內儲存格的公式 (A1 標記法)。2D 陣列中的項目不含公式的儲存格為空字串。

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

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulas();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

回攻員

String[][]：字串格式的二維陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFormulasR1C1()`

傳回範圍內儲存格的公式 (R1C1 標記法)。2D 陣列中的項目 null 代表不含公式的儲存格。

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

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulasR1C1();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

回攻員

String[][]：R1C1 標記法中的二維公式陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getGridId()`

傳回範圍父項工作表的格線 ID。ID 是隨機的非負整數值。

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getGridId());

回攻員

Integer：父項工作表的格線 ID。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getHeight()`

傳回範圍的高度。

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

var range = sheet.getRange("B2:D4");
// logs 3.0
Logger.log(range.getHeight());

回攻員

Integer：範圍的高度。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getHorizontalAlignment()`

傳回左上方的儲存格文字的水平對齊方式 (左側/中間/右側) 音量大小

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getHorizontalAlignment());

回攻員

String：儲存格中文字的水平對齊方式。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getHorizontalAlignments()`

傳回儲存格範圍中儲存格的水平對齊方式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getHorizontalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

String[][]：與儲存格中儲存格相關聯的水平對齊方式 2D 陣列，範圍。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getLastColumn()`

傳回結束欄位置。

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

var range = sheet.getRange("B2:D4");
// Logs "4.0"
Logger.log(range.getLastColumn());

回攻員

Integer：試算表中該範圍的結尾欄位置。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getLastRow()`

傳回結束列位置。

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

var range = sheet.getRange("B2:D4");
// Logs "4.0"
Logger.log(range.getLastRow());

回攻員

Integer：試算表中該範圍的結束列位置。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getMergedRanges()`

傳回 Range 物件的陣列，代表已完全合併的儲存格在目前的範圍內，或目前範圍中至少有一個儲存格。

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

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

var mergedRanges = range.getMergedRanges();
for (var i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

回攻員

Range[]：Range 物件的陣列，代表範圍重疊的合併儲存格。

`getNextDataCell(direction)`

從範圍第一欄和範圍中第一列的儲存格開始，傳回指定的方向，是指內含資料的連續儲存格範圍的邊緣，或是內含資料的儲存格設為「自動開啟」這相當於在編輯器中輸入 Ctrl+[arrow key]。

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("C3:E5");
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

參數

名稱	類型	說明
`direction`	`Direction`	尋找下一個資料地區邊緣儲存格的方向。

回攻員

Range：資料地區邊緣儲存格或試算表邊緣的儲存格。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getNote()`

傳回與指定範圍相關聯的附註。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getNote());

回攻員

String - 與指定儲存格相關聯的附註。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getNotes()`

傳回與範圍中儲存格相關的附註。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getNotes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

String[][]：與範圍中的儲存格相關聯的 2D 記事陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getNumColumns()`

傳回這個範圍內的欄數。

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumColumns());

回攻員

Integer：這個範圍的欄數。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getNumRows()`

傳回這個範圍內的列數。

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumRows());

回攻員

Integer：這個範圍的列數。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getNumberFormat()`

取得指定範圍左上方的儲存格的數字或日期格式。傳回的格式如要進一步瞭解模式，請參閱 Sheets API 說明文件。

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

var cell = sheet.getRange("C4");
Logger.log(cell.getNumberFormat());

回攻員

String：範圍左上角儲存格的數字格式。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getNumberFormats()`

傳回範圍中儲存格的數字或日期格式。傳回的格式模式為一文中所述的 Sheets API 說明文件。

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

var range = sheet.getRange("B5:C6");
var formats = range.getNumberFormats();
for (var i in formats) {
  for (var j in formats[i]) {
    Logger.log(formats[i][j]);
  }
}

回攻員

String[][]：數字格式的二維陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getRichTextValue()`

傳回範圍左上方的儲存格的 RTF 格式值，如果儲存格中的儲存格，則傳回 null 值不是文字。

// Gets the Rich Text value of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var richText = range.getRichTextValue();
console.log(richText.getText());

回攻員

RichTextValue：範圍中左上方的儲存格的 RTF 格式值，或 null 儲存格 (如果儲存格) 值不是文字。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getRichTextValues()`

傳回範圍中儲存格的 RTF 格式值。

// Gets the Rich Text values for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var values = range.getRichTextValues();

for (var i = 0; i < values.length; i++) {
  for (var j = 0; j < values[i].length; j++) {
    console.log(values[i][j].getText());
  }
}

回攻員

RichTextValue[][]：RTF 格式的二維陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getRow()`

傳回這個範圍的列位置。與 getRowIndex() 相同。

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

var range = sheet.getRange("B2");
Logger.log(range.getRow());

回攻員

Integer：範圍的資料列位置。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getRowIndex()`

傳回這個範圍的列位置。與 getRow() 相同。

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

var range = sheet.getRange("B2");
Logger.log(range.getRowIndex());

回攻員

Integer：範圍的資料列位置。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

另請參閱

getRow()

`getSheet()`

傳回這個範圍所屬的工作表。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the sheet that the range belongs to.
const rangeSheet = range.getSheet();

// Gets the sheet name and logs it to the console.
console.log(rangeSheet.getName());

回攻員

Sheet：這個範圍所屬的工作表。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getTextDirection()`

傳回範圍左上方的儲存格的文字方向。如果儲存格含有 null，則傳回 null 文字方向是由自動偵測機制決定。

// Get the text direction of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getTextDirection());

回攻員

TextDirection：左上角儲存格的文字方向，位於範圍中。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getTextDirections()`

傳回儲存格範圍內儲存格的文字方向。2D 陣列中的項目是採用自動偵測技術的儲存格 null。

// Get the text directions for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var directions = range.getTextDirections();

for (var i = 0; i < directions.length; i++) {
  for (var j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

回攻員

TextDirection[][]：文字方向的 2D 陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getTextRotation()`

傳回範圍左上方的儲存格的文字旋轉設定。

// Log the text rotation settings for a cell.
var sheet = SpreadsheetApp.getActiveSheet();

var cell = sheet.getRange("A1");
Logger.log(cell.getTextRotation());

回攻員

TextRotation：文字旋轉設定。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getTextRotations()`

傳回範圍內儲存格的文字旋轉設定。

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

var results = range.getTextRotations();

for (var i in results) {
  for (var j in results[i]) {
    var rotation = results[i][j];
    Logger.log("Cell [%s, %s] has text rotation: %v", i, j, rotation);
  }
}

回攻員

TextRotation[][]：與範圍中的儲存格相關聯的二維文字旋轉陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getTextStyle()`

傳回範圍左上方的儲存格的文字樣式。

// Get the text style of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var style = range.getTextStyle();
Logger.log(style);

回攻員

TextStyle：範圍左上方儲存格的文字樣式。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getTextStyles()`

傳回範圍中儲存格的文字樣式。

// Get the text styles for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var styles = range.getTextStyles();

for (var i = 0; i < styles.length; i++) {
  for (var j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

回攻員

TextStyle[][]：文字樣式的 2D 陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getValue()`

傳回範圍內左上方的儲存格的值。值可以是 Number 類型。 Boolean、Date 或 String，視儲存格的值而定。空白儲存格傳回空白字串。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the value of the top-left cell in the range and logs it to the console.
console.log(range.getValue());

回攻員

Object - 這個儲存格中的值。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getValues()`

傳回這個範圍值的矩形網格。

傳回值的二維陣列，先依列加入索引，再依欄建立索引。這些值可以是類型為 Number、Boolean、Date 或 String，視。空白儲存格會以陣列中的空字串表示。注意事項範圍索引從 1, 1 開始時，JavaScript 陣列是從 [0][0] 建立索引。

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);

敬上在網頁應用程式中，Date 值並非法律參數。getValues() 無法傳回如果範圍中的儲存格含有 Date 值，則該範圍的資料會轉移至網頁應用程式。而是改用從工作表擷取到支援 JavaScript 基元的所有值，例如 Number、Boolean 或 String。

回攻員

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

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getVerticalAlignment()`

傳回儲存格左上角的垂直對齊方式 (頂端/中間/底部) 範圍。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getVerticalAlignment());

回攻員

String：儲存格中文字的垂直對齊方式。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getVerticalAlignments()`

傳回儲存格範圍中儲存格的垂直對齊方式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

String[][] — 與儲存格中儲存格相關聯的文字垂直對齊的 2D 陣列，範圍。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getWidth()`

傳回資料欄中範圍的寬度。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the width of the range in number of columns and logs it to the console.
console.log(range.getWidth());

回攻員

Integer：範圍中的欄數。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getWrap()`

傳回儲存格中的文字是否換行。如要取得更精細的包裝策略，請使用 getWrapStrategy()。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getWrap());

回攻員

Boolean：這個儲存格中的文字是否換行。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getWrapStrategies()`

傳回範圍內儲存格的文字換行策略。

// Get the text wrapping strategies for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var strategies = range.getWrapStrategies();

for (var i = 0; i < strategies.length; i++) {
  for (var j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

回攻員

WrapStrategy[][]：文字換行策略的 2D 陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getWrapStrategy()`

傳回範圍左上方的儲存格的文字換行策略。

// Get the text wrapping strategy of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getWrapStrategy());

回攻員

WrapStrategy：範圍左上方儲存格的文字包裝策略。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getWraps()`

傳回儲存格內的文字是否換行。如要取得更精細的包裝策略，請使用 getWrapStrategies()。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    var isWrapped = results[i][j];
    if (isWrapped) {
       Logger.log("Cell [%s, %s] has wrapped text", i, j);
    }
  }
}

回攻員

Boolean[][] — 與儲存格中儲存格相關聯的文字垂直對齊的 2D 陣列，範圍。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`insertCells(shiftDimension)`

在這個範圍內插入空白儲存格。新的儲存格會保留儲存格中現有的任何格式設定涵蓋的項目試算表中現有的資料與提供的維度為：移位。

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

var range = sheet.getRange("A1:D10");
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

參數

名稱	類型	說明
`shiftDimension`	`Dimension`	用於移轉現有資料的維度。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`insertCheckboxes()`

在範圍中的每個儲存格中插入核取方塊，並已設定 true 的勾選和 false 為未勾選狀態。將範圍中所有儲存格的值設為 false。

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true' for checked
// and 'false' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'false'.
range.insertCheckboxes();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`insertCheckboxes(checkedValue)`

在範圍中的每個儲存格中插入核取方塊，並為勾選和未勾選的空字串。將範圍內每個儲存格的值設為空字串。

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and the empty string for unchecked. Also, sets the value of each cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

參數

名稱	類型	說明
`checkedValue`	`Object`	核取方塊資料驗證勾選的值。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`insertCheckboxes(checkedValue, uncheckedValue)`

在範圍中的每個儲存格中插入核取方塊，並為勾選的項目設定自訂值以及未勾選狀態將範圍中每個儲存格的值設為自訂未勾選值。

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and 'no' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'no'.
range.insertCheckboxes('yes', 'no');

參數

名稱	類型	說明
`checkedValue`	`Object`	核取方塊資料驗證勾選的值。
`uncheckedValue`	`Object`	核取方塊資料驗證的未勾選值。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`isBlank()`

如果範圍完全空白，則傳回 true。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.isBlank());

回攻員

Boolean - true (範圍空白時)；否則為 false。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`isChecked()`

傳回範圍內所有儲存格目前的核取方塊狀態是否為「已勾選」。如果部分儲存格已勾選，但其餘儲存格沒有勾選，或部分儲存格沒有核取方塊，則傳回 null 資料驗證。

var range = SpreadsheetApp.getActive().getRange('A1:A3');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:A3.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
var isRange1Checked = range1.isChecked();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked value.
var isRange2Checked = range2.isChecked();

var range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox value.
var isRange3Checked = range3.isChecked();

回攻員

Boolean - true (如果已勾選範圍中的所有儲存格，且儲存格中的所有儲存格，則設為 false) 範圍未勾選，如果有任何儲存格未勾選或沒有，則為 null 核取方塊資料驗證。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`isEndColumnBounded()`

決定範圍的結尾是否繫結至特定資料欄。舉例來說，對於範圍 A1:B10 或 B:B，會繫結至範圍結尾的欄，這個方法會傳回 true；3:7 或 A1:5 範圍 (僅繫結至) 附加至範圍結尾的特定資料列，此方法會傳回 false。

 // 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular column and logs it to the
// console.
console.log(range.isEndColumnBounded());

回攻員

Boolean：如果範圍結尾會繫結至特定資料欄，則為 true；false 反之。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`isEndRowBounded()`

判斷範圍的結尾是否與特定資料列繫結。舉例來說，對於範圍 A1:B10 或 3:7，且會繫結至範圍結尾的列，這方法會傳回 true；B:B 或 A1:C 範圍 (僅繫結至) 附加至範圍結尾的特定資料欄，此方法會傳回 false。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular row and logs it to the console.
console.log(range.isEndRowBounded());

回攻員

Boolean — true (如果範圍範圍已繫結至特定資料列)；false 反之。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`isPartOfMerge()`

如果目前範圍內的儲存格與任何合併的儲存格重疊，則傳回 true。

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

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

// True if any of the cells in A1:B3 is included in a merge.
var isPartOfMerge = range.isPartOfMerge();

回攻員

Boolean：如果範圍重疊任何合併的儲存格，則為 true，否則傳回 false。

`isStartColumnBounded()`

決定範圍的開頭是否繫結至特定資料欄。舉例來說，對於範圍 A1:B10 或 B:B，會繫結至範圍開頭的資料欄。此方法會傳回 true；範圍 3:7，只繫結至範圍的起點，這個方法會傳回 false。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular column and logs it to the
// console.
console.log(range.isStartColumnBounded());

回攻員

Boolean：如果範圍的開頭是繫結至特定資料欄，則為 true；false 反之。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`isStartRowBounded()`

判斷範圍的開頭是否與特定資料列繫結。舉例來說，對於範圍 A1:B10 或 3:7，且會繫結至範圍開頭的列，這方法會傳回 true；B:B 範圍，該範圍只限定為特定欄，這個方法會傳回 false。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular row and logs it to the
// console.
console.log(range.isStartRowBounded());

回攻員

Boolean — true如果範圍的開始是與特定資料列繫結，false 反之。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`merge()`

將範圍中的儲存格合併成一個區塊。

var sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`mergeAcross()`

合併範圍內儲存格範圍中的儲存格。

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

// The code below merges cells C5:E5 into one cell
var range1 = sheet.getRange("C5:E5");
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
var range2 = sheet.getRange("F5:H6");
range2.mergeAcross();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`mergeVertically()`

將範圍內的儲存格合併。

var sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`moveTo(target)`

從這個範圍剪下 (格式和值) 並貼到目標範圍。

// The code below moves the first 5 columns over to the 6th column
var sheet = SpreadsheetApp.getActiveSheet()
sheet.getRange("A1:E").moveTo(sheet.getRange("F1"));

參數

名稱	類型	說明
`target`	`Range`	要複製這個範圍的目標範圍只有左上角儲存格的位置是以及相關內容

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`offset(rowOffset, columnOffset)`

傳回新的範圍，該範圍是根據指定的列數和欄數，從這個範圍偏移可以是負數。新範圍的大小與原始範圍相同。

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

var cell = sheet.getRange("A1");

// newCell references B2
var newCell = cell.offset(1, 1);

參數

名稱	類型	說明
`rowOffset`	`Integer`	範圍左上方的儲存格往下的列數；負值。
`columnOffset`	`Integer`	從範圍左上方的儲存格右側顯示的欄數；負值，

回攻員

Range：這個範圍用於鏈結。

`offset(rowOffset, columnOffset, numRows)`

傳回相對於目前範圍的新範圍，左側點會偏移以目前範圍為準並參考指定的欄數和儲存格高度。

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

var cell = sheet.getRange("A1");

// newCell references B2:B3
var newRange = cell.offset(1, 1, 2);

參數

名稱	類型	說明
`rowOffset`	`Integer`	範圍左上方的儲存格往下的列數；負值。
`columnOffset`	`Integer`	從範圍左上方的儲存格右側顯示的欄數；負值，
`numRows`	`Integer`	新範圍資料列的高度。

回攻員

Range：這個範圍用於鏈結。

`offset(rowOffset, columnOffset, numRows, numColumns)`

傳回相對於目前範圍的新範圍，左側點會偏移從目前範圍根據指定的列與欄，輸入的高度和寬度儲存格。

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

var cell = sheet.getRange("A1");

// newCell references B2:C3
var newRange = cell.offset(1, 1, 2, 2);

參數

名稱	類型	說明
`rowOffset`	`Integer`	範圍左上方的儲存格往下的列數；負值。
`columnOffset`	`Integer`	從範圍左上方的儲存格右側顯示的欄數；負值，
`numRows`	`Integer`	新範圍資料列的高度。
`numColumns`	`Integer`	新範圍欄的寬度。

回攻員

Range：這個範圍用於鏈結。

`protect()`

建立可防止編輯範圍的物件 (具備以下特性的使用者除外) 權限。直到指令碼實際變更範圍的編輯器清單為止 (方法是呼叫 Protection.removeEditor(emailAddress)、Protection.removeEditor(user)、Protection.removeEditors(emailAddresses)、Protection.addEditor(emailAddress)、Protection.addEditor(user)、Protection.addEditors(emailAddresses)，或設定新的 Protection.setDomainEdit(editable)的值)，權限與試算表本身，也就是說，該範圍仍未保護。如果範圍是加以保護，這個方法就會建立新的受保護範圍，與現有範圍重疊。如果儲存格受多個保護範圍保護，其中任一儲存格都會阻止特定使用者編輯儲存格，這樣使用者就無權編輯儲存格。

// Protect range A1:B10, then remove all other users from the list of editors.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect().setDescription('Sample protected range');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

回攻員

Protection — 代表防護設定的物件。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`randomize()`

隨機排列指定範圍內資料列的順序。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Randomizes the range
range.randomize();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`removeCheckboxes()`

移除範圍中的所有核取方塊。清除每個儲存格的資料驗證。此外，如果儲存格含有已勾選或未勾選的值，則也會清除該值。

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`removeDuplicates()`

移除這個範圍內含有與任一值重複的值的資料列。。值相同，但字母大小寫、格式或公式不同的列就會視為重複這個方法也會移除檢視畫面中隱藏的重複資料列 (適用於原因)。系統不會移除超出此範圍的內容。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B1:D7");

// Remove duplicate rows in the range.
range.removeDuplicates();

回攻員

Range：移除重複項目後的結果範圍。範圍大小縮減了列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`removeDuplicates(columnsToCompare)`

移除這個範圍內含有重複指定資料欄中值重複的資料列。值相同，但字母大小寫、格式、就會視為重複。這個方法也會移除隱藏的重複資料列 (例如受到篩選器影響)系統不會移除超出此範圍的內容。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B1:D7");

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2,4]);

參數

名稱	類型	說明
`columnsToCompare`	`Integer[]`	要分析重複值的資料欄。如果沒有提供任何資料欄系統就會分析所有資料欄是否有重複的項目

回攻員

Range：移除重複項目後的結果範圍。範圍大小縮減了列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setBackground(color)`

設定 CSS 標記法範圍內所有儲存格的背景顏色 (例如 '#ffffff') 或 'white')。

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

var range = sheet.getRange("B2:D5");
range.setBackground("red");

參數

名稱	類型	說明
`color`	`String`	CSS 標記法中的顏色代碼 (例如 `'#ffffff'` 或 `'white'`)；換 `null` 值會重設顏色。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setBackgroundObject(color)`

設定範圍內所有儲存格的背景顏色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var bgColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();

var range = sheet.getRange("B2:D5");
range.setBackgroundObject(bgColor);

參數

名稱	類型	說明
`color`	`Color`	要設定的背景顏色；`null` 值會重設背景顏色。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setBackgroundObjects(color)`

設定背景顏色的矩形格線 (必須與此範圍的尺寸相符)。

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

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setBackgroundObjects(colors);

參數

名稱	類型	說明
`color`	`Color[][]`	使用 2D 色彩陣列；`null` 值會重設顏色。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setBackgroundRGB(red, green, blue)`

使用 RGB 值 (介於 0 到 255 之間的整數) 將背景設為指定色彩。

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

var cell = sheet.getRange("B2");

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

參數

名稱	類型	說明
`red`	`Integer`	以 RGB 標記法表示的紅色值。
`green`	`Integer`	以 RGB 標記法表示的綠色值。
`blue`	`Integer`	採用 RGB 標記法的藍色值。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setBackgrounds(color)`

設定背景顏色的矩形格線 (必須與此範圍的尺寸相符)。色彩採用 CSS 標記法 (例如 '#ffffff' 或 'white')。

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

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setBackgrounds(colors);

參數

名稱	類型	說明
`color`	`String[][]`	CSS 標記法中的 2D 顏色陣列 (例如 `'#ffffff'` 或 `'white'`);`null` 值會重設顏色。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setBorder(top, left, bottom, right, vertical, horizontal)`

設定邊框屬性。有效值為 true (開啟)、false (關閉) 和 null (無變更)。

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

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

參數

名稱	類型	說明
`top`	`Boolean`	`true` 代錶框線，`false` 代表無，`null` 表示不變。
`left`	`Boolean`	`true` 代錶框線，`false` 代表無，`null` 表示不變。
`bottom`	`Boolean`	`true` 代錶框線，`false` 代表無，`null` 表示不變。
`right`	`Boolean`	`true` 代錶框線，`false` 代表無，`null` 表示不變。
`vertical`	`Boolean`	`true` 代表內部垂直框線，`false` 代表無，`null` 表示不變。
`horizontal`	`Boolean`	`true` 代表內部水平框線，`false` 代表無，`null` 表示不變。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`

設定顏色和/或樣式的邊框屬性。有效值為 true (開啟)、false (關閉) 和 null (無變更)。如為顏色，請使用 CSS 標記法中的「顏色」(例如 '#ffffff' 或 'white')。

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

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(true, null, true, null, false, false, "red", SpreadsheetApp.BorderStyle.DASHED);

參數

名稱	類型	說明
`top`	`Boolean`	`true` 代錶框線，`false` 代表無，`null` 表示不變。
`left`	`Boolean`	`true` 代錶框線，`false` 代表無，`null` 表示不變。
`bottom`	`Boolean`	`true` 代錶框線，`false` 代表無，`null` 表示不變。
`right`	`Boolean`	`true` 代錶框線，`false` 代表無，`null` 表示不變。
`vertical`	`Boolean`	`true` 代表內部垂直框線，`false` 代表無，`null` 表示不變。
`horizontal`	`Boolean`	`true` 代表內部水平框線，`false` 代表無，`null` 表示不變。
`color`	`String`	CSS 標記法的顏色 (例如 `'#ffffff'` 或 `'white'`)，預設顏色為 `null`。
`style`	`BorderStyle`	框線的樣式，`null` 代表預設樣式 (實線)。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setDataValidation(rule)`

為範圍中的所有儲存格設定一項資料驗證規則。

// Set the data validation rule for cell A1 to require a value from B1:B10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

參數

名稱	類型	說明
`rule`	`DataValidation`	要設定的資料驗證規則，或是 `null` 移除資料驗證。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setDataValidations(rules)`

為範圍內的所有儲存格設定資料驗證規則。這種方法資料驗證陣列，先依列再依欄建立索引。陣列尺寸必須對應和範圍維度

// Set the data validation rules for Sheet1!A1:B5 to require a value from Sheet2!A1:A10.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

參數

名稱	類型	說明
`rules`	`DataValidation[][]`	要設定的資料驗證規則 2D 陣列；`null` 個值移除資料驗證。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontColor(color)`

設定 CSS 標記法中的字型顏色 (例如 '#ffffff' 或 'white')。

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

var cell = sheet.getRange("B2");
cell.setFontColor("red");

參數

名稱	類型	說明
`color`	`String`	CSS 標記法中的字型顏色 (例如 `'#ffffff'` 或 `'white'`)；換 `null` 值會重設顏色。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontColorObject(color)`

設定指定範圍的字型顏色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();

var cell = sheet.getRange("B2");
cell.setFontColor(color);

參數

名稱	類型	說明
`color`	`Color`	要設定的字型顏色；`null` 值會重設顏色。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontColorObjects(colors)`

設定字型顏色的矩形格線 (必須與此範圍的尺寸相符)。

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

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setFontColorObjects(colors);

參數

名稱	類型	說明
`colors`	`Color[][]`	使用 2D 色彩陣列；`null` 值會重設字型顏色。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontColors(colors)`

設定字型顏色的矩形格線 (必須與此範圍的尺寸相符)。顏色在 CSS 標記法 (例如 '#ffffff' 或 'white')。

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

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setFontColors(colors);

參數

名稱	類型	說明
`colors`	`Object[][]`	CSS 標記法中的 2D 顏色陣列 (例如 `'#ffffff'` 或 `'white'`);`null` 值會重設顏色。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontFamilies(fontFamilies)`

設定字型系列的矩形格線 (必須與此範圍的尺寸相符)。優先放送示例字型系列為「myactivity」或「Helvetica」

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

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

var cell = sheet.getRange("B2:D3");
cell.setFontFamilies(fonts);

參數

名稱	類型	說明
`fontFamilies`	`Object[][]`	字型系列的 2D 陣列；`null` 值會重設以及字型系列

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontFamily(fontFamily)`

設定字型系列，例如「myactivity」或「Helvetica」

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

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

參數

名稱	類型	說明
`fontFamily`	`String`	要設定的字型系列；`null` 值會重設字型系列。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontLine(fontLine)`

設定指定範圍 ('underline'、'line-through' 或 'none')。

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

var cell = sheet.getRange("B2");
cell.setFontLine("line-through");

參數

名稱	類型	說明
`fontLine`	`String`	字型行樣式，可以是 `'underline'`、`'line-through'` 或 `'none'`；`null` 值會重設字型行樣式。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontLines(fontLines)`

設定線條樣式的矩形格線 (必須與此範圍的尺寸相符)。

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

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

var range = sheet.getRange("B2:D2");
range.setFontLines(fontLines);

參數

名稱	類型	說明
`fontLines`	`Object[][]`	由 2D 字型線樣式組成的二維陣列 (`'underline'`、`'line-through'` 或 `'none'`)；`null` 值會重設字型行樣式。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontSize(size)`

設定字型大小，並將大小設為要使用的點大小。

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

var cell = sheet.getRange("B2");
cell.setFontSize(20);

參數

名稱	類型	說明
`size`	`Integer`	以點大小顯示的字型大小。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontSizes(sizes)`

設定字型大小的矩形格線 (必須與此範圍的尺寸相符)。大小有點。

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

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

參數

名稱	類型	說明
`sizes`	`Object[][]`	尺寸的二維陣列。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontStyle(fontStyle)`

設定指定範圍 ('italic' 或 'normal') 的字型樣式。

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

var cell = sheet.getRange("B2");
cell.setFontStyle("italic");

參數

名稱	類型	說明
`fontStyle`	`String`	字型樣式：`'italic'` 或 `'normal'`；1 個`null` 值會重設字型樣式。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontStyles(fontStyles)`

設定字型樣式的矩形格線 (必須與此範圍的尺寸相符)。

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

var range = sheet.getRange("B2:C2");
range.setFontStyles(fontStyles);

參數

名稱	類型	說明
`fontStyles`	`Object[][]`	字型樣式的 2D 陣列，可以是 `'italic'` 或 `'normal'`。`null` 值會重設字型樣式。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontWeight(fontWeight)`

設定指定範圍的字型粗細 (一般/粗體)。

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

var cell = sheet.getRange("B2");
cell.setFontWeight("bold");

參數

名稱	類型	說明
`fontWeight`	`String`	字型粗細，為 `'bold'` 或 `'normal'`；1 個`null` 值會重設字型粗細。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFontWeights(fontWeights)`

設定字型粗細的矩形格線 (必須與此範圍的尺寸相符)。範例字型粗細為「粗體」。

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

參數

名稱	類型	說明
`fontWeights`	`Object[][]`	字型粗細的 2D 陣列，可以是 `'bold'` 或 `'normal'`。`null` 值會重設字型粗細。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFormula(formula)`

更新這個範圍的公式。指定的公式必須採用 A1 標記法。

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

var cell = sheet.getRange("B5");
cell.setFormula("=SUM(B3:B4)");

參數

名稱	類型	說明
`formula`	`String`	字串，代表要為儲存格設定的公式。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFormulaR1C1(formula)`

更新這個範圍的公式。指定的公式必須採用 R1C1 標記法。

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

var cell = sheet.getRange("B5");
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");

參數

名稱	類型	說明
`formula`	`String`	字串公式。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFormulas(formulas)`

設定公式的矩形格線 (必須與這個範圍的尺寸相符)。提供的公式都必須採用 A1 標記法這個方法會使用二維公式陣列，由列、索引然後依據資料欄陣列維度必須與範圍維度對應。

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

// This sets the formulas to be a row of sums, followed by a row of averages right below.
// The size of the two-dimensional array must match the size of the range.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var cell = sheet.getRange("B5:D6");
cell.setFormulas(formulas);

參數

名稱	類型	說明
`formulas`	`String[][]`	公式的二維字串陣列，

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setFormulasR1C1(formulas)`

設定公式的矩形格線 (必須與這個範圍的尺寸相符)。提供的公式應採用 R1C1 標記法

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

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

var cell = sheet.getRange("B5:D6");
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

參數

名稱	類型	說明
`formulas`	`String[][]`	R1C1 格式的二維公式陣列。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setHorizontalAlignment(alignment)`

設定指定範圍的水平 (從左到右) 對齊 (左/中/右)。

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

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

參數

名稱	類型	說明
`alignment`	`String`	對齊，可為 `'left'`、`'center'` 或 `'normal'`；換 `null` 值會重設對齊。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setHorizontalAlignments(alignments)`

設定水平對齊的矩形格線。查看 setHorizontalAlignment(alignment)

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

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

var range = sheet.getRange("B2:D2");
range.setHorizontalAlignments(horizontalAlignments);

參數

名稱	類型	說明
`alignments`	`Object[][]`	對齊的二維陣列，可以是 `'left'`、`'center'` 或 `'normal'`。`null` 值會重設對齊。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

另請參閱

setHorizontalAlignment(alignment)

`setNote(note)`

將記事設為指定值。

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

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

參數

名稱	類型	說明
`note`	`String`	用來為範圍設定的附註值；`null` 值會移除記事。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setNotes(notes)`

設定附註的矩形格線 (必須與這個範圍的尺寸相符)。

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

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

參數

名稱	類型	說明
`notes`	`Object[][]`	2D 附註陣列；`null` 值會移除記事。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

另請參閱

setNote(note)

`setNumberFormat(numberFormat)`

將數字或日期格式設為指定的格式字串。系統接受的格式格式為一文中所述的 Sheets API 說明文件。

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

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

參數

名稱	類型	說明
`numberFormat`	`String`	數字格式字串，

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setNumberFormats(numberFormats)`

設定矩形數字或日期格式的矩形網格 (必須與此範圍的尺寸相符)。值是格式模式字串，如 Sheets API 說明文件。

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

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var range = sheet.getRange("B2:D2");
range.setNumberFormats(formats);

參數

名稱	類型	說明
`numberFormats`	`Object[][]`	數字格式的二維陣列。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setRichTextValue(value)`

設定範圍中儲存格的 RTF 格式值。

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

參數

名稱	類型	說明
`value`	`RichTextValue`	所需的 RTF 格式值。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setRichTextValues(values)`

設定 RTF 格式的矩形格線。

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var richTextA2 = SpreadsheetApp.newRichTextValue()
    .setText("bold words, italic words")
    .setTextStyle(0, 11, bold)
    .setTextStyle(12, 24, italic)
    .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

參數

名稱	類型	說明
`values`	`RichTextValue[][]`	所需的 RTF 格式值。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setShowHyperlink(showHyperlink)`

設定範圍是否應顯示超連結。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can useSpreadsheetApp.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 cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

參數

名稱	類型	說明
`showHyperlink`	`Boolean`	是否顯示超連結。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setTextDirection(direction)`

設定範圍中儲存格的文字方向。如果指定方向為 null，然後推斷方向並接著設定

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

參數

名稱	類型	說明
`direction`	`TextDirection`	所需的文字方向：如果 `null` 是在前推算方向，以及環境敘述

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setTextDirections(directions)`

設定文字方向的矩形格線。如果指定的方向為 null，然後加以設定

// Copies all of the text directions from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

參數

名稱	類型	說明
`directions`	`TextDirection[][]`	所需的文字方向：如果指定的方向為 `null`，則會是會在設定前推論

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setTextRotation(degrees)`

設定範圍中儲存格的文字旋轉設定。輸入內容會對應至特定角度標準文字方向與所需方向之間切換如果輸入零，將文字設為標準方向

如果文字方向是由左至右，正角度會按逆時針方向呈現而在從右到左，則會按順時針方向呈現。

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setTextRotation(45);

參數

名稱	類型	說明
`degrees`	`Integer`	標準方向與所需螢幕方向之間的所需角度。在從左到右的文字中，正角度會按逆時針方向呈現。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setTextRotation(rotation)`

設定範圍中儲存格的文字旋轉設定。

// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

參數

名稱	類型	說明
`rotation`	`TextRotation`	所需的文字旋轉設定。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setTextRotations(rotations)`

設定文字旋轉的矩形格線。

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

參數

名稱	類型	說明
`rotations`	`TextRotation[][]`	所需的文字旋轉設定。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setTextStyle(style)`

設定範圍中儲存格的文字樣式。

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

參數

名稱	類型	說明
`style`	`TextStyle`	所需的文字樣式。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setTextStyles(styles)`

設定文字樣式的矩形格線。

// Sets text styles for cells in range A1:B2
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var otherStyle = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .setUnderline(true)
    .setItalic(true)
    .setForegroundColor("#335522")
    .setFontSize(44)
    .build();
range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);

參數

名稱	類型	說明
`styles`	`TextStyle[][]`	所需的文字樣式。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setValue(value)`

設定範圍的值。這個值可以是數字、字串、布林值或日期。如果廣告開始但 '=' 會解讀為公式。

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

var cell = sheet.getRange("B2");
cell.setValue(100);

參數

名稱	類型	說明
`value`	`Object`	範圍的值。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setValues(values)`

設定矩形值的矩形網格 (必須與此範圍的尺寸相符)。如果值的開頭是 =，系統會將其解讀為公式。

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

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

參數

名稱	類型	說明
`values`	`Object[][]`	值的二維陣列。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setVerticalAlignment(alignment)`

設定指定範圍 (頂端/中間/底部) 的垂直 (由上至下) 對齊。

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

var cell = sheet.getRange("B2");
cell.setVerticalAlignment("middle");

參數

名稱	類型	說明
`alignment`	`String`	對齊，可為 `'top'`、`'middle'` 或 `'bottom'`；換 `null` 值會重設對齊。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setVerticalAlignments(alignments)`

設定垂直對齊的矩形格線 (必須與此範圍的尺寸相符)。

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

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var range = sheet.getRange("B2:D2");
range.setVerticalAlignments(alignments);

參數

名稱	類型	說明
`alignments`	`Object[][]`	對齊的 2D 陣列，可以是 `'top'`、`'middle'` 或 `'bottom'`；`null` 值會重設對齊。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

另請參閱

setVerticalAlignment(alignment)

`setVerticalText(isVertical)`

設定是否要堆疊範圍中的儲存格文字。如果文字堆疊顯示垂直方向會忽略文字旋轉設定。

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

參數

名稱	類型	說明
`isVertical`	`Boolean`	是否堆疊文字。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setWrap(isWrapEnabled)`

設定指定範圍的儲存格換行。

啟用換行功能的儲存格 (預設值) 會調整大小以顯示完整內容。包含換行的儲存格停用可盡可能讓儲存格顯示在畫面上，但不會調整大小或分成多行。

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

var cell = sheet.getRange("B2");
cell.setWrap(true);

參數

名稱	類型	說明
`isWrapEnabled`	`Boolean`	是否自動換行。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setWrapStrategies(strategies)`

設定環繞策略的矩形格線。

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

參數

名稱	類型	說明
`strategies`	`WrapStrategy[][]`	所需的包裝策略。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setWrapStrategy(strategy)`

為範圍中的儲存格設定文字換行策略。

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

參數

名稱	類型	說明
`strategy`	`WrapStrategy`	想要的包裝策略。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`setWraps(isWrapEnabled)`

設定文字換行政策的矩形格線 (必須與此範圍的尺寸相符)。儲存格含有以下值：採用自動換行功能 (預設) 調整大小，以顯示完整內容。已停用換行功能的儲存格盡可能在儲存格中以最大度顯示，而不調整大小或分成多行顯示。

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

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

參數

名稱	類型	說明
`isWrapEnabled`	`Object[][]`	用於判斷是否要換行的 2D 包裝變數陣列而非儲存格中的文字

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

另請參閱

setWrap(isWrapEnabled)

`shiftColumnGroupDepth(delta)`

依指定幅度變更範圍的欄分組深度。

這有助於建立、修改或刪除與範圍。如果是正差異，則是建立和/或修改群組。對負差異遷移而言，群組是已刪除和/或修改。

當群組深度低於 0 或 8 以上時，不會有任何影響。

如果 column group control position 是 BEFORE，這會在嘗試將物件移位時擲回錯誤第一列的深度

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

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

參數

名稱	類型	說明
`delta`	`Integer`	指定這個範圍的資料欄群組深度時，應變更多少金額。

回攻員

Range：這個範圍用於鏈結。

擲回

Error：嘗試轉移第一欄的深度時控制項位置為 GroupControlTogglePosition.BEFORE

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`shiftRowGroupDepth(delta)`

依據指定的金額變更範圍的列群組深度。

這有助於建立、修改或刪除與範圍。如果是正差異，則是建立和/或修改群組。對負差異遷移而言，群組是已刪除和/或修改。

當群組深度低於 0 或 8 以上時，不會有任何影響。

如果 row group control position 為 BEFORE，這會在嘗試將第一列的深度

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

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

參數

名稱	類型	說明
`delta`	`Integer`	變更這個範圍的資料列群組深度時要變更的金額。

回攻員

Range：這個範圍用於鏈結。

擲回

Error：嘗試在控制項時調整第一列的深度時位置為 GroupControlTogglePosition.BEFORE

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`sort(sortSpecObj)`

依指定欄和順序排序指定範圍內的儲存格。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more readable
// code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);

參數

名稱	類型	說明
`sortSpecObj`	`Object`	要當做排序依據的資料欄。

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`splitTextToColumns()`

這個外掛程式能根據自動偵測的分隔符號將文字欄分割為多個資料欄。

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`splitTextToColumns(delimiter)`

使用指定的字串做為自訂分隔符號，將文字欄分割為多個資料欄。

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

參數

名稱	類型	說明
`delimiter`	`String`	要分割的自訂分隔符號。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`splitTextToColumns(delimiter)`

這個外掛程式能根據您指定的分隔符號將文字欄分割為多個資料欄。

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

參數

名稱	類型	說明
`delimiter`	`TextToColumnsDelimiter`	要分割的預設分隔符號。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`trimWhitespace()`

移除這個範圍內每個儲存格中的空白字元 (例如空格、Tab 字元或換行字元)。移除每個儲存格文字開頭和結尾的所有空白字元，並減少之間的空格。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`uncheck()`

將範圍內核取方塊的狀態變更為「未勾選」。忽略範圍中的儲存格但目前不包含已設定的勾選或未勾選值。

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'unchecked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

回攻員

Range：這個範圍用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

已淘汰的方法

`getFontColor()`

已淘汰。替換為 getFontColorObject()

以 CSS 標記法傳回儲存格在範圍左上角的字型顏色 (例如如 '#ffffff' 或 'white')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontColor());

回攻員

String：採用 CSS 標記法的字型顏色 (例如 '#ffffff' 或 'white')。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getFontColors()`

已淘汰。替換為 getFontColorObjects()

傳回 CSS 標記法範圍內的儲存格字型顏色 (例如 '#ffffff' 或 'white')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColors();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

回攻員

String[][]：與範圍中的儲存格相關聯的 2D 字型顏色陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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