Class Range

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
範囲

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

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()Range4 つの基数 Direction で展開した範囲のコピーを返します。セル内の隣接するすべてのセルが対象になります。
getDataRegion(dimension)Range指定されたディメンションが Dimension.ROWS の場合は拡張された Direction.UPDirection.DOWN のコピーを返し、ディメンションが Dimension.COLUMNS の場合は Direction.NEXTDirection.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範囲内のすべてのセルのチェックボックス状態が 'checked' であるかどうかを返します。
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)RangeCSS 表記の範囲内のすべてのセルの背景色を設定します('#ffffff''white' など)。
setBackgroundObject(color)Range範囲内のすべてのセルの背景色を設定します。
setBackgroundObjects(color)Range背景色の長方形のグリッドを設定します(この範囲のディメンションと一致させる必要があります)。
setBackgroundRGB(red, green, blue)RangeRGB 値(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「ファミリー」や「エルベット」などのフォント ファミリーを設定します。
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範囲内のチェックボックスの状態を「オフ」に変更します。

詳細なドキュメント

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 つのセルで構成する必要があります。1 セルに収まらないと例外がスローされます。

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

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

戻る

Range - チェーン用の範囲。

認可

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

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

addDeveloperMetadata(key)

指定したキーを持つデベロッパー メタデータを範囲に追加します。

パラメータ

名前説明
keyString新しいデベロッパー メタデータのキー。

戻る

Range - チェーン用の範囲。

認可

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

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

addDeveloperMetadata(key, visibility)

指定キーおよび公開設定を含むデベロッパー メタデータを範囲に追加します。

パラメータ

名前説明
keyString新しいデベロッパー メタデータのキー。
visibilityDeveloperMetadataVisibility新しいデベロッパー メタデータの公開設定。

戻る

Range - チェーン用の範囲。

認可

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

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

addDeveloperMetadata(key, value)

指定したキーと値を含むデベロッパー メタデータを範囲に追加します。

パラメータ

名前説明
keyString新しいデベロッパー メタデータのキー。
valueString新しいデベロッパー メタデータの値。

戻る

Range - チェーン用の範囲。

認可

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

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

addDeveloperMetadata(key, value, visibility)

指定したキー、値、可視性を含むデベロッパー メタデータを範囲に追加します。

パラメータ

名前説明
keyString新しいデベロッパー メタデータのキー。
valueString新しいデベロッパー メタデータの値。
visibilityDeveloperMetadataVisibility新しいデベロッパー メタデータの公開設定。

戻る

Range - チェーン用の範囲。

認可

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

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

applyColumnBanding()

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

戻る

Banding - 新しい縞模様。

認可

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

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

applyColumnBanding(bandingTheme)

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

パラメータ

名前説明
bandingThemeBandingTheme範囲内の列に適用する色のテーマ。

戻る

Banding - 新しい縞模様。

認可

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

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

applyColumnBanding(bandingTheme, showHeader, showFooter)

指定した列バンディング テーマを、指定されたヘッダーとフッターの設定を含む範囲に適用します。

パラメータ

名前説明
bandingThemeBandingTheme範囲内の列に適用する色のテーマ。
showHeaderBooleantrue の場合、バンディング テーマのヘッダーの色が最初の列に適用されます。
showFooterBooleantrue の場合、バンディング テーマのフッターの色は最後の列に適用されます。

戻る

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)

指定した行の縞模様を範囲に適用します。デフォルトでは、縞模様にはヘッダーがあり、フッターの色がありません。

パラメータ

名前説明
bandingThemeBandingTheme範囲内の行に適用する色のテーマ。

戻る

Banding - 新しい縞模様。

認可

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

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

applyRowBanding(bandingTheme, showHeader, showFooter)

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

パラメータ

名前説明
bandingThemeBandingTheme範囲内の行に適用する色のテーマ。
showHeaderBooleantrue の場合、バンディング テーマのヘッダーの色が 1 行目に適用されます。
showFooterBooleantrue の場合、バンディング テーマのフッターの色は最後の行に適用されます。

戻る

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

パラメータ

名前説明
destinationRange値が自動入力される範囲です。宛先の範囲には、この範囲を含み、一方向(上、下、左、右)にのみ拡張できます。
seriesAutoFillSeries新しい値の計算に使用する自動入力シリーズの種類。このシリーズの効果は、ソースデータの種類と量によって異なります。

認可

