Class Range

範囲

スプレッドシートの範囲にアクセスして変更できます。範囲には、シート内の単一のセルまたはシート内の隣接するセルのグループを指定できます。

Methods

メソッド	戻り値の型	概要
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	4 つのカーディナル Direction に展開された範囲のコピーを返し、データに隣接するすべてのセルをカバーします。
getDataRegion(dimension)	Range	指定されたディメンションが Dimension.ROWS の場合は拡張された Direction.UP と Direction.DOWN のコピー、ディメンションが Dimension.COLUMNS の場合は Direction.NEXT と Direction.PREVIOUS を返します。
getDataSourceFormula()	DataSourceFormula	範囲内の最初のセルの場合は DataSourceFormula を返し、セルにデータソースの数式が含まれていない場合は null を返します。
getDataSourceFormulas()	DataSourceFormula[]	範囲内のセルの DataSourceFormula を返します。
getDataSourcePivotTables()	DataSourcePivotTable[]	範囲と交差するすべてのデータソースのピボット テーブルを取得します。
getDataSourceTables()	DataSourceTable[]	範囲と交差するすべてのデータソース テーブルを取得します。
getDataSourceUrl()	String	この範囲のデータの URL を返します。この URL を使用して、グラフやクエリを作成できます。
getDataTable()	DataTable	このオブジェクト内のデータを DataTable として返します。
getDataTable(firstRowIsHeader)	DataTable	この範囲内のデータを 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[]	現在のセルに完全に収まっている、または現在の範囲内に少なくとも 1 つのセルが含まれているマージセルを表す Range オブジェクトの配列を返します。
getNextDataCell(direction)	Range	範囲の最初の列と行のセルから開始して、指定された方向の次のセルを返します。これは、データのある連続するセル範囲のエッジか、スプレッドシートのその方向にあるセルのセルです。
getNote()	String	指定された範囲に関連付けられているメモを返します。
getNotes()	String[][]	範囲内のセルに関連付けられているメモを返します。
getNumColumns()	Integer	この範囲内の列数を返します。
getNumRows()	Integer	この範囲の行数を返します。
getNumberFormat()	String	指定された範囲内の左上のセルの数値または日付の形式を取得します。
getNumberFormats()	String[][]	範囲内のセルの数値または日付の形式を返します。
getRichTextValue()	RichTextValue	範囲の左上セルについてリッチテキスト値を返します。セル値がテキストでない場合は null を返します。
getRichTextValues()	RichTextValue[][]	範囲内のセルのリッチテキスト値を返します。
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	範囲内のセルを 1 つのブロックにマージします。
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	範囲内のすべてのセルに 1 つのデータ検証ルールを設定します。
setDataValidations(rules)	Range	範囲内のすべてのセルのデータ検証ルールを設定します。
setFontColor(color)	Range	フォントの色を CSS 表記（'#ffffff'、'white' など）で設定します。
setFontColorObject(color)	Range	指定された範囲のフォントの色を設定します。
setFontColorObjects(colors)	Range	フォントの色の長方形グリッドを設定します（この範囲のサイズと一致する必要があります）。
setFontColors(colors)	Range	フォントの色の長方形グリッドを設定します（この範囲のサイズと一致する必要があります）。
setFontFamilies(fontFamilies)	Range	フォント ファミリーの長方形グリッドを設定します（この範囲のサイズと一致する必要があります）。
setFontFamily(fontFamily)	Range	フォント ファミリー（「Arial」や「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	範囲内のセルのリッチテキスト値を設定します。
setRichTextValues(values)	Range	リッチテキスト値の長方形グリッドを設定します。
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	この範囲内のすべてのセルの空白（スペース、タブ、改行など）を削除します。
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 は 1 つのセルで構成する必要があります。そうでない場合は例外がスローされます。

// 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
key	String	新しいデベロッパー メタデータのキー。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
key	String	新しいデベロッパー メタデータのキー。
visibility	DeveloperMetadataVisibility	新しいデベロッパー メタデータの公開設定。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 on the sheet.
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());

パラメータ

