Class Range

範囲

スプレッドシートの範囲へのアクセスと変更。範囲はシート内の単一のセルでも、セルのグループでも使用できます。 隣接するセルを表示することもできます。

メソッド

メソッド戻り値の型概要
activate()Range指定された範囲を active range として設定します。 範囲内の左側のセルを current cell として指定します。
activateAsCurrentCell()Range指定されたセルを current cell として設定します。
addDeveloperMetadata(key)Range指定されたキーを持つデベロッパー メタデータを範囲に追加します。
addDeveloperMetadata(key, visibility)Range指定されたキーと公開設定を持つデベロッパー メタデータを範囲に追加します。
addDeveloperMetadata(key, value)Range指定されたキーと値を持つデベロッパー メタデータを範囲に追加します。
addDeveloperMetadata(key, value, visibility)Range指定されたキー、値、公開設定を持つデベロッパー メタデータを範囲に追加します。
applyColumnBanding()Bandingデフォルトの列バンディング テーマを範囲に適用します。
applyColumnBanding(bandingTheme)Banding指定した列バンディング テーマを範囲に適用します。
applyColumnBanding(bandingTheme, showHeader, showFooter)Banding指定された列帯域テーマを、指定されたヘッダーとフッターの範囲に適用します 設定。
applyRowBanding()Bandingデフォルトの行バンディング テーマを範囲に適用します。
applyRowBanding(bandingTheme)Banding指定した行バンディング テーマを範囲に適用します。
applyRowBanding(bandingTheme, showHeader, showFooter)Banding指定したヘッダーとフッターの設定がある範囲に、指定した行バンディング テーマを適用します。
autoFill(destination, series)voidこの範囲のデータに基づいて destinationRange にデータを入力します。
autoFillToNeighbor(series)void隣接するセルに基づいて新しいデータで入力範囲を計算し、自動的に入力します その範囲に含まれるデータに基づいて新しい値で範囲が作成されます。
breakApart()Range範囲内の複数列のセルを再び個々のセルに分割します。
canEdit()Boolean範囲内のすべてのセルを編集する権限をユーザーに付与するかどうかを指定します。
check()Range範囲のチェックボックスの状態を「オン」に変更します。
clear()Rangeコンテンツと形式の範囲をクリアします。
clear(options)Range ファイアウォールルールを作成します
clearContent()Range書式はそのままにして、範囲の内容をクリアします。
clearDataValidations()Range範囲のデータ入力規則をクリアします。
clearFormat()Rangeこの範囲の書式をクリアします。
clearNote()Range指定したセル(複数可)内のメモをクリアします。
collapseGroups()Range範囲内に含まれているすべてのグループを折りたたみます。
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)void範囲の書式を指定された場所にコピーします。
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)void範囲の書式を指定された場所にコピーします。
copyTo(destination)voidセル範囲のデータを別のセル範囲にコピーします。
copyTo(destination, copyPasteType, transposed)voidセル範囲のデータを別のセル範囲にコピーします。
copyTo(destination, options)voidセル範囲のデータを別のセル範囲にコピーします。
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)void範囲の内容を指定された場所にコピーします。
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)void範囲の内容を指定された場所にコピーします。
createDataSourcePivotTable(dataSource)DataSourcePivotTableデータソースから空のデータソースのピボット テーブルを作成し、 選択します。
createDataSourceTable(dataSource)DataSourceTableデータソースから空のデータソース テーブルを作成し、このテーブルの最初のセルに固定します。 あります。
createDeveloperMetadataFinder()DeveloperMetadataFinderこのスコープ内のデベロッパー メタデータを検索するための DeveloperMetadataFinderApi を返します。 あります。
createFilter()Filterフィルタを作成し、シート上の指定した範囲に適用します。
createPivotTable(sourceData)PivotTable最初のセルに固定された、指定された sourceData から空のピボット テーブルを作成します この範囲内にあります。
createTextFinder(findText)TextFinder範囲のテキスト ファインダーを作成します。この範囲のテキストを検索して置換できます。
deleteCells(shiftDimension)voidこのセル範囲を削除します。
expandGroups()Range折りたたまれたグループ(範囲またはコントロールの切り替えボタン)が、この範囲と交差しているものを展開します。
getA1Notation()String範囲の文字列説明を A1 表記で返します。
getBackground()String範囲内の左上のセルの背景色を返します(例: '#ffffff')。
getBackgroundObject()Color範囲内の左上のセルの背景色を返します。
getBackgroundObjects()Color[][]範囲内のセルの背景色を返します。
getBackgrounds()String[][]範囲内のセルの背景色を返します(例: '#ffffff')。
getBandings()Banding[]この範囲の任意のセルに適用されるすべてのバンディングを返します。
getCell(row, column)Range範囲内の指定されたセルを返します。
getColumn()Integerこの範囲の開始列の位置を返します。
getDataRegion()Rangeすべてを網羅するために、4 つの基数 Direction で拡張された範囲のコピーを返します。 隣接するセルを表示することもできます。
getDataRegion(dimension)Range次の場合は、拡張された範囲の Direction.UPDirection.DOWN のコピーを返します。 指定されたディメンションが Dimension.ROWS、またはディメンションが 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[]完全に統合されたセルを表す Range オブジェクトの配列を返します。 現在の範囲内に 1 つ以上のセルを含めることもできます。
getNextDataCell(direction)Range範囲の最初の列と行にあるセルから、次のセルを返します 特定の方向(データが含まれる連続したセル範囲の端)またはセルの方向 その方向の端をクリックします。
getNote()String指定した範囲に関連付けられたメモを返します。
getNotes()String[][]範囲内のセルに関連付けられたメモを返します。
getNumColumns()Integerこの範囲の列数を返します。
getNumRows()Integerこの範囲内の行数を返します。
getNumberFormat()String指定した範囲の左上のセルの数値または日付形式を取得します。
getNumberFormats()String[][]範囲内のセルの数値または日付形式を返します。
getRichTextValue()RichTextValue範囲の左上のセルのリッチテキスト値を返します。セルがセルの場合は null を返します。 value はテキストではありません。
getRichTextValues()RichTextValue[][]範囲内のセルのリッチ テキスト値を返します。
getRow()Integerこの範囲の行の位置を返します。
getRowIndex()Integerこの範囲の行の位置を返します。
getSheet()Sheetこの範囲が属するシートを返します。
getTextDirection()TextDirection範囲の左上のセルのテキスト方向を返します。
getTextDirections()TextDirection[][]範囲内のセルの方向を返します。
getTextRotation()TextRotation範囲の左上のセルのテキスト回転設定を返します。
getTextRotations()TextRotation[][]範囲内のセルのテキスト回転設定を返します。
getTextStyle()TextStyle範囲の左上のセルのテキスト スタイルを返します。
getTextStyles()TextStyle[][]範囲内のセルのテキスト スタイルを返します。
getValue()Object範囲内の左上のセルの値を返します。
getValues()Object[][]この範囲の値の長方形のグリッドを返します。
getVerticalAlignment()Stringセルの左上隅にあるセルの垂直方向の配置(上、中央、下)を返します。 あります。
getVerticalAlignments()String[][]範囲内のセルの垂直方向の配置を返します。
getWidth()Integer範囲の幅を列単位で返します。
getWrap()Booleanセル内のテキストを折り返すかどうかを返します。
getWrapStrategies()WrapStrategy[][]範囲内のセルのテキストの折り返し方法を返します。
getWrapStrategy()WrapStrategy範囲の左上のセルのテキストの折り返し方法を返します。
getWraps()Boolean[][]セル内のテキストを折り返すかどうかを返します。
insertCells(shiftDimension)Rangeこの範囲に空のセルを挿入します。
insertCheckboxes()Range範囲内の各セルにチェックボックスを挿入します。チェックボックスがオンの場合は true、 オフの場合は false
insertCheckboxes(checkedValue)Range範囲内の各セルにチェックボックスを挿入します。このチェックボックスは、オンにされたセルと、 オフの場合は空の文字列を返します。
insertCheckboxes(checkedValue, uncheckedValue)Range選択範囲にカスタム値が設定された、範囲内の各セルにチェックボックスを挿入します 未確認の状態を表します
isBlank()Boolean範囲が完全に空白の場合、true を返します。
isChecked()Boolean範囲内のすべてのセルのチェックボックスの状態が「オン」かどうかを返します。
isEndColumnBounded()Boolean範囲の終端を特定の列にバインドするかどうかを決定します。
isEndRowBounded()Boolean範囲の終端を特定の行にバインドするかどうかを決定します。
isPartOfMerge()Boolean現在の範囲内のセルが結合されたセルと重なっている場合、true を返します。
isStartColumnBounded()Boolean範囲の先頭を特定の列にバインドするかどうかを決定します。
isStartRowBounded()Boolean範囲の先頭を特定の行にバインドするかどうかを決定します。
merge()Range範囲内のセルを 1 つのブロックに結合します。
mergeAcross()Range範囲の複数の列を結合して範囲内のセルを結合します。
mergeVertically()Range範囲内のセルを結合します。
moveTo(target)voidこの範囲(書式と値の両方)を切り取って目的の範囲に貼り付けます。
offset(rowOffset, columnOffset)Rangeこの範囲から指定された行数と列数だけオフセットされた新しい範囲を返します (負の値でもかまいません)。
offset(rowOffset, columnOffset, numRows)Range現在の範囲を基準として、左上の点がオフセットされた新しい範囲を返します 現在の範囲から指定された行と列のセル数と、セルの高さを指定した値を返します。
offset(rowOffset, columnOffset, numRows, numColumns)Range現在の範囲を基準として、左上の点がオフセットされた新しい範囲を返します 現在の範囲から指定した行と列で、指定された高さと幅の 選択します。
protect()Protectionアクセス権を持っているユーザー以外による範囲の編集を防止できるオブジェクトを作成します。 付与します。
randomize()Range指定された範囲内の行の順序をランダム化します。
removeCheckboxes()Range範囲からすべてのチェックボックスを削除します。
removeDuplicates()Rangeこの範囲内で、いずれかの値と重複する値を含む行を削除します 選択します。
removeDuplicates(columnsToCompare)Rangeこの範囲内で、指定された列の値が重複している行を削除します 確認できます。
setBackground(color)Range範囲内のすべてのセルの背景色を CSS 表記('#ffffff' など)で設定します または 'white')。
setBackgroundObject(color)Range範囲内のすべてのセルの背景色を設定します。
setBackgroundObjects(color)Range背景色の長方形のグリッドを設定します(この範囲の寸法と一致する必要があります)。
setBackgroundRGB(red, green, blue)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フォント ファミリーを設定します(「Arial」など)。「Helvetica」を入力します。
setFontLine(fontLine)Range指定した範囲('underline''line-through'、または 'none')。
setFontLines(fontLines)Range線スタイルの長方形のグリッドを設定します(この範囲の寸法と一致する必要があります)。
setFontSize(size)Rangeフォントサイズを設定します。サイズは使用するポイントサイズです。
setFontSizes(sizes)Rangeフォントサイズの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。
setFontStyle(fontStyle)Range指定した範囲('italic' または 'normal')のフォント スタイルを設定します。
setFontStyles(fontStyles)Rangeフォント スタイルの長方形のグリッドを設定します(この範囲のサイズと一致している必要があります)。
setFontWeight(fontWeight)Range指定した範囲(標準/太字)のフォントの太さを設定します。
setFontWeights(fontWeights)Rangeフォントの太さの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。
setFormula(formula)Rangeこの範囲の数式を更新します。
setFormulaR1C1(formula)Rangeこの範囲の数式を更新します。
setFormulas(formulas)Range長方形の数式グリッドを設定します(この範囲の寸法と一致する必要があります)。
setFormulasR1C1(formulas)Range長方形の数式グリッドを設定します(この範囲の寸法と一致する必要があります)。
setHorizontalAlignment(alignment)Range指定した範囲(左/中央/右)で水平(左から右)の配置を設定します。
setHorizontalAlignments(alignments)Range水平方向の配置の長方形のグリッドを設定します。
setNote(note)Range指定された値にメモを設定します。
setNotes(notes)Rangeメモの長方形のグリッドを設定します(この範囲の寸法と一致する必要があります)。
setNumberFormat(numberFormat)Range数値または日付形式を、指定された形式設定文字列に設定します。
setNumberFormats(numberFormats)Range数値形式または日付形式の長方形のグリッドを設定します(この範囲のディメンションと一致する必要があります)。
setRichTextValue(value)Range範囲内のセルにリッチテキスト値を設定します。
setRichTextValues(values)Rangeリッチテキスト値の長方形のグリッドを設定します。
setShowHyperlink(showHyperlink)Range範囲にハイパーリンクを表示するかどうかを設定します。
setTextDirection(direction)Range範囲内のセルのテキスト方向を設定します。
setTextDirections(directions)Rangeテキスト方向の長方形のグリッドを設定します。
setTextRotation(degrees)Range範囲内のセルのテキスト回転設定を設定します。
setTextRotation(rotation)Range範囲内のセルのテキスト回転設定を設定します。
setTextRotations(rotations)Rangeテキストの回転を示す長方形のグリッドを設定します。
setTextStyle(style)Range範囲内のセルのテキスト スタイルを設定します。
setTextStyles(styles)Rangeテキスト スタイルの長方形グリッドを設定します。
setValue(value)Range範囲の値を設定します。
setValues(values)Range長方形のグリッドで値を設定します(この範囲の寸法と一致する必要があります)。
setVerticalAlignment(alignment)Range指定した範囲(上、中央、下)の垂直方向(上から下)の配置を設定します。
setVerticalAlignments(alignments)Range垂直方向の配置の長方形のグリッドを設定します(この範囲の寸法と一致する必要があります)。
setVerticalText(isVertical)Range範囲内のセルのテキストを積み重ねるかどうかを設定します。
setWrap(isWrapEnabled)Range指定した範囲のセル折り返しを設定します。
setWrapStrategies(strategies)Rangeラップ戦略の長方形グリッドを設定します。
setWrapStrategy(strategy)Range範囲内のセルのテキストの折り返し方法を設定します。
setWraps(isWrapEnabled)Rangeキーワード折り返しポリシーの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。
shiftColumnGroupDepth(delta)Range範囲の列グループ化の深さを指定の量だけ変更します。
shiftRowGroupDepth(delta)Range範囲の行グループ化の深さを指定の金額で変更します。
sort(sortSpecObj)Range指定した範囲のセルを、指定された列と順序で並べ替えます。
splitTextToColumns()void自動検出された区切り文字に基づいて、テキストの列を複数の列に分割します。
splitTextToColumns(delimiter)void指定された文字列をカスタムの区切り文字として使用して、テキストの列を複数の列に分割します。
splitTextToColumns(delimiter)void指定された区切り文字に基づいて、テキストの列を複数の列に分割します。
trimWhitespace()Rangeこの範囲のすべてのセルの空白(スペース、タブ、改行など)を削除します。
uncheck()Range範囲のチェックボックスの状態を「オフ」に変更します。