このメソッドを使用するスクリプトには、次の 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);

パラメータ

名前説明
seriesAutoFillSeries新しい値の計算に使用する自動入力シリーズの種類。このシリーズの効果は、ソースデータの種類と量によって異なります。

認可

このメソッドを使用するスクリプトには、次の 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});

パラメータ

名前説明
optionsObject以下に示すように、高度なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

名前説明
commentsOnlyBooleanコメントのみを削除するかどうか。
contentsOnlyBoolean内容のみを消去するかどうか。
formatOnlyBoolean形式のみをクリアするかどうか。形式をクリアするとデータ検証ルールもクリアされます。
validationsOnlyBooleanデータ検証ルールのみをクリアするかどうか。
skipFilteredRowsBooleanフィルタされた行をクリアしないかどうか。

戻る

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

パラメータ

名前説明
gridIdInteger位置にかかわらず、スプレッドシート内のシートの一意の ID。
columnIntegerターゲット範囲の最初の列。
columnEndIntegerターゲット範囲の終了列。
rowIntegerターゲット範囲の開始行。
rowEndIntegerターゲット範囲の終了行。

認可

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

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

関連ドキュメント


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

パラメータ

名前説明
sheetSheet対象のシート。
columnIntegerターゲット範囲の最初の列。
columnEndIntegerターゲット範囲の終了列。
rowIntegerターゲット範囲の開始行。
rowEndIntegerターゲット範囲の終了行。

認可

このメソッドを使用するスクリプトには、次の 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));

パラメータ

名前説明
destinationRangeコピー先のセル範囲であり、左上のセル位置のみが関連しています。

認可

このメソッドを使用するスクリプトには、次の 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);

パラメータ

名前説明
destinationRangeコピー先のセル範囲であり、左上のセル位置のみが関連しています。
copyPasteTypeCopyPasteType範囲コンテンツを宛先に貼り付ける方法を指定する型。
transposedBoolean範囲を正しい向きで貼り付けるかどうかを指定します。

認可

このメソッドを使用するスクリプトには、次の 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});

パラメータ

名前説明
destinationRangeコピー先のセル範囲であり、左上のセル位置のみが関連しています。
optionsObject以下に示すように、高度なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

名前説明
formatOnlyBoolean形式のみをコピーするよう指定します
contentsOnlyBooleanコンテンツのみをコピーすることを指定

認可

このメソッドを使用するスクリプトには、次の 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);

パラメータ

名前説明
gridIdInteger位置にかかわらず、スプレッドシート内のシートの一意の ID。
columnIntegerターゲット範囲の最初の列。
columnEndIntegerターゲット範囲の終了列。
rowIntegerターゲット範囲の開始行。
rowEndIntegerターゲット範囲の終了行。

認可

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

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

関連ドキュメント


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

パラメータ

名前説明
sheetSheet対象のシート。
columnIntegerターゲット範囲の最初の列。
columnEndIntegerターゲット範囲の終了列。
rowIntegerターゲット範囲の開始行。
rowEndIntegerターゲット範囲の終了行。

認可

このメソッドを使用するスクリプトには、次の 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());

パラメータ

名前説明
dataSourceDataSourceピボット テーブルの作成元となるデータソース。

戻る

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

パラメータ

名前説明
dataSourceDataSourceピボット テーブルの作成元となるデータソース。

戻る

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

認可

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

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

createDeveloperMetadataFinder()

この範囲内のデベロッパー メタデータを見つける DeveloperMetadataFinderApi を返します。メタデータは、その範囲内に完全に含まれている場合にのみ、範囲内に含まれます。たとえば、行「3:3」に関連付けられたメタデータは、範囲「A1:D5」には含まれませんが、「1:5」の範囲内にあります。

戻る

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 シートのフィルタを作成するには、このメソッドを使用します。グリッド シートは、データベースに接続されていないシートです。他のタイプのフィルタを作成するには、以下をご覧ください。

戻る

Filter - 新しいフィルタ。

認可

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

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

createPivotTable(sourceData)

この範囲の最初のセルに固定された、指定された sourceData から空のピボット テーブルを作成します。

パラメータ

名前説明
sourceDataRangeピボット テーブルの作成元となるデータ。

戻る

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

パラメータ

名前説明
findTextString検索するテキストを指定します。

戻る

TextFinder - 範囲の TextFinder


deleteCells(shiftDimension)