Name	型	説明
key	String	新しいデベロッパー メタデータのキー。
value	String	新しいデベロッパー メタデータの値。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
key	String	新しいデベロッパー メタデータのキー。
value	String	新しいデベロッパー メタデータの値。
visibility	DeveloperMetadataVisibility	新しいデベロッパー メタデータの公開設定。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 新しいバンディング。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
bandingTheme	BandingTheme	範囲内の列に適用する色のテーマ。

復路

Banding - 新しいバンディング。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
bandingTheme	BandingTheme	範囲内の列に適用する色のテーマ。
showHeader	Boolean	true の場合、バンディング テーマのヘッダーの色は最初の列に適用されます。
showFooter	Boolean	true の場合、バンディング テーマのフッターの色は最後の列に適用されます。

復路

Banding - 新しいバンディング。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

applyRowBanding()

デフォルトの行縞テーマを範囲に適用します。デフォルトでは、バンディングにはヘッダーがあり、フッターの色は表示されません。

復路

Banding - 新しいバンディング。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

applyRowBanding(bandingTheme)

指定した行縞のテーマを範囲に適用します。デフォルトでは、バンディングにはヘッダーがあり、フッターの色は表示されません。

パラメータ

Name	型	説明
bandingTheme	BandingTheme	範囲内の行に適用するカラーテーマ。

復路

Banding - 新しいバンディング。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

applyRowBanding(bandingTheme, showHeader, showFooter)

ヘッダーとフッターの設定が指定された範囲に、指定した行の縞模様を適用します。

パラメータ

Name	型	説明
bandingTheme	BandingTheme	範囲内の行に適用するカラーテーマ。
showHeader	Boolean	true の場合、バンディング テーマのヘッダーの色は 1 行目に適用されます。
showFooter	Boolean	true の場合、バンディング テーマのフッターの色は最後の行に適用されます。

復路

Banding - 新しいバンディング。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

autoFill(destination, series)

destinationRange に、この範囲内のデータに基づいてデータを入力します。新しい値は、指定された series タイプによっても決まります。宛先の範囲には、この範囲が含まれ、一方向にのみ拡張する必要があります。たとえば、以下の例では、A1:A4 の現在の値に基づいて、一連の増加する数値を A1:A20 に入力します。

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

パラメータ

Name	型	説明
destination	Range	値が自動的に入力される範囲です。宛先の範囲には、この範囲を 1 方向（上、下、左、右）に広げてください。
series	AutoFillSeries	新しい値の計算に使用する自動入力の系列のタイプ。この系列の効果は、ソースデータの種類と量によって異なります。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

autoFillToNeighbor(series)

隣接するセルに基づいて新しいデータを入力する範囲を計算し、この範囲に含まれるデータに基づいて新しい範囲を自動的に設定します。これらの新しい値は、指定された series タイプによっても決まります。

計算されたデスティネーションの範囲では、周囲の値に基づいて新しい値が挿入される領域が決定されます。自動入力される列のすぐ左または右にデータがある場合、新しい値はこの隣接するデータの範囲まで拡張されます。

たとえば、A1:A20 に一連の増加した数値があり、このメソッドが一連の日付を含む B1:B4 の範囲で呼び出された場合、新しい値は B5:B20 にのみ挿入されます。このように、これらの新しい値は、列 A の値を含むセルに「固定」されます。

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

パラメータ

Name	型	説明
series	AutoFillSeries	新しい値の計算に使用する自動入力の系列のタイプ。この系列の効果は、ソースデータの種類と量によって異なります。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

breakApart()

範囲内の複数列のセルをもう一度個別のセルに分割します。

特定の範囲に対してこの関数を呼び出すことは、範囲を選択して、[表示形式] -> [結合] -> [結合を解除] をクリックするのと同じです。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

canEdit()

ユーザーに範囲内のすべてのセルを編集する権限があるかどうかを判断します。スプレッドシートのオーナーは、保護された範囲とシートをいつでも編集できます。

復路

Boolean - ユーザーが範囲内のすべてのセルを編集する権限を持っている場合は true、そうでない場合は false。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

clear(options)

指定された詳細オプションで指定されているコンテンツ、形式、データ検証ルール、コメントの範囲をクリアします。デフォルトでは、すべてのデータが消去されます。

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

パラメータ

Name	型	説明
options	Object	下記の詳細なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