詳細なドキュメント

activate()

指定された範囲を active range として設定します。 範囲内の左側のセルを current cell として指定します。

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

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

戻る

Range - この範囲(チェーン)。


activateAsCurrentCell()

指定されたセルを current cell として設定します。

指定したセルが既存の範囲に存在する場合は、その範囲がアクティブになります。 範囲を現在のセルとして返します。

指定したセルが既存の範囲にない場合、既存の選択範囲は 削除され、そのセルが現在のセルとそのアクティブ範囲になります。

注: 指定した Range は、1 つのセルで構成する必要があります。そうでない場合は、次のエラーがスローされます。 発生します。

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

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

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

戻る

Range - この範囲(チェーン)。

承認

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

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

addDeveloperMetadata(key)

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

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

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

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

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

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

パラメータ

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

戻る

Range - この範囲(チェーン)。

承認

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

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

addDeveloperMetadata(key, visibility)

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

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

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

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

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

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

パラメータ

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

戻る

Range - この範囲(チェーン)。

承認

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

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

addDeveloperMetadata(key, value)

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

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

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

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

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

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

パラメータ

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

戻る

Range - この範囲(チェーン)。

承認

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

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

addDeveloperMetadata(key, value, visibility)

指定されたキー、値、公開設定を持つデベロッパー メタデータを範囲に追加します。

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

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

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

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

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