このセル範囲を削除します。指定されたディメンションに沿ってシート内の既存のデータが、削除された範囲にシフトされます。

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

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

パラメータ

名前説明
shiftDimensionDimension既存のデータを移行するディメンション。

認可

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

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

expandGroups()

範囲またはコントロールの切り替えがこの範囲と交差する折りたたみグループを展開します。コントロールの切り替えボタンの位置は、コントロールの切り替えボタンが表示されるインデックスです。設定に応じて、グループの直前または後に表示されます。同じロケーションに複数のグループがある場合、最も低いグループを展開します。

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

この範囲内のセルに適用されるすべての縞を返します。

戻る

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

パラメータ

名前説明
rowInteger範囲を基準にしたセルの行。
columnInteger範囲を基準にしたセルの列。

戻る

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.UPDirection.DOWN のコピーを返し、ディメンションが Dimension.COLUMNS の場合は Direction.NEXTDirection.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());

パラメータ

名前説明
dimensionDimension範囲を拡大するディメンション。

戻る

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 は、グラフやクエリの作成に使用できます。

Code.gs

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

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

piechart.html

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

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

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

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

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

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

戻る

String - データソースとしてこの範囲の URL を指定します。グラフなどの他の API にこの URL を渡すことができます。

認可

このメソッドを使用するスクリプトには、次の 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();

パラメータ

名前説明
firstRowIsHeaderBoolean最初の行をヘッダーとして扱うかどうか。

戻る

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 次元配列を返します。1 行ごとに 1 列、次に行の順に列がインデックスに登録されます。値は 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 は、負でないランダムな int 値です。

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

パラメータ

名前説明
directionDirection次のデータ領域のエッジセルを検出する方向。

戻る

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

指定された範囲の左上セルの数値形式または日付形式を取得します。返される形式設定パターンについては、スプレッドシート 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 を返します。

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

戻る

RichTextValue - 範囲内の左上のセルのリッチテキスト値。セル値がテキストでない場合は null

認可

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

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

getRichTextValues()

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

// Get 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++) {
    Logger.log(values[i][j]);
  }
}

戻る

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

関連ドキュメント


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

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

戻る

Object - このセルの値。

認可

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

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

getValues()

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

2 次元の値の配列を返します。インデックスは行で、次に列でインデックス化されます。セルの値に応じて、NumberBooleanDateString のいずれかになります。空のセルは、配列内の空の文字列で表されます。範囲インデックスは 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 プリミティブ(NumberBooleanString など)に変換します。

戻る

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

パラメータ

名前説明
shiftDimensionDimension既存のデータを移行するディメンション。

戻る

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

パラメータ

名前説明
checkedValueObjectチェックボックスのデータ検証でオンになっている値。

戻る

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

パラメータ

名前説明
checkedValueObjectチェックボックスのデータ検証でオンになっている値。
uncheckedValueObjectチェックボックスのデータ検証でオフにされた値。

戻る

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

範囲内のすべてのセルのチェックボックス状態が 'checked' であるかどうかを返します。一部のセルがオンになっていて、他のセルはオフになっている場合、または一部のセルにチェックボックス データ検証がない場合、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: 範囲内のすべてのセルがオンになっている場合は 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 の場合、このメソッドは true を返します。範囲 3:7(範囲の先頭にある行のみにバインドされている)の場合、このメソッドは false を返します。

戻る

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

パラメータ

名前説明
targetRangeこの範囲をコピーする対象範囲。左上のセル位置のみが関連します。

認可

このメソッドを使用するスクリプトには、次の 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);

パラメータ

名前説明
rowOffsetInteger範囲の左上セルから下方向にある行数。負の値は、範囲の左上セルから上方にある行を表します。
columnOffsetInteger範囲内のセルの左から右の列の数。負の値は、範囲内のセルの左にある列を表します。

戻る

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

パラメータ

名前説明
rowOffsetInteger範囲の左上セルから下方向にある行数。負の値は、範囲の左上セルから上方にある行を表します。
columnOffsetInteger範囲内のセルの左から右の列の数。負の値は、範囲内のセルの左にある列を表します。
numRowsInteger新しい範囲の行の高さ。

戻る

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

パラメータ

名前説明
rowOffsetInteger範囲の左上セルから下方向にある行数。負の値は、範囲の左上セルから上方にある行を表します。
columnOffsetInteger範囲内のセルの左から右の列の数。負の値は、範囲内のセルの左にある列を表します。
numRowsInteger新しい範囲の行の高さ。
numColumnsInteger新しい範囲の列の幅。