Name	型	説明
commentsOnly	Boolean	コメントのみクリアするかどうか。
contentsOnly	Boolean	内容のみを消去するかどうか。
formatOnly	Boolean	形式のみクリアするかどうか。フォーマットをクリアすると、データ検証ルールもクリアされます。
validationsOnly	Boolean	データの入力規則のみクリアするかどうか。
skipFilteredRows	Boolean	除外された行のクリアを回避するかどうか。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

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

範囲の書式を指定の場所にコピーします。宛先がソース範囲より大きいか小さい場合、ソースは繰り返しられるか、切り捨てられます。この方法では、書式のみがコピーされます。

gridId パラメータの詳細については、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);

パラメータ

Name	型	説明
gridId	Integer	位置に関係なく、スプレッドシート内のシートの一意の ID。
column	Integer	ターゲット範囲の最初の列。
columnEnd	Integer	ターゲット範囲の終了列。
row	Integer	ターゲット範囲の開始行。
rowEnd	Integer	ターゲット範囲の終了行。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
sheet	Sheet	ターゲット シート。
column	Integer	ターゲット範囲の最初の列。
columnEnd	Integer	ターゲット範囲の終了列。
row	Integer	ターゲット範囲の開始行。
rowEnd	Integer	ターゲット範囲の終了行。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
destination	Range	コピー先のデスティネーションの範囲（左上のセル位置のみに関連）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
destination	Range	コピー先のデスティネーションの範囲（左上のセル位置のみに関連）。
copyPasteType	CopyPasteType	範囲のコンテンツをデスティネーションにどのように貼り付けるかを指定するタイプ。
transposed	Boolean	範囲を横方向に貼り付けて貼り付けるかどうかを指定します。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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});

パラメータ

Name	型	説明
destination	Range	コピー先のデスティネーションの範囲（左上のセル位置のみに関連）。
options	Object	下記の詳細なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

Name	型	説明
formatOnly	Boolean	フォーマットのみをコピーするように指定します。
contentsOnly	Boolean	コンテンツのみをコピーするように指定します。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

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

範囲内のコンテンツを指定された場所にコピーします。宛先がソース範囲より大きいか小さい場合、ソースは繰り返しられるか、切り捨てられます。

gridId パラメータの詳細については、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);

パラメータ

Name	型	説明
gridId	Integer	位置に関係なく、スプレッドシート内のシートの一意の ID。
column	Integer	ターゲット範囲の最初の列。
columnEnd	Integer	ターゲット範囲の終了列。
row	Integer	ターゲット範囲の開始行。
rowEnd	Integer	ターゲット範囲の終了行。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
sheet	Sheet	ターゲット シート。
column	Integer	ターゲット範囲の最初の列。
columnEnd	Integer	ターゲット範囲の終了列。
row	Integer	ターゲット範囲の開始行。
rowEnd	Integer	ターゲット範囲の終了行。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
dataSource	DataSource	ピボット テーブルの作成元となるデータソース。

復路

DataSourcePivotTable - 新しく作成されたデータソースのピボット テーブル。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
dataSource	DataSource	ピボット テーブルの作成元となるデータソース。

復路

DataSourceTable - 新しく作成されたデータソース テーブル。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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()

フィルタを作成し、シート上の指定された範囲に適用します。1 つのシートに複数のフィルタを作成することはできません。作成後にフィルタにアクセスして変更するには、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 - 新しいフィルタ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
sourceData	Range	ピボット テーブルの作成元となるデータ。

復路

PivotTable - 新しく作成された PivotTable。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 = findOccurrence.replaceWith('cat');

パラメータ

Name	型	説明
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);

パラメータ

Name	型	説明
shiftDimension	Dimension	既存のデータを移動するためのディメンション。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

expandGroups()

範囲またはコントロールの切り替えがこの範囲と交差する折りたたみグループを開きます。コントロールの切り替え場所は、設定に応じて、グループのすぐ前か後かにあるコントロールの切り替えが表示されるインデックスです。同じロケーションに複数のグループがある場合、shellowest グループは拡張されます。

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

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

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 表記）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 背景の色コード。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲内の左上のセルの背景色。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 背景色の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 背景の色コードの 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[] - この範囲内のセルに適用されるすべての縞。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
row	Integer	範囲を基準とするセルの行。
column	Integer	範囲を基準とするセルの列。

復路