パラメータ

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

戻る

Range - この範囲(チェーン)。

承認

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

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

applyColumnBanding()

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

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

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

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

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

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

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

戻る

Banding - 新しいバンド。

承認

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

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

applyColumnBanding(bandingTheme)

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

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

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

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

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

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

パラメータ

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

戻る

Banding - 新しいバンド。

承認

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

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

applyColumnBanding(bandingTheme, showHeader, showFooter)

指定された列帯域テーマを、指定されたヘッダーとフッターの範囲に適用します 設定。

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

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

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

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

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

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

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

パラメータ

名前説明
bandingThemeBandingTheme範囲内の列に適用するカラーテーマ。
showHeaderBooleantrue の場合、縞模様テーマのヘッダーの色が最初の色に適用されます。 選択します。
showFooterBooleantrue の場合、縞模様テーマのフッター色が最後の要素に適用されます。 選択します。

戻る

Banding - 新しいバンド。

承認

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

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

applyRowBanding()

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

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

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

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

戻る

Banding - 縞模様。

承認

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

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

applyRowBanding(bandingTheme)

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

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

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

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

パラメータ

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

戻る

Banding - 新しいバンド。

承認

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

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

applyRowBanding(bandingTheme, showHeader, showFooter)

指定したヘッダーとフッターの設定がある範囲に、指定した行帯テーマを適用します。

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