戻る

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

パラメータ

名前説明
columnsToCompareInteger[]重複値を分析するための列です。列を指定しない場合、すべての列で重複が分析されます。

戻る

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

パラメータ

名前説明
colorStringCSS 表記のカラーコード('#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);

パラメータ

名前説明
colorColor設定する背景色。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);

パラメータ

名前説明
colorColor[][]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);

パラメータ

名前説明
redIntegerRGB 表記の赤の値。
greenIntegerRGB 表記の緑色の値。
blueIntegerRGB 表記の青色の値。

戻る

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

パラメータ

名前説明
colorString[][]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);

パラメータ

名前説明
topBoolean枠線の場合は true、なしの場合は false、変更しない場合は null です。
leftBoolean枠線の場合は true、なしの場合は false、変更しない場合は null です。
bottomBoolean枠線の場合は true、なしの場合は false、変更しない場合は null です。
rightBoolean枠線の場合は true、なしの場合は false、変更しない場合は null です。
verticalBoolean内部の縦枠線の場合は true、なしの場合は false、変更がない場合は null です。
horizontalBoolean内部の水平枠線の場合は 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);

パラメータ

名前説明
topBoolean枠線の場合は true、なしの場合は false、変更しない場合は null です。
leftBoolean枠線の場合は true、なしの場合は false、変更しない場合は null です。
bottomBoolean枠線の場合は true、なしの場合は false、変更しない場合は null です。
rightBoolean枠線の場合は true、なしの場合は false、変更しない場合は null です。
verticalBoolean内部の縦枠線の場合は true、なしの場合は false、変更がない場合は null です。
horizontalBoolean内部の水平枠線の場合は true、なしの場合は false、変更しない場合は null です。
colorStringCSS 表記の色(例: '#ffffff''white')。デフォルトの色は null(黒)。
styleBorderStyle枠線のスタイル、デフォルトのスタイル(実線)は 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);

パラメータ

名前説明
ruleDataValidation設定するデータ検証ルール、またはデータ検証を削除する 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);

パラメータ

名前説明
rulesDataValidation[][]設定するデータ検証ルールの 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");

パラメータ

名前説明
colorStringCSS 表記のフォントの色('#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);

パラメータ

名前説明
colorColor設定するフォントの色。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);

パラメータ

名前説明
colorsColor[][]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);

パラメータ

名前説明
colorsObject[][]CSS 表記で色を表す 2 次元の配列('#ffffff''white' など)。null 値により色がリセットされます。

戻る

Range - チェーン用の範囲。

認可

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

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

setFontFamilies(fontFamilies)

フォント ファミリーの長方形グリッドを設定します(この範囲のディメンションと一致させる必要があります)。フォント ファミリーの例は「≠」または「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);

パラメータ

名前説明
fontFamiliesObject[][]フォント ファミリーの 2 次元配列。null 値ではフォント ファミリーがリセットされます。

戻る

Range - チェーン用の範囲。

認可

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

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

setFontFamily(fontFamily)

フォント ファミリー(「"Arial"」や「quot;Helvetica"」など)を設定します。

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

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

パラメータ

名前説明
fontFamilyString設定するフォント ファミリー。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");

パラメータ

名前説明
fontLineStringフォント ライン スタイル('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);

パラメータ

名前説明
fontLinesObject[][]フォント ライン スタイル('underline''line-through'、または 'none')の 2 次元配列。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);

パラメータ

名前説明
sizeIntegerポイントサイズのフォントサイズ。

戻る

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

パラメータ

名前説明
sizesObject[][]サイズの 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");

パラメータ

名前説明
fontStyleStringフォント スタイル('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);

パラメータ

名前説明
fontStylesObject[][]フォント スタイルの 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");

パラメータ

名前説明
fontWeightStringフォントの太さ('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);

パラメータ

名前説明
fontWeightsObject[][]フォントの太さの 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)");

パラメータ

名前説明
formulaStringセルに設定する数式を表す文字列。

戻る

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

パラメータ

名前説明
formulaString文字列の数式。

戻る

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

パラメータ

名前説明
formulasString[][]数式の 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);

パラメータ

名前説明
formulasString[][]数式の 2 次元配列(R1C1 形式)。

戻る

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

パラメータ

名前説明
alignmentStringアライメント('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);

パラメータ

名前説明
alignmentsObject[][]配置の 2 次元配列('left''center''normal')。null 値で配置がリセットされます。

戻る

Range - チェーン用の範囲。

認可

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

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

関連ドキュメント


setNote(note)

指定された値にメモを設定します。

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

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

パラメータ

名前説明
noteString範囲を設定するメモの値。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)

パラメータ

名前説明
notesObject[][]メモの 2 次元配列。null 値によってメモが削除されます。

戻る

Range - チェーン用の範囲。

認可

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

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

関連ドキュメント


setNumberFormat(numberFormat)

数値または日付の形式を、指定された書式設定文字列に設定します。使用可能な形式のパターンについては、スプレッドシート API のドキュメントをご覧ください。

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

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

パラメータ

名前説明
numberFormatString数値形式の文字列。

戻る

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

パラメータ

名前説明
numberFormatsObject[][]数値形式の 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);