Range - 指定された座標に単一のセルを含む範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - スプレッドシート内の範囲の開始列位置。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDataRegion()

4 つのカーディナル 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 - 範囲のデータ リージョンまたはスプレッドシート全体の範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDataRegion(dimension)

指定されたディメンションが Dimension.ROWS の場合は拡張された Direction.UP と Direction.DOWN のコピー、ディメンションが Dimension.COLUMNS の場合は Direction.NEXT と Direction.PREVIOUS を返します。範囲の拡大は、テーブルのように編成された範囲の横にあるデータの検出に基づいています。範囲を拡大すると、テーブルの境界線など、指定したディメンションに沿ってデータが隣接するすべてのセルがカバーされます。元の範囲が指定したディメンションに沿って空のセルで囲まれている場合は、範囲自体が返されます。この方法は、範囲を選択し、エディタで列の場合は「 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());

パラメータ

Name	型	説明
dimension	Dimension	範囲を拡張するディメンション。

復路

Range - 範囲のデータ リージョンまたは範囲。これは、元の範囲を含む各列または各行をカバーします。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDataSourceFormula()

範囲内の最初のセルの場合は DataSourceFormula を返し、セルにデータソースの数式が含まれていない場合は null を返します。

復路

DataSourceFormula - セルの DataSourceFormula。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDataSourceFormulas()

範囲内のセルの DataSourceFormula を返します。

復路

DataSourceFormula[] - DataSourceFormula の配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDataSourcePivotTables()

範囲と交差するすべてのデータソースのピボット テーブルを取得します。

復路

DataSourcePivotTable[] - データソースのピボット テーブルのリストです。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDataSourceTables()

範囲と交差するすべてのデータソース テーブルを取得します。

復路

DataSourceTable[] - データソース テーブルのリスト。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDataSourceUrl()

この範囲内のデータの URL を返します。この URL を使用してグラフやクエリを作成できます。

コード.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 に渡すことができます。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDataTable()

このオブジェクト内のデータを DataTable として返します。

復路

DataTable - データテーブルとしてのデータ。

---

getDataTable(firstRowIsHeader)

この範囲内のデータを DataTable として返します。

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

パラメータ

Name	型	説明
firstRowIsHeader	Boolean	最初の行をヘッダーとして扱うかどうか。

復路

DataTable - データテーブルとしてのデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲内の左上のセルのデータ検証ルール。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられているデータ検証ルールの 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDeveloperMetadata()

この範囲に関連付けられているデベロッパー メタデータを取得します。

復路

DeveloperMetadata[] - この範囲に関連付けられたデベロッパー メタデータ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDisplayValue()

範囲内の左上のセルの表示値を返します。値は String です。表示される値では、日付、時刻、通貨の形式設定（スプレッドシートの言語 / 地域設定によって自動的に適用される形式など）が考慮されます。空のセルは空の文字列を返します。

復路

String - このセルに表示される値。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getDisplayValues()

この範囲の値の長方形グリッドを返します。

表示された値の 2 次元配列を、行、列の順にインデックスを付けて返します。値は 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[][] - 2 次元値の配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - フィルタ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲内の左上のセルのフォントの色。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたフォント色の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたフォント ファミリーの 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - セルのフォント ファミリー。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - フォント行。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたフォント行の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - ポイントサイズのフォントサイズ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたテキストのフォントサイズの 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - セル内のテキストのフォント スタイル。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたテキストのフォント スタイルの 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - セル内のテキストのフォントの太さ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたテキストのフォントの太さの 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - セルの数式です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 表記の式。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 文字列形式の数式の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 表記による数式の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲の高さ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - セル内のテキストの水平方向の配置。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられているテキストの水平方向の配置の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - スプレッドシート内の範囲の末尾の列の位置。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - スプレッドシート内の範囲の末尾の行位置。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getMergedRanges()

現在の範囲内に完全に存在する、または現在の範囲内に少なくとも 1 つのセルを含む、マージされたセルを表す 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());

パラメータ

Name	型	説明
direction	Direction	次のデータ リージョン エッジセルがある方向

復路

Range - データ領域のエッジセル、またはスプレッドシートのエッジにあるセル。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 指定されたセルに関連付けられているメモ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられた 2 次元配列の配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - この範囲内の列数。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - この範囲の行数。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲の左上のセルの数値形式。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getNumberFormats()