パラメータ

名前説明
bandingThemeBandingTheme範囲内の行に適用するカラーテーマ。
showHeaderBooleantrue の場合、縞模様テーマのヘッダーの色が最初の行に適用されます。
showFooterBooleantrue の場合、縞模様テーマのフッター色が最後の行に適用されます。

戻る

Banding - 新しいバンド。

承認

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

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

autoFill(destination, series)

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

var sheet = SpreadsheetApp.getActiveSheet();

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

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

パラメータ

名前説明
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 に挿入しました。このようにして、これらの新しい値はテキストを含むセルに 値を集計します

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

範囲内の複数列のセルを再び個々のセルに分割します。

範囲に対してこの関数を呼び出すことは、範囲を選択して [表示形式] > [セルを結合] > [結合を解除] をタップします。

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

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

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

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

戻る

Range - この範囲(チェーン)。

承認

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

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

canEdit()

範囲内のすべてのセルを編集する権限をユーザーに付与するかどうかを指定します。スプレッドシート オーナーは常に保護されている範囲とシートを編集できます。

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

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

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

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

戻る

Boolean - ユーザーが範囲内のすべてのセルを編集する権限を持っている場合は truefalse できません。

承認

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

この範囲の書式をクリアします。

1 つまたは複数のセルの書式をクリアします。ただし、書式はリセットされません。 数値形式ルールを使用します。

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」の範囲内にある。

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

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

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

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

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