パラメータ

名前説明
valueRichTextValue目的のリッチテキスト値。

戻る

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

パラメータ

名前説明
valuesRichTextValue[][]目的のリッチ テキスト値。

戻る

Range - チェーン用の範囲。

認可

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

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

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

パラメータ

名前説明
showHyperlinkBooleanハイパーリンクを表示するかどうかを指定します。

戻る

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

パラメータ

名前説明
directionTextDirection目的のテキスト方向。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());

パラメータ

名前説明
directionsTextDirection[][]目的のテキスト方向。指定された方向が 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);

パラメータ

名前説明
degreesInteger標準の向きと目的の向きの間の希望の角度。 左から右へのテキストでは、正の角度は反時計回りになります。

戻る

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

パラメータ

名前説明
rotationTextRotation目的のテキストの回転設定。

戻る

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

パラメータ

名前説明
rotationsTextRotation[][]目的のテキストの回転設定。

戻る

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

パラメータ

名前説明
styleTextStyle目的のテキスト スタイル。

戻る

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

パラメータ

名前説明
stylesTextStyle[][]目的のテキスト スタイル。

戻る

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

パラメータ

名前説明
valueObject範囲の値。

戻る

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

パラメータ

名前説明
valuesObject[][]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");

パラメータ

名前説明
alignmentStringアライメント('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);

パラメータ

名前説明
alignmentsObject[][]配置の 2 次元配列('top''middle''bottom')。null 値で配置がリセットされます。

戻る

Range - チェーン用の範囲。

認可

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

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

関連ドキュメント


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

パラメータ

名前説明
isVerticalBooleanテキストを積み重ねるかどうか。

戻る

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

パラメータ

名前説明
isWrapEnabledBooleanテキストを折り返すかどうか。

戻る

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

パラメータ

名前説明
strategiesWrapStrategy[][]目的のラッピング戦略。

戻る

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

パラメータ

名前説明
strategyWrapStrategy目的のラッピング戦略。

戻る

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

パラメータ

名前説明
isWrapEnabledObject[][]セル内のテキストを折り返すかどうかを決めるラップ変数の 2 次元配列。

戻る

Range - チェーン用の範囲。

認可

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

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

関連ドキュメント


shiftColumnGroupDepth(delta)

範囲の列のグループ化の深さを指定の量で変更します。

これにより、範囲と交差するグループを作成、変更、削除できるようになります。正の差分の場合、グループの作成 / 変更。負の差分の場合、グループは破棄または変更されます。

グループの深さを 0 未満にしたり、8 より小さくしたりしても、効果はありません。

column group control positionBEFORE の場合、最初の行の深さをシフトしようとすると、エラーがスローされます。

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

パラメータ

名前説明
deltaIntegerこの範囲の列グループの深さを変更する金額。

戻る

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 positionBEFORE の場合、最初の行の深さをシフトしようとすると、エラーがスローされます。

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

パラメータ

名前説明
deltaIntegerこの範囲の行グループの深さを変更する金額。

戻る

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

パラメータ

名前説明
sortSpecObjObject並べ替えの基準となる列。

戻る

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            |

パラメータ

名前説明
delimiterString分割するカスタムの区切り文字。

認可

このメソッドを使用するスクリプトには、次の 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            |

パラメータ

名前説明
delimiterTextToColumnsDelimiter分割するプリセット区切り文字。

認可

このメソッドを使用するスクリプトには、次の 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

サポート終了のメソッド