範囲内のセルの数値または日付の形式を返します。返される形式パターンについては、スプレッドシート 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[][] - 数値形式の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getRichTextValue()

範囲内の左上のセルについてリッチテキスト値を返します。セル値がテキストでない場合は 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 - 範囲内の左上のセルのリッチテキスト値。セル値がテキストでない場合は null。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getRichTextValues()

範囲内のセルのリッチテキスト値を返します。

// 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[][] - リッチテキスト値の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲の行の位置。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲の行の位置。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

関連ドキュメント

• getRow()

---

getSheet()

この範囲が属するシートを返します。

復路

Sheet - この範囲が属するシート。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getTextDirection()

範囲の左上セルのテキスト方向を返します。セルテキストの方向が自動検出によって決定された場合は、null を返します。

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

復路

TextDirection - 範囲内の左上のセルのテキスト方向。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - テキスト方向の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - テキストの回転の設定。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたテキスト回転の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲内の左上のセルのテキスト スタイル。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - テキスト スタイルの 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getValue()

範囲内の左上のセルの値を返します。値は、セルの値に応じて、Number、Boolean、Date、String のいずれかになります。空のセルは空の文字列を返します。

復路

Object - このセルの値。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getValues()

この範囲の値の長方形グリッドを返します。

行、列の順にインデックスが付けられた 2 次元配列を返します。セルの値に応じて、値は 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[][] - 2 次元値の配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - セル内のテキストの垂直方向の配置。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたテキストの垂直方向の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

getWidth()

範囲の幅を列で返します。

復路

Integer - 範囲内の列数。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - このセルのテキストが折り返すかどうか。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - テキストの折り返し戦略の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 範囲内の左上のセルのテキストの折り返し戦略。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたテキストの垂直方向の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
shiftDimension	Dimension	既存のデータを移動するためのディメンション。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
checkedValue	Object	チェックボックスのデータ検証でチェックされた値。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
checkedValue	Object	チェックボックスのデータ検証でチェックされた値。
uncheckedValue	Object	チェックボックスのデータ検証で、オフになっています。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

isEndColumnBounded()

範囲の終わりが特定の列にバインドされるかどうかを指定します。たとえば、範囲の最後の列にバインドされる範囲 A1:B10 または B:B の場合、このメソッドは true を返します。範囲の最後の特定の行のみにバインドされた範囲 3:7 または A1:5 の場合、このメソッドは false を返します。

復路

Boolean - 範囲の終わりが特定の列にバインドされている場合は true、それ以外の場合は false。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

isEndRowBounded()

範囲の末尾が特定の行にバインドされているかどうかを判断します。たとえば、範囲の最後の行にバインドされている A1:B10 または 3:7 の範囲の場合、このメソッドは true を返します。範囲の最後の特定の列にのみバインドされる B:B または A1:C の場合、このメソッドは false を返します。

復路

Boolean - 範囲の終わりが特定の行にバインドされている場合は true、そうでない場合は false。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 の場合、このメソッドは範囲を返します。範囲 3:7 の場合は範囲の先頭の行にのみバインドされ、false を返します。true

復路

Boolean - 範囲の先頭が特定の列にバインドされている場合は true、それ以外の場合は false。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

isStartRowBounded()

範囲の先頭を特定の行にバインドするかどうかを指定します。たとえば、範囲の先頭で行にバインドされている範囲 A1:B10 または 3:7 の場合、このメソッドは true を返します。範囲の先頭の特定の列だけにバインドされた範囲 B:B の場合、このメソッドは false を返します。

復路

Boolean - 範囲の先頭が特定の行にバインドされている場合は true、それ以外の場合は false。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

merge()

範囲内のセルを 1 つのブロックにマージします。

var sheet = SpreadsheetApp.getActiveSheet();

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

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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"));

パラメータ

Name	型	説明
target	Range	この範囲のコピー先となるターゲット範囲。左上のセル位置のみが関連します。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
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);

パラメータ

Name	型	説明
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);

パラメータ

Name	型	説明
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 - 保護設定を表すオブジェクト。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - 重複を除いた結果の範囲。範囲のサイズは、削除された行ごとに 1 行ずつ縮小されます。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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]);