戻る

DeveloperMetadataFinder - この範囲のスコープ内のメタデータを検索するデベロッパー メタデータ ファインダー。


createFilter()

フィルタを作成し、シート上の指定した範囲に適用します。作成できるのは最大で フィルタを 1 つ作成することもできます作成したフィルタにアクセスして変更するには、getFilter() または Sheet.getFilter() を使用します。

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

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}
このメソッドを使用して、Grid シート(デフォルトのシートタイプ)のフィルタを作成します。 グリッドシートは、データベースに接続されていないシートです。他のタイプのフィルタを作成するには、 以下を参照してください。 <ph type="x-smartling-placeholder">

戻る

Filter - 新しいフィルタ。

承認

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

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

createPivotTable(sourceData)

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

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

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

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

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

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

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

パラメータ

名前説明
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 = textFinder.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()

この範囲の任意のセルに適用されるすべてのバンディングを返します。

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

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

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

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

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

戻る

Banding[] - この範囲の任意のセルに適用されるすべての縞模様。

承認

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

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

getCell(row, column)

範囲内の指定されたセルを返します。

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

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

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

パラメータ

名前説明
rowInteger範囲を基準とするセルの行。
columnInteger範囲を基準とするセルの列。

戻る

Range - 指定された座標にある 1 つのセルを含む範囲。

承認

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

次の場合は、拡張された範囲の Direction.UPDirection.DOWN のコピーを返します。 指定されたディメンションが Dimension.ROWS、またはディメンションが 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 を返します。 セルにデータソースの数式が含まれていません。

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

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

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

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

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

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

戻る

DataSourceFormula - セルの DataSourceFormula

承認

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

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

getDataSourceFormulas()

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

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

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

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

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

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

戻る

DataSourceFormula[] - DataSourceFormula の配列。

承認

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

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

getDataSourcePivotTables()

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

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

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

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

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.getDataSourcePivotTables();

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

戻る

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

承認

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

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

getDataSourceTables()

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

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

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

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

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

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

戻る

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

承認

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

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

getDataSourceUrl()

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

コード.gs

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

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

piechart.html

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

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

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

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

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

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

戻る

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

承認

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

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

getDataTable()

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

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

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

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

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

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

戻る

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


getDataTable(firstRowIsHeader)

この範囲内のデータを 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()

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

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

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

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

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

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

戻る

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

承認

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

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

getDisplayValue()

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

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

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

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

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

戻る

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

承認

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

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

getDisplayValues()

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

行、列の順にインデックス付けされた、表示された値の 2 次元配列を返します。「 値は String オブジェクトです。表示される値では、日時、 通貨の書式設定(スプレッドシートの言語 / 地域によって自動的に適用される書式を含む) 設定されます。空のセルは、配列内の空の文字列で表されます。前述のとおり、 範囲インデックスは 1, 1 から始まり、JavaScript 配列のインデックスは [0][0] から始まります。

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

戻る

String[][] - 値の 2 次元配列。

承認

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

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

getFilter()

この範囲が属するシートのフィルタを返します。フィルタがない場合は null を返します。 表示されます。

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

戻る

Filter - フィルタ。

承認

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

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

getFontColorObject()

範囲の左上隅にあるセルのフォントの色を返します。

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

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

戻る

Color - 範囲内の左上のセルのフォント色。

承認

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

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

getFontColorObjects()

範囲内のセルのフォントの色を返します。

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

var results = range.getFontColorObjects();

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

戻る

Color[][] — 範囲内のセルに関連付けられたフォント色の 2 次元配列。

承認

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

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

getFontFamilies()

範囲内のセルのフォント ファミリーを返します。

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

var results = range.getFontFamilies();

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

戻る

String[][] — 範囲内のセルに関連付けられたフォント ファミリーの 2 次元配列。

承認

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

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

getFontFamily()

範囲の左上隅にあるセルのフォント ファミリーを返します。

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

Logger.log(range.getFontFamily());

戻る

String - セルのフォント ファミリー。

承認

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

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

getFontLine()

範囲の左上隅にあるセルの線のスタイルを取得します('underline''line-through''none' など)。

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

Logger.log(range.getFontLine());

戻る

String — フォント行。

承認

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

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

getFontLines()

範囲('underline''line-through'、または 'none')。

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

var results = range.getFontLines();

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

戻る

String[][] — 範囲内のセルに関連付けられたフォント線の 2 次元配列。

承認

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

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

getFontSize()

範囲の左上隅にあるセルのフォントサイズをポイントサイズで返します。

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

Logger.log(range.getFontSize());

戻る

Integer - フォントサイズ(ポイントサイズ)。

承認

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

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

getFontSizes()

範囲内のセルのフォントサイズを返します。

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

var results = range.getFontSizes();

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

戻る

Integer[][] - 範囲内のセルに関連付けられたテキストのフォントサイズの 2 次元配列。

承認

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

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

getFontStyle()

左上のセルのフォント スタイル('italic' または 'normal')を返します。 クリックします。

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

Logger.log(range.getFontStyle());

戻る

String - セル内のテキストのフォント スタイル。

承認

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

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

getFontStyles()

範囲内のセルのフォント スタイルを返します。

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

var results = range.getFontStyles();

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

戻る