パラメータ

Name	型	説明
columnsToCompare	Integer[]	重複値について分析する列です。列が指定されていない場合、すべての列で重複が分析されます。

復路

Range - 重複を除いた結果の範囲。範囲のサイズは、削除された行ごとに 1 行ずつ縮小されます。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
color	String	CSS 表記のカラーコード（'#ffffff'、'white' など）。null 値により、色がリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
color	Color	設定する背景色。null 値では背景色がリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
color	Color[][]	2 次元の色配列。null 値は色をリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
red	Integer	赤色の値（RGB 表記）。
green	Integer	RGB 表記の緑色の値。
blue	Integer	RGB 表記の青の値。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
color	String[][]	CSS 表記の 2 次元配列（'#ffffff' や 'white' など）。null 値により、色がリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setDataValidation(rule)

範囲内のすべてのセルに 1 つのデータ検証ルールを設定します。

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

パラメータ

Name	型	説明
rule	DataValidation	設定するデータの入力規則、またはデータの検証を削除する null。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setDataValidations(rules)

範囲内のすべてのセルのデータ検証ルールを設定します。このメソッドは、2 次元のデータ検証配列を取り、行、列の順にインデックスを作成します。配列ディメンションは範囲ディメンションに対応している必要があります。

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

パラメータ

Name	型	説明
rules	DataValidation[][]	設定するデータ検証ルールの 2 次元配列。null 値はデータ検証を削除します。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
color	String	CSS 表記のフォントの色（'#ffffff'、'white' など）。null 値により、色がリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
color	Color	設定するフォントの色。null 値により色がリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
colors	Color[][]	2 次元カラー配列。null 値はフォントの色をリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
colors	Object[][]	CSS 表記の 2 次元配列（'#ffffff' や 'white' など）。null 値により、色がリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setFontFamilies(fontFamilies)

フォント ファミリーの長方形グリッドを設定します（この範囲のサイズと一致する必要があります）。フォント ファミリーの例としては、「Arial」や「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);

パラメータ

Name	型	説明
fontFamilies	Object[][]	フォント ファミリーの 2 次元配列。null 値はフォント ファミリーをリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setFontFamily(fontFamily)

フォント ファミリー（「Arial」や「Helvetica」など）を設定します。

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

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

パラメータ

Name	型	説明
fontFamily	String	設定するフォント ファミリーです。null に設定すると、フォント ファミリーがリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
fontLine	String	フォントライン スタイル（'underline'、'line-through'、'none'）。null 値は、フォントライン スタイルをリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
fontLines	Object[][]	フォントライン スタイルの 2 次元配列（'underline'、'line-through'、'none'）。null 値はフォント ライン スタイルをリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
size	Integer	ポイントサイズのフォントサイズ。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
sizes	Object[][]	2 次元のサイズ配列。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
fontStyle	String	フォント スタイル（'italic' または 'normal'）。null 値によってフォント スタイルがリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
fontStyles	Object[][]	フォント スタイルの 2 次元配列（'italic' または 'normal'）。null 値はフォント スタイルをリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
fontWeight	String	フォントの太さ（'bold' または 'normal'）。null 値によってフォントの太さがリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
fontWeights	Object[][]	フォントの太さの 2 次元配列（'bold' または 'normal'）。null 値はフォントの太さをリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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)");

パラメータ

Name	型	説明
formula	String	セルに設定する数式を表す文字列です。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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])");

パラメータ

Name	型	説明
formula	String	文字列数式。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setFormulas(formulas)

数式の長方形グリッドを設定します（この範囲のディメンションと一致する必要があります）。数式は A1 表記にする必要があります。このメソッドは、2 次元の数式配列を、行、列の順にインデックス付けて受け取ります。配列ディメンションは範囲ディメンションに対応している必要があります。

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

パラメータ

Name	型	説明
formulas	String[][]	数式の 2 次元文字列配列。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
formulas	String[][]	R1C1 形式の数式の 2 次元配列。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
alignment	String	位置揃え（'left'、'center'、'normal' のいずれか）。null 値を使用すると、位置揃えがリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
alignments	Object[][]	2 次元アライメントの配列（'left'、'center'、または 'normal'）。null 値はアライメントをリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
note	String	範囲に対して設定するメモ値。null 値を設定するとメモが削除されます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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)