String[][] — 範囲内のセルに関連付けられたテキストのフォント スタイルの 2 次元配列。

承認

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

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

getFontWeight()

範囲の左上隅にあるセルのフォントの太さ(標準/太字)を返します。

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

Logger.log(range.getFontWeight());

戻る

String - セル内のテキストのフォントの太さ。

承認

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

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

getFontWeights()

範囲内のセルのフォントの太さを返します。

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

var results = range.getFontWeights();

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

戻る

String[][] - 範囲内のセルに関連付けられたテキストのフォントの太さを示す 2 次元配列。

承認

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

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

getFormula()

範囲の左上のセルの数式(A1 表記)を返します。数式が一致しない場合は空の文字列を返します。 セルが空であるか、数式が含まれていません。

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

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

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

戻る

String - セルの数式。

承認

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

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

getFormulaR1C1()

指定したセルの数式(R1C1 表記)を返します。セルがない場合は null を返します。

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

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

戻る

String - R1C1 表記の数式。

承認

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

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

getFormulas()

範囲内のセルの数式(A1 表記)を返します。2 次元配列のエントリは 数式のないセルには空の文字列を指定してください。

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 表記)を返します。2 次元配列のエントリは 数式のないセルの場合は null

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

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

戻る

String[][] - R1C1 表記の数式の 2 次元配列。

承認

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

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

getGridId()

範囲の親シートのグリッド ID を返します。ID は負でないランダムな整数値です。

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

Logger.log(range.getGridId());

戻る

Integer - 親シートのグリッド ID。

承認

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

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

getHeight()

範囲の高さを返します。

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

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

戻る

Integer - 範囲の高さ。

承認

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

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

getHorizontalAlignment()

左上のセルのテキストの水平方向の配置(左/中央/右)を返します。 クリックします。

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

Logger.log(range.getHorizontalAlignment());

戻る

String - セル内のテキストの水平方向の配置。

承認

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

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

getHorizontalAlignments()

範囲内のセルの水平方向の配置を返します。

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

var results = range.getHorizontalAlignments();

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

戻る

String[][] - 次のセルに関連付けられたテキストの水平方向の配置の 2 次元配列 あります。

承認

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

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

getLastColumn()

終了列の位置を返します。

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

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

戻る

Integer - スプレッドシート内の範囲の終了列の位置。

承認

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

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

getLastRow()

終了行の位置を返します。

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

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

戻る

Integer - スプレッドシート内の範囲の終了行の位置。

承認

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

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

getMergedRanges()

完全に統合されたセルを表す Range オブジェクトの配列を返します。 現在の範囲内に 1 つ以上のセルを含めることもできます。

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

指定した範囲の左上のセルの数値または日付形式を取得します。返される形式 各パターンについては、Sheets API に ドキュメントをご覧ください

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

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

戻る

String - 範囲の左上のセルの数値形式。

承認

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

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

getNumberFormats()

範囲内のセルの数値または日付形式を返します。返される書式パターンは、 Sheets API ドキュメントをご覧ください。

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

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

戻る

String[][] - 数値形式の 2 次元配列。

承認

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

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

getRichTextValue()

範囲の左上のセルのリッチテキスト値を返します。セルがセルの場合は null を返します。 value はテキストではありません。

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

戻る

RichTextValue - 範囲内の左上のセルのリッチテキスト値。セルがセルの場合は null value はテキストではありません。

承認

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

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

getRichTextValues()

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

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

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

戻る

RichTextValue[][] - リッチテキスト値の 2 次元配列。

承認

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

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

getRow()

この範囲の行の位置を返します。getRowIndex() と同一です。

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

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

戻る

Integer - 範囲の行の位置。

承認

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

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

getRowIndex()

この範囲の行の位置を返します。getRow() と同一です。

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

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

戻る

Integer - 範囲の行の位置。

承認

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

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

関連情報


getSheet()

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

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

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

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

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

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

戻る

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

承認

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

範囲内のセルの方向を返します。自動検出を使用するセルの 2 次元配列のエントリは null です。

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

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

戻る

TextDirection[][] - テキスト方向の 2 次元配列。

承認

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

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

getTextRotation()

範囲の左上のセルのテキスト回転設定を返します。

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

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

戻る

TextRotation - テキストの回転の設定。

承認

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

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

getTextRotations()

範囲内のセルのテキスト回転設定を返します。

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

var results = range.getTextRotations();

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

戻る

TextRotation[][] - 範囲内のセルに関連付けられたテキストの回転の 2 次元配列。

承認

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

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

getTextStyle()

範囲の左上のセルのテキスト スタイルを返します。

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

戻る

TextStyle - 範囲の左上のセルのテキスト スタイル。

承認

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

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

getTextStyles()

範囲内のセルのテキスト スタイルを返します。

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

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

戻る

TextStyle[][] - テキスト スタイルの 2 次元配列。

承認

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

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

getValue()

範囲内の左上のセルの値を返します。値の型は Number、 セルの値に応じて、BooleanDate、または String。空白 セルは空の文字列を返します。

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

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

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

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

戻る

Object - このセルの値。

承認

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

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

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

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

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

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

戻る

Integer - 範囲の列数。

承認

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

範囲内のすべてのセルのチェックボックスの状態が「オン」かどうかを返します。一部のセルがオンで残りのセルがオフの場合、または一部のセルにチェックボックスがない場合、null を返します。 説明します。

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

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

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

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

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

戻る

Boolean - 範囲内のすべてのセルがオンになっている場合は true、すべてのセルを確認する場合は false 範囲がオフの場合、またはオフになっているセルまたはセルがない場合は null になります。 チェックボックスのデータ検証です。

承認

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

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

isEndColumnBounded()

範囲の終端を特定の列にバインドするかどうかを決定します。たとえば、 範囲 A1:B10 または B:B は、範囲の最後にある列にバインドされます。 メソッドは true を返します。範囲が 3:7 または A1:5 で、 範囲の最後にある特定の行を検索すると、このメソッドは false を返します。

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

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

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

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

戻る

Boolean - 範囲の終わりが特定の列にバインドされている場合は truefalse できません。

承認

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

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

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

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

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

戻る

Boolean - 範囲の末尾が特定の行にバインドされている場合は truefalse できません。

承認

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

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

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

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

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

戻る

Boolean - 範囲の先頭が特定の列にバインドされている場合は truefalse できません。

承認

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

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

isStartRowBounded()

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

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

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

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

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

戻る

Boolean - 範囲の先頭が特定の行にバインドされている場合は truefalse できません。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 つ以上を使用した承認が必要です。

  • 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 つ以上を使用した承認が必要です。

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

フォント ファミリーの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。例 フォント ファミリーは「Arial」「Helvetica」を入力します。

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

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

var cell = sheet.getRange("B2:D3");
cell.setFontFamilies(fonts);

パラメータ

名前説明
fontFamiliesObject[][]フォント ファミリーの 2 次元配列。null 値により、 設定します。

戻る

Range - この範囲(チェーン)。

承認

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

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

setFontFamily(fontFamily)

フォント ファミリーを設定します(「Arial」など)。「Helvetica」を入力します。

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

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

パラメータ

名前説明
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[][]フォントの線スタイルの 2 次元配列('underline''line-through'、または 'none')。null 値により、フォント線のスタイルがリセットされます。

戻る

Range - この範囲(チェーン)。

承認

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

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

setFontSize(size)

フォントサイズを設定します。サイズは使用するポイントサイズです。

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

var cell = sheet.getRange("B2");
cell.setFontSize(20);

パラメータ

名前説明
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[][]R1C1 形式の数式の 2 次元配列。

戻る

Range - この範囲(チェーン)。

承認

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

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

setHorizontalAlignment(alignment)

指定した範囲(左/中央/右)で水平(左から右)の配置を設定します。

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

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

パラメータ

名前説明
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)

数値または日付形式を、指定された形式設定文字列に設定します。使用可能な形式パターンは次のとおりです。 Sheets API ドキュメントをご覧ください。

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

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

パラメータ

名前説明
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

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

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

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

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

パラメータ

名前説明
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 つのスペースに置き換えます。

<ph type="x-smartling-placeholder">

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

サポート終了のメソッド