パラメータ

Name	型	説明
notes	Object[][]	メモの 2 次元配列。null 値はメモを削除します。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
numberFormat	String	数値形式の文字列。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
numberFormats	Object[][]	数値形式の 2 次元配列。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setRichTextValue(value)

範囲内のセルのリッチテキスト値を設定します。

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

パラメータ

Name	型	説明
value	RichTextValue	目的のリッチテキスト値。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setRichTextValues(values)

リッチテキスト値の長方形グリッドを設定します。

// 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]]);

パラメータ

Name	型	説明
values	RichTextValue[][]	目的のリッチテキスト値。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setShowHyperlink(showHyperlink)

範囲にハイパーリンクを表示するかどうかを指定します。

パラメータ

Name	型	説明
showHyperlink	Boolean	ハイパーリンクを表示するかどうかを指定します。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
direction	TextDirection	目的のテキスト方向。null の場合、方向は設定前に推測されます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
directions	TextDirection[][]	目的のテキスト方向。指定された方向が null の場合、設定前に推測されます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

setTextRotation(degrees)

範囲内のセルのテキストの回転を設定します。入力は、標準テキストの向きと目的の向きの間の角度に対応します。入力が 0 の場合は、テキストが標準の向きに設定されていることを示します。

左から右へのテキスト方向の場合、正の角度は反時計回りの方向、右から左の方向は時計回りです。

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

パラメータ

Name	型	説明
degrees	Integer	標準の向きと目的の向きの間の目的の角度。 左から右へのテキストの場合、正の角度は反時計回りになります。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
rotation	TextRotation	テキストの回転に関する設定。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
rotations	TextRotation[][]	テキストの回転に関する設定。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
style	TextStyle	目的のテキスト スタイル。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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]]);

パラメータ

Name	型	説明
styles	TextStyle[][]	目的のテキスト スタイル。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
value	Object	範囲の値。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
values	Object[][]	2 次元の値の配列。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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");

パラメータ

Name	型	説明
alignment	String	位置揃え（'top'、'middle'、'bottom' のいずれか）。null 値を使用すると、位置揃えがリセットされます。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
alignments	Object[][]	2 次元アライメントの配列（'top'、'middle'、'bottom' のいずれか）。null 値はアライメントをリセットします。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
isVertical	Boolean	テキストを積み上げるかどうか。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
isWrapEnabled	Boolean	テキストを折り返すかどうか。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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());

パラメータ

Name	型	説明
strategies	WrapStrategy[][]	目的のラップ戦略。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
strategy	WrapStrategy	目的のラッピング戦略。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
isWrapEnabled	Object[][]	セル内のテキストを折り返すかどうかを決定するラップ変数の 2 次元配列。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
delta	Integer	この範囲の列グループ深度を変更する量。

復路

Range - チェーンの範囲。

例外

Error - コントロールの位置が GroupControlTogglePosition.BEFORE のときに、最初の列の深さを移動しようとした場合

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

パラメータ

Name	型	説明
delta	Integer	この範囲の行グループ深度を変更する量。

復路

Range - チェーンの範囲。

例外

Error - 制御位置が GroupControlTogglePosition.BEFORE のときに最初の行の深さを移動しようとした場合

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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}]);

パラメータ

Name	型	説明
sortSpecObj	Object	並べ替える列。

復路

Range - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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            |

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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            |

パラメータ

Name	型	説明
delimiter	String	分割するカスタム区切り文字。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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            |

パラメータ

Name	型	説明
delimiter	TextToColumnsDelimiter	分割するプリセット区切り文字。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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

---

trimWhitespace()

この範囲内のすべてのセルの空白（スペース、タブ、改行など）を削除します。各セルのテキストの先頭と末尾にあるすべての空白を削除し、残りの空白文字のサブシーケンスを 1 つのスペースに分割します。

注: カットされたテキストが「+」または「=」で始まる場合、テキストは文字列値として保持され、数式として解釈されません。

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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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 - チェーンの範囲。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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' など）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

• 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[][] - 範囲内のセルに関連付けられたフォント色の 2 次元配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープで承認が必要です。

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