Class Sheet

シート

スプレッドシート シートにアクセスして変更する。一般的な操作は、シート名の変更や、シートから範囲オブジェクトへのアクセスです。

Methods

方法戻り値の型概要
activate()Sheetこのシートを有効にします。
addDeveloperMetadata(key)Sheet指定したキーを持つデベロッパー メタデータをシートに追加します。
addDeveloperMetadata(key, visibility)Sheet指定したキーと公開設定を持つデベロッパー メタデータをシートに追加します。
addDeveloperMetadata(key, value)Sheet指定したキーと値を持つデベロッパー メタデータをシートに追加します。
addDeveloperMetadata(key, value, visibility)Sheet指定したキー、値、可視性を含むデベロッパー メタデータをシートに追加します。
appendRow(rowContents)Sheet現在のデータ領域のシートの一番下に行を追加します。
asDataSourceSheet()DataSourceSheetシートタイプが SheetType.DATASOURCE の場合は DataSourceSheet として、それ以外の場合は null を返します。
autoResizeColumn(columnPosition)Sheet列が収まるように列の幅を設定します。
autoResizeColumns(startColumn, numColumns)Sheet内容に合わせて、指定された列の位置から始まるすべての列の幅を設定します。
autoResizeRows(startRow, numRows)Sheet内容に合わせて、指定された行位置から始まるすべての行の高さを設定します。
clear()Sheetコンテンツとシートの情報をクリアします。
clear(options)Sheet指定された詳細オプションで指定されたとおりに、コンテンツのシートまたは書式をクリアします。
clearConditionalFormatRules()voidシートからすべての条件付き書式ルールを削除します。
clearContents()Sheetフォーマット情報を維持しながら、コンテンツのシートをクリアします。
clearFormats()Sheetフォーマットを維持したまま、シートの内容をクリアします。
clearNotes()Sheetすべてのメモのシートをクリアします。
collapseAllColumnGroups()Sheetシート上のすべての列グループを折りたたみます。
collapseAllRowGroups()Sheetシート内のすべての行グループを折りたたみます。
copyTo(spreadsheet)Sheetスプレッドシートを特定のスプレッドシートにコピーします。このスプレッドシートは、ソースと同じスプレッドシートにすることができます。
createDeveloperMetadataFinder()DeveloperMetadataFinderこのシートの範囲内でデベロッパー メタデータを検出するための DeveloperMetadataFinder を返します。
createTextFinder(findText)TextFinderシート用のテキスト ファインダーを作成し、シート内のテキストを検索して置き換えることができる。
deleteColumn(columnPosition)Sheet指定した列位置の列を削除します。
deleteColumns(columnPosition, howMany)void指定した列位置から始まるいくつかの列を削除します。
deleteRow(rowPosition)Sheet指定した行の位置にある行を削除します。
deleteRows(rowPosition, howMany)void指定した行の位置から行数を削除します。
expandAllColumnGroups()Sheetシート内のすべての列グループを展開します。
expandAllRowGroups()Sheetシート内のすべての行グループを展開します。
expandColumnGroupsUpToDepth(groupDepth)Sheet指定した深度まですべての列グループを展開し、他のグループはすべて折りたたまれます。
expandRowGroupsUpToDepth(groupDepth)Sheet指定した深度まですべての行グループを拡張し、他の行グループはすべて折りたたむ。
getActiveCell()Rangeこのシート内のアクティブなセルを返します。
getActiveRange()Rangeアクティブ シート内の選択された範囲を返します。アクティブな範囲がない場合は null を返します。
getActiveRangeList()RangeListアクティブ シート内のアクティブな範囲のリストを返します。アクティブな範囲がない場合は null を返します。
getBandings()Banding[]このシートのすべてのバンディングを返します。
getCharts()EmbeddedChart[]このシート上のグラフの配列を返します。
getColumnGroup(columnIndex, groupDepth)Group指定されたインデックスとグループの深さで列グループを返します。
getColumnGroupControlPosition()GroupControlTogglePositionシート内のすべての列グループの GroupControlTogglePosition を返します。
getColumnGroupDepth(columnIndex)Integer指定されたインデックスにおける列のグループ深度を返します。
getColumnWidth(columnPosition)Integer指定された列の幅(ピクセル単位)を取得します。
getConditionalFormatRules()ConditionalFormatRule[]このシートの条件付き書式ルールをすべて取得します。
getCurrentCell()Rangeアクティブなシート内の現在のセル、または現在のセルがない場合は null を返します。
getDataRange()Rangeデータが存在するディメンションに対応する Range を返します。
getDataSourceFormulas()DataSourceFormula[]すべてのデータソースの数式を取得します。
getDataSourcePivotTables()DataSourcePivotTable[]すべてのデータソースのピボット テーブルを取得します。
getDataSourceTables()DataSourceTable[]すべてのデータソース テーブルを取得します。
getDeveloperMetadata()DeveloperMetadata[]このシートに関連付けられているすべてのデベロッパー メタデータを取得します。
getDrawings()Drawing[]シート上の図形描画の配列を返します。
getFilter()Filterこのシートのフィルタを返します。フィルタがない場合は null を返します。
getFormUrl()Stringこのシートに回答を送信するフォームの URL を返します。シートにフォームが関連する場合は null を返します。
getFrozenColumns()Integer固定された列の数を返します。
getFrozenRows()Integer固定された行数を返します。
getImages()OverGridImage[]シート上のすべてのグリッド上の画像を返します。
getIndex()Integer親スプレッドシート内のシートの位置を取得します。
getLastColumn()Integerコンテンツが含まれている最後の列の位置を返します。
getLastRow()Integerコンテンツが含まれている最後の行の位置を返します。
getMaxColumns()Integer内容にかかわらず、シート内の現在の列数を返します。
getMaxRows()Integer内容にかかわらず、シート内の現在の行数を返します。
getName()Stringシートの名前を返します。
getNamedRanges()NamedRange[]このシート内の名前付きすべての範囲を取得します。
getParent()Spreadsheetこのシートを含む Spreadsheet を返します。
getPivotTables()PivotTable[]このシートのすべてのピボット テーブルを返します。
getProtections(type)Protection[]シート内のすべての保護されている範囲を表すオブジェクトの配列、またはシート自体の保護を表す単一要素の配列を取得します。
getRange(row, column)Range指定された座標の左上のセルを含む範囲を返します。
getRange(row, column, numRows)Range指定された座標の左上セル、および指定した行数で範囲を返します。
getRange(row, column, numRows, numColumns)Range特定の座標と、指定された行数と列数の左上のセルを含む範囲を返します。
getRange(a1Notation)RangeA1 表記または R1C1 表記で指定された範囲を返します。
getRangeList(a1Notations)RangeListA1 表記または R1C1 表記の空ではないリストで指定された、同じシート内の範囲を表す RangeList コレクションを返します。
getRowGroup(rowIndex, groupDepth)Group指定されたインデックスとグループの深度にある行グループを返します。
getRowGroupControlPosition()GroupControlTogglePositionシート内のすべての行グループの GroupControlTogglePosition を返します。
getRowGroupDepth(rowIndex)Integer指定されたインデックスにおける行のグループ深度を返します。
getRowHeight(rowPosition)Integer指定された行の高さをピクセル単位で取得します。
getSelection()Selectionスプレッドシートの現在の Selection を返します。
getSheetId()Integerこのオブジェクトで表されるシートの ID を返します。
getSheetName()Stringシート名を返します。
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]指定された座標から始まる、この範囲の値の長方形のグリッドを返します。
getSlicers()Slicer[]シート上のスライサーの配列を返します。
getTabColorObject()Colorシートタブの色を取得します。シートタブに色がない場合は null を取得します。
getType()SheetTypeシートのタイプを返します。
hasHiddenGridlines()Booleanシートのグリッド線が非表示の場合は true を返し、それ以外の場合は false を返します。
hideColumn(column)void指定した範囲内の列を非表示にする。
hideColumns(columnIndex)void指定されたインデックスの単一の列を非表示にします。
hideColumns(columnIndex, numColumns)void指定されたインデックスで始まる 1 つ以上の連続した列を非表示にします。
hideRow(row)void指定した範囲の行を非表示にします。
hideRows(rowIndex)void指定されたインデックスの行を非表示にします。
hideRows(rowIndex, numRows)void指定されたインデックスで始まる 1 つ以上の連続した行を非表示にします。
hideSheet()Sheetこのシートを非表示にします。
insertChart(chart)voidこのシートに新しいグラフを追加します。
insertColumnAfter(afterPosition)Sheet指定した列の位置の後に、列を挿入します。
insertColumnBefore(beforePosition)Sheet列の位置の前に列を挿入します。
insertColumns(columnIndex)voidスプレッドシートの指定された位置に空白の列を挿入します。
insertColumns(columnIndex, numColumns)voidスプレッドシート内の指定した位置から始まる空白の列(複数可)を連続して挿入します。
insertColumnsAfter(afterPosition, howMany)Sheet指定した列の位置の後に、指定した数の列を挿入します。
insertColumnsBefore(beforePosition, howMany)Sheet指定した列の位置の前に、複数の列を挿入します。
insertImage(blobSource, column, row)OverGridImageドキュメント内の特定の行と列に BlobSource を画像として挿入します。
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageドキュメント内の特定の行と列に画像として BlobSource を挿入し、ピクセル オフセットを設定します。
insertImage(url, column, row)OverGridImageドキュメント内の特定の行と列に画像を挿入します。
insertImage(url, column, row, offsetX, offsetY)OverGridImageドキュメント内の、特定の行と列の位置にピクセル オフセットの画像を挿入します。
insertRowAfter(afterPosition)Sheet指定した行の位置に行を挿入します。
insertRowBefore(beforePosition)Sheet指定した行の位置より前に行を挿入します。
insertRows(rowIndex)voidスプレッドシートの指定された位置に空白行を挿入します。
insertRows(rowIndex, numRows)voidスプレッドシート内の指定した位置から始まる空白行を 1 つ以上連続して挿入します。
insertRowsAfter(afterPosition, howMany)Sheet指定した行の位置の後に、行数を挿入します。
insertRowsBefore(beforePosition, howMany)Sheet指定した行の位置の前に行数を挿入します。
insertSlicer(range, anchorRowPos, anchorColPos)Slicerこのシートに新しいスライサーを追加します。
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)Slicerこのシートに新しいスライサーを追加します。
isColumnHiddenByUser(columnPosition)Boolean指定された列がユーザーによって非表示になっているかどうかを返します。
isRightToLeft()Booleanこのシート レイアウトが右から左である場合、true を返します。
isRowHiddenByFilter(rowPosition)Boolean指定した行がフィルタ ビューではなくフィルタで非表示かどうかを返します。
isRowHiddenByUser(rowPosition)Boolean指定された行がユーザーによって非表示になっているかどうかを返します。
isSheetHidden()Booleanシートが現在非表示の場合は true を返します。
moveColumns(columnSpec, destinationIndex)void指定された範囲で選択された列を destinationIndex で示された位置に移動します。
moveRows(rowSpec, destinationIndex)void指定した範囲で選択された行を、destinationIndex で指定された位置に移動します。
newChart()EmbeddedChartBuilderこのシートの新しいグラフを作成するためのビルダーを返します。
protect()Protection権限を持つユーザーのみがシートを編集できないように保護するオブジェクトを作成します。
removeChart(chart)void親シートからグラフを削除します。
setActiveRange(range)Rangeアクティブ シート内の指定された範囲を active range として設定し、範囲内の左上のセルを current cell として設定します。
setActiveRangeList(rangeList)RangeListアクティブ シート内の指定された範囲のリストを active ranges として設定します。
setActiveSelection(range)Rangeこのシートの有効な選択領域を設定します。
setActiveSelection(a1Notation)RangeA1 表記または R1C1 表記で指定されているとおりに、有効な選択を設定します。
setColumnGroupControlPosition(position)Sheetシートの列コントロール コントロールの位置を設定します。
setColumnWidth(columnPosition, width)Sheet指定した列の幅をピクセル単位で設定します。
setColumnWidths(startColumn, numColumns, width)Sheet指定した列の幅をピクセル単位で設定します。
setConditionalFormatRules(rules)voidシートにある既存の条件付き書式ルールをすべて入力ルールに置き換えます。
setCurrentCell(cell)Range指定したセルを current cell に設定します。
setFrozenColumns(columns)void指定された列数をフリーズします。
setFrozenRows(rows)void指定した数の行をフリーズします。
setHiddenGridlines(hideGridlines)Sheetシートのグリッド線の表示と非表示を切り替えます。
setName(name)Sheetシート名を設定します。
setRightToLeft(rightToLeft)Sheetシート レイアウトを右から左に設定または設定解除します。
setRowGroupControlPosition(position)Sheetシートの行コントロール コントロールの位置を設定します。
setRowHeight(rowPosition, height)Sheet特定の行の行の高さをピクセル単位で設定します。
setRowHeights(startRow, numRows, height)Sheet指定した行の高さをピクセル単位で設定します。
setRowHeightsForced(startRow, numRows, height)Sheet指定した行の高さをピクセル単位で設定します。
setTabColor(color)Sheetシートのタブの色を設定します。
setTabColorObject(color)Sheetシートのタブの色を設定します。
showColumns(columnIndex)void指定したインデックスの列を再表示します。
showColumns(columnIndex, numColumns)void指定したインデックスで始まる 1 つ以上の連続した列を再表示します。
showRows(rowIndex)void指定したインデックスの行を再表示します。
showRows(rowIndex, numRows)void指定したインデックスから始まる 1 つ以上の連続した行を再表示します。
showSheet()Sheetスプレッドシートを表示します。
sort(columnPosition)Sheetシートを昇順で並べ替えます。
sort(columnPosition, ascending)Sheet列ごとにシートを並べ替えます。
unhideColumn(column)void指定した範囲内の列を再表示します。
unhideRow(row)void指定した範囲の行を再表示します。
updateChart(chart)voidこのシートのグラフを更新します。

詳細なドキュメント

activate()

このシートを有効にします。シート自体は変更されず、アクティブなシートの親の概念のみが変更される。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.activate();

戻る

Sheet - 新しくアクティブになったシート。


addDeveloperMetadata(key)

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

パラメータ

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

戻る

Sheet - チェーン用のシート。

認可

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

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

addDeveloperMetadata(key, visibility)

指定したキーと公開設定を持つデベロッパー メタデータをシートに追加します。

パラメータ

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

戻る

Sheet - チェーン用のシート。

認可

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

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

addDeveloperMetadata(key, value)

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

パラメータ

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

戻る

Sheet - チェーン用のシート。

認可

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

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

addDeveloperMetadata(key, value, visibility)

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

パラメータ

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

戻る

Sheet - チェーン用のシート。

認可

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

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

appendRow(rowContents)

現在のデータ領域の一番下に行をシートに追加します。

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

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

パラメータ

名前説明
rowContentsObject[]シートの最後の行の後に挿入する値の配列。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

asDataSourceSheet()

シートタイプが SheetType.DATASOURCE の場合は DataSourceSheet として、それ以外の場合は null を返します。

戻る

DataSourceSheet - データソース シート。

認可

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

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

autoResizeColumn(columnPosition)

列が収まるように、列の幅を設定します。

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

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

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

パラメータ

名前説明
columnPositionIntegerサイズを変更する特定の列の位置。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

autoResizeColumns(startColumn, numColumns)

内容に合わせて、指定された列位置から始まるすべての列の幅を設定します。

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

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

パラメータ

名前説明
startColumnInteger自動サイズ変更の基準列。
numColumnsInteger自動サイズ変更する列の数。

戻る

Sheet - チェーン用のシート。

認可

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

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

autoResizeRows(startRow, numRows)

コンテンツの位置に合わせて、指定した行の位置から始まるすべての行の高さを設定します。

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

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

パラメータ

名前説明
startRowInteger自動サイズ変更の基準となる行。
numRowsInteger自動サイズ変更する行数。

戻る

Sheet - チェーン用のシート。

認可

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

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

clear()

コンテンツとシートの情報を削除します。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clear();

戻る

Sheet - クリアされたシート。

認可

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

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

clear(options)

指定された詳細オプションで指定されたとおりに、コンテンツ シートやフォーマットをクリアします。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.clear({ formatOnly: true, contentsOnly: true });

パラメータ

名前説明
optionsObject詳細オプションを含む JavaScript マップを以下に示します。

拡張パラメータ

名前説明
contentsOnlyBooleanコンテンツを削除するかどうか。
formatOnlyBoolean形式をクリアするかどうか。

戻る

Sheet - チェーン用のシート。

認可

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

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

clearConditionalFormatRules()

シートからすべての条件付き書式ルールを削除します。空の配列を入力として setConditionalFormatRules(rules) を呼び出した場合と同じです。

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

認可

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

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

clearContents()

フォーマット情報を維持しながら、コンテンツのシートをクリアします。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearContents();

戻る

Sheet - チェーン用のシート。

認可

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

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

clearFormats()

フォーマットを維持したまま、シートの内容をクリアします。

書式設定とは、セルの幅と高さではなく、「書式設定」メニュー(太字、斜体、条件付き書式など)で選択可能な方法でデータをフォーマットすることを意味します。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearFormats();

戻る

Sheet - チェーン用のシート。

認可

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

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

clearNotes()

すべてのメモのシートをクリアします。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearNotes();

戻る

Sheet - チェーン用のシート。

認可

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

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

collapseAllColumnGroups()

シート上のすべての列グループを折りたたみます。

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

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

戻る

Sheet - チェーン用のシート。

認可

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

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

collapseAllRowGroups()

シート内のすべての行グループを折りたたみます。

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

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

戻る

Sheet - チェーン用のシート。

認可

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

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

copyTo(spreadsheet)

スプレッドシートを特定のスプレッドシートにコピーします。このスプレッドシートは、ソースと同じスプレッドシートにすることができます。コピーしたシートの名前は「[元の名前] のコピー」です。

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

var destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

パラメータ

名前説明
spreadsheetSpreadsheetこのシートのコピー先のスプレッドシート。元のスプレッドシートと同じでもかまいません。

戻る

Sheet - チェーン用の新しいシート。

認可

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

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

createDeveloperMetadataFinder()

このシートの範囲内でデベロッパー メタデータを検出するための DeveloperMetadataFinder を返します。メタデータは、シート自体に関連付けられているか、シートの行、列、範囲に関連付けられている場合、特定のシートの範囲に含まれます。

戻る

DeveloperMetadataFinder - このシートの範囲でメタデータを検索するためのデベロッパー メタデータの検索。


createTextFinder(findText)

シート内のテキストを検索して置き換えることができるテキスト ファインダーを作成します。

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

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

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

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

パラメータ

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

戻る

TextFinder - シートの TextFinder


deleteColumn(columnPosition)

指定された列位置の列を削除します。

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

パラメータ

名前説明
columnPositionInteger列の位置(最初の列は 1 から開始)。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

deleteColumns(columnPosition, howMany)

指定された列位置から始まるいくつかの列を削除します。

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

パラメータ

名前説明
columnPositionInteger削除する最初の列の位置。
howManyInteger削除する列の数。

認可

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

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

deleteRow(rowPosition)

指定した行の位置にある行を削除します。

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

パラメータ

名前説明
rowPositionInteger行の位置。最初の行は 1 から始まります。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

deleteRows(rowPosition, howMany)

指定した行の位置にある行数を削除します。

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

パラメータ

名前説明
rowPositionInteger削除する最初の行の位置。
howManyInteger削除する行数。

認可

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

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

expandAllColumnGroups()

シート内のすべての列グループを展開します。このメソッドには、少なくとも 1 つの列グループが必要です。

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

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

戻る

Sheet - チェーン用のシート。

認可

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

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

expandAllRowGroups()

シート内のすべての行グループを展開します。このメソッドには、少なくとも 1 つの行グループが必要です。

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

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

戻る

Sheet - チェーン用のシート。

認可

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

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

expandColumnGroupsUpToDepth(groupDepth)

指定した深度まですべての列グループを展開し、他のグループはすべて折りたたまれます。

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

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

パラメータ

名前説明
groupDepthInteger列グループの展開先となるグループの深さ。

戻る

Sheet - チェーン用のシート。

認可

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

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

expandRowGroupsUpToDepth(groupDepth)

指定した深度まですべての行グループを拡張し、他の行グループはすべて折りたたむ。

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

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

パラメータ

名前説明
groupDepthInteger行グループを開くためのグループ深度。

戻る

Sheet - チェーン用のシート。

認可

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

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

getActiveCell()

このシート内のアクティブなセルを返します。

注: 現在ハイライト表示されているセルを返す getCurrentCell() を使用することをおすすめします。

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

戻る

Range - 現在アクティブなセル

認可

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

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

getActiveRange()

アクティブ シート内の選択された範囲を返します。アクティブな範囲がない場合は null を返します。複数の範囲が選択されている場合、このメソッドは最後に選択した範囲のみを返します。

「アクティブ範囲」という用語は、アクティブ シートでユーザーが選択した範囲を指しますが、カスタム関数ではアクティブに再計算されるセルを指します。

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

戻る

Range - アクティブ範囲

認可

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

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

関連ドキュメント


getActiveRangeList()

アクティブ シート内のアクティブな範囲のリストを返します。アクティブな範囲がない場合は null を返します。

単一の範囲が選択されている場合、これは getActiveRange() 呼び出しと同様に動作します。

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

戻る

RangeList - アクティブ範囲のリスト

認可

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

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

関連ドキュメント


getBandings()

このシートのすべてのバンディングを返します。

戻る

Banding[] - このシートのすべての縞。

認可

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

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

getCharts()

このシート上のグラフの配列を返します。

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

for (var i in charts) {
  var chart = charts[i];
  // Do something with the chart
}

戻る

EmbeddedChart[] - グラフの配列。

認可

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

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

getColumnGroup(columnIndex, groupDepth)

指定されたインデックスとグループの深さで列グループを返します。

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

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
var columnGroup = sheet.getColumnGroup(2, 1);

パラメータ

名前説明
columnIndexIntegerグループ コントロールの切り替え列、またはグループ内のインデックス。
groupDepthIntegerグループの階層の深さ。

戻る

Group - コントロール インデックスと深度の列グループ。グループが存在しない場合は例外をスローします。

認可

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

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

getColumnGroupControlPosition()

シート内のすべての列グループの GroupControlTogglePosition を返します。

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

// GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the
// group.
var columnGroupControlPosition = sheet.getColumnGroupControlPosition();

戻る

GroupControlTogglePosition - このグループのグループの後に列グループ化コントロールの切り替えを表示する場合は true、それ以外の場合は false

認可

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

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

getColumnGroupDepth(columnIndex)

指定されたインデックスで列のグループ深度を返します。

グループの深さは、列と重複するグループの数を示します。範囲は 0 ~ 8 です。

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

// 1 if there is a group over columns 1 through 3
var groupDepth = sheet.getColumnGroupDepth(1);

パラメータ

名前説明
columnIndexInteger列のインデックス。

戻る

Integer - 特定のインデックスで列のグループの深さ。

認可

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

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

getColumnWidth(columnPosition)

指定された列の幅(ピクセル単位)を取得します。

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

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

パラメータ

名前説明
columnPositionInteger検証する列の位置。

戻る

Integer - 列の幅(ピクセル単位)

認可

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

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

getConditionalFormatRules()

このシートのすべての条件付き書式ルールを取得します。

// Logs the conditional format rules in a sheet.
var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (var i = 0; i < rules.length; i++) {
  var rule = rules[i];
  Logger.log(rule);
}

戻る

ConditionalFormatRule[] - シート内のすべてのルールの配列。

認可

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

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

getCurrentCell()

アクティブなシート内の現在のセル、または現在のセルがない場合は null を返します。現在のセルは、Google スプレッドシートの UI にフォーカスのあるセルで、暗い枠線でハイライト表示されています。現在のセルが複数存在することはありません。ユーザーが 1 つ以上のセル範囲を選択すると、現在のセルが選択範囲の 1 つのセルになります。

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

戻る

Range - 現在のセル

認可

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

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

getDataRange()

データが存在するディメンションに対応する Range を返します。

これは、A1 と(Sheet.getLastColumn()、Sheet.getLastRow())で制限された範囲を作成するのと機能的に同等です。

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

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

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

戻る

Range - スプレッドシート内のすべてのデータで構成される範囲

認可

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

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

getDataSourceFormulas()

すべてのデータソースの数式を取得します。

戻る

DataSourceFormula[] - データソースの数式のリスト。

認可

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

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

getDataSourcePivotTables()

すべてのデータソースのピボット テーブルを取得します。

戻る

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

認可

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

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

getDataSourceTables()

すべてのデータソース テーブルを取得します。

戻る

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

認可

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

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

getDeveloperMetadata()

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

戻る

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

認可

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

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

getDrawings()

シート上の図形描画の配列を返します。

戻る

Drawing[] - このシート上の図形描画のリスト。

認可

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

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

getFilter()

このシートのフィルタを返します。フィルタがない場合は null を返します。

// Gets the filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();

戻る

Filter - フィルタ。

認可

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

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

getFormUrl()

このシートに回答を送信するフォームの URL を返します。シートに関連フォームがない場合は null を返します。

var sheet = SpreadsheetApp.getActiveSheet();
var url = sheet.getFormUrl();

戻る

String - このスプレッドシートに回答を保存するフォームの URL。null にフォームが関連付けられている場合は null

認可

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

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

getFrozenColumns()

固定された列の数を返します。

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

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

戻る

Integer - 固定列の数

認可

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

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

getFrozenRows()

固定された行の数を返します。

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

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

戻る

Integer - 固定行の数

認可

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

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

getImages()

シート上のすべてのグリッド上の画像を返します。

戻る

OverGridImage[] - グリッド上の画像の配列。

認可

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

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

getIndex()

親スプレッドシート内のシートの位置を取得します。1

var ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
var sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

戻る

Integer - 親スプレッドシート内のシートの位置。

認可

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

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

getLastColumn()

コンテンツが含まれている最後の列の位置を返します。

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

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

戻る

Integer - コンテンツが含まれているシートの最後の列

認可

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

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

getLastRow()

コンテンツが含まれている最後の行の位置を返します。

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

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

戻る

Integer - コンテンツが含まれているシートの最後の行

認可

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

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

getMaxColumns()

内容にかかわらず、シート内の現在の列数を返します。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxColumns());

戻る

Integer - シートの最大幅。

認可

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

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

getMaxRows()

内容にかかわらず、シート内の現在の行数を返します。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxRows());

戻る

Integer - シートの最大高さ。

認可

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

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

getName()

シートの名前を返します。

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

戻る

String - シートの名前。

認可

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

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

getNamedRanges()

このシート内の名前付きすべての範囲を取得します。

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

戻る

NamedRange[] - シート内のすべての名前付き範囲の配列。

認可

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

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

getParent()

このシートを含む Spreadsheet を返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// parent is identical to ss
var parent = sheet.getParent();

戻る

Spreadsheet - 親スプレッドシート。

認可

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

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

getPivotTables()

このシートのすべてのピボット テーブルを返します。

戻る

PivotTable[] - このシートのピボット テーブル。

認可

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

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

getProtections(type)

シート内のすべての保護されている範囲を表すオブジェクトの配列、またはシート自体の保護を表す単一要素の配列を取得します。

// Remove all range protections in the spreadsheet that the user has permission to edit.
var sheet = SpreadsheetApp.getActiveSheet();
var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove sheet protection from the active sheet, if the user has permission to edit it.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection && protection.canEdit()) {
  protection.remove();
}

パラメータ

名前説明
typeProtectionType保護エリアの種類(SpreadsheetApp.ProtectionType.RANGE または SpreadsheetApp.ProtectionType.SHEET)。

戻る

Protection[] - シート内のすべての保護されている範囲を表すオブジェクトの配列、またはシート自体の保護を表す単一要素の配列。

認可

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

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

getRange(row, column)

指定された座標の左上のセルを含む範囲を返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
var range = sheet.getRange(1, 1);
var values = range.getValues();
Logger.log(values[0][0]);

パラメータ

名前説明
rowInteger返されるセルの行インデックス。行のインデックスは 1 から始まります。
columnInteger返されるセルの列インデックス。列のインデックスは 1 から始まります。

戻る

Range - このセルのみを含む範囲です。

認可

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

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

getRange(row, column, numRows)

指定された座標の左上にあるセルと行数を指定して範囲を返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is returned.
var range = sheet.getRange(1, 1, 3);
var values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

パラメータ

名前説明
rowInteger範囲の開始行インデックス。行のインデックス登録は 1 から始まります。
columnInteger範囲の列インデックス。列のインデックス登録は 1 から始まります。
numRowsInteger返される行数。

戻る

Range - 行数が指定された 1 列のデータが含まれる範囲。

認可

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

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

getRange(row, column, numRows, numColumns)

特定の座標と、指定された行数と列数の左上のセルを含む範囲を返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 3, 3);
var values = range.getValues();

// Print values from a 3x3 box.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

パラメータ

名前説明
rowInteger範囲の開始行インデックス。行のインデックス登録は 1 から始まります。
columnInteger範囲の開始列のインデックス。列のインデックス登録は 1 から始まります。
numRowsInteger返される行数。
numColumnsInteger返される列の数。

戻る

Range - 指定したエリアに対応する範囲。

認可

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

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

getRange(a1Notation)

A1 表記または R1C1 表記で指定された範囲を返します。

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

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

パラメータ

名前説明
a1NotationString返される範囲。A1 表記または R1C1 表記で指定します。

戻る

Range - 指定したロケーションの範囲。

認可

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

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

getRangeList(a1Notations)

A1 表記または R1C1 表記の空でないリストで指定された、同じシート内の範囲を表す RangeList コレクションを返します。

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

パラメータ

名前説明
a1NotationsString[]返される範囲のリスト。A1 表記または R1C1 表記で指定します。

戻る

RangeList - 指定した位置にある範囲リスト

認可

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

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

getRowGroup(rowIndex, groupDepth)

指定されたインデックスとグループの深度にある行グループを返します。

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

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
var rowGroup = sheet.getRowGroup(2, 1);

パラメータ

名前説明
rowIndexIntegerグループ コントロールの切り替え行、またはグループ内のインデックス。
groupDepthIntegerグループの階層の深さ。

戻る

Group - コントロール インデックスと深度にある行グループ。グループが存在しない場合は例外をスローします。

認可

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

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

getRowGroupControlPosition()

シート内のすべての行グループの GroupControlTogglePosition を返します。

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

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the
// group.
var rowGroupControlPosition = sheet.getRowGroupControlPosition();

戻る

GroupControlTogglePosition - このグループのグループの後に行グループ化コントロールの切り替えを表示する場合は true、それ以外の場合は false

認可

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

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

getRowGroupDepth(rowIndex)

指定されたインデックスにおける行のグループ深度を返します。

グループの深さは、行と重なるグループの数を示します。範囲は 0 ~ 8 です。

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

// 1 if there is a group over rows 1 through 3
var groupDepth = sheet.getRowGroupDepth(1);

パラメータ

名前説明
rowIndexInteger行のインデックス。

戻る

Integer - 指定されたインデックスにおける行のグループ深度。

認可

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

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

getRowHeight(rowPosition)

指定された行の高さをピクセル単位で取得します。

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

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

パラメータ

名前説明
rowPositionInteger検証する行の位置。

戻る

Integer - 行の高さ(ピクセル単位)

認可

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

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

getSelection()

スプレッドシート内の現在の Selection を返します。

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

戻る

Selection - 現在の選択

認可

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

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

getSheetId()

このオブジェクトで表されるシートの ID を返します。

スプレッドシートに固有のシートの ID です。ID は単調増加する整数で、シートの作成時に割り当てられ、シートの位置には依存しません。これは、Sheet インスタンスではなく gridId パラメータを受け取る Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) などのメソッドと組み合わせると便利です。

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

Logger.log(sheet.getSheetId());

戻る

Integer - スプレッドシートに固有のシートの ID

認可

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

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

getSheetName()

シート名を返します。

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

Logger.log(sheet.getSheetName());

戻る

String - シートの名前

認可

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

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

getSheetValues(startRow, startColumn, numRows, numColumns)

指定された座標から始まる、この範囲の値の長方形のグリッドを返します。行または列の位置として指定された -1 値は、シート内にデータが含まれている最後の行または列を取得することと同じになります。

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

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

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

パラメータ

名前説明
startRowInteger開始行の位置。
startColumnInteger開始列の位置。
numRowsInteger値を返す行数。
numColumnsInteger値を返す列の数。

戻る

Object[][] - 2 次元の値の配列

認可

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

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

getSlicers()

シート上のスライサーの配列を返します。

戻る

Slicer[] - このシート上のスライサーのリスト。

認可

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

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

getTabColorObject()

シートタブの色を取得します。シートタブに色がない場合は null を取得します。

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = first.getTabColorObject();

戻る

Color - シートタブの色。シートタブに色がない場合は null です。

認可

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

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

getType()

シートのタイプを返します。

デフォルトのシートタイプは SheetType.GRID です。EmbeddedChart などの単一の埋め込みオブジェクトを含むシートは、SheetType.OBJECT シートです。

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

戻る

SheetType - シートのタイプ。

認可

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

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

hasHiddenGridlines()

シートのグリッド線が非表示の場合は true を返し、それ以外の場合は false を返します。 グリッド線はデフォルトで表示されます。

戻る

Boolean - グリッド線が表示されていない場合は、true(それ以外の場合は false)。

認可

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

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

hideColumn(column)

指定した範囲内の列を非表示にします。

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

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

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

パラメータ

名前説明
columnRange非表示にする列の範囲を指定します。

認可

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

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

hideColumns(columnIndex)

指定されたインデックスの単一の列を非表示にします。この方法では 1 インデックスを使用します。

インデックスを使用して複数の列を非表示にするには、hideColumns(columnIndex, numColumns) を使用します。

範囲を使用して複数の列を非表示にするには、hideColumn() を使用します。

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

パラメータ

名前説明
columnIndexInteger非表示にする列のインデックス。

認可

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

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

hideColumns(columnIndex, numColumns)

指定されたインデックスで始まる 1 つ以上の連続した列を非表示にします。この方法では 1 インデックスを使用します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

パラメータ

名前説明
columnIndexInteger非表示にする列の開始インデックス。
numColumnsInteger非表示にする列の数。

認可

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

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

hideRow(row)

指定した範囲の行を非表示にします。

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

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

パラメータ

名前説明
rowRange非表示にする行の範囲を指定します。

認可

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

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

hideRows(rowIndex)

指定されたインデックスの行を非表示にします。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

パラメータ

名前説明
rowIndexInteger非表示にする行のインデックス。

認可

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

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

hideRows(rowIndex, numRows)

指定されたインデックスで始まる 1 つ以上の連続した行を非表示にします。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

パラメータ

名前説明
rowIndexInteger非表示にする行の開始インデックス。
numRowsInteger非表示にする行数。

認可

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

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

hideSheet()

このシートを非表示にします。シートがすでに非表示になっている場合、影響はありません。表示されている唯一のシートでこのメソッドを呼び出すと、例外がスローされます。

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

戻る

Sheet - 現在のシート。

認可

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

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

insertChart(chart)

このシートに新しいグラフを追加します。

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B4"))
    .setPosition(5, 5, 0, 0)
    .setOption("title", "Dynamic Chart")
    .build();
sheet.insertChart(chart);

パラメータ

名前説明
chartEmbeddedChart挿入するグラフ。

認可

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

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

insertColumnAfter(afterPosition)

指定された列位置の後に列を挿入します。

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

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

パラメータ

名前説明
afterPositionInteger新しい列を追加する列。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

insertColumnBefore(beforePosition)

指定された列位置の前に列を挿入します。

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

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

パラメータ

名前説明
beforePositionInteger新しい列を追加する前の列。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

insertColumns(columnIndex)

スプレッドシートの指定された場所に空白の列を挿入します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

パラメータ

名前説明
columnIndexInteger列を挿入する場所を示すインデックス。

認可

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

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

insertColumns(columnIndex, numColumns)

スプレッドシートに空白の列を連続して 1 つ以上挿入します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

パラメータ

名前説明
columnIndexInteger列を挿入する場所を示すインデックス。
numColumnsInteger挿入する列の数。

認可

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

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

insertColumnsAfter(afterPosition, howMany)

指定した列の位置の後に、指定した数の列を挿入します。

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

パラメータ

名前説明
afterPositionInteger新しい列を追加する列。
howManyInteger挿入する列の数。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

insertColumnsBefore(beforePosition, howMany)

指定した列の位置の前に、複数の列を挿入します。

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

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

パラメータ

名前説明
beforePositionInteger新しい列を追加する前の列。
howManyInteger挿入する列の数。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

insertImage(blobSource, column, row)

ドキュメント内の特定の行と列に BlobSource を画像として挿入します。画像サイズは blob のコンテンツから取得されます。blob の最大サイズは 2 MB です。

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

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

パラメータ

名前説明
blobSourceBlobSource画像コンテンツ、MIME タイプ、名前(オプション)を含む blob。
columnInteger列の位置。
rowInteger行の位置。

戻る

OverGridImage - 挿入された画像。

認可

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

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

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

ドキュメント内の特定の行と列に画像として BlobSource を挿入し、ピクセル オフセットを設定します。画像サイズは blob のコンテンツから取得されます。blob の最大サイズは 2 MB です。

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

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

パラメータ

名前説明
blobSourceBlobSource画像コンテンツ、MIME タイプ、名前(オプション)を含む blob。
columnInteger列の位置。
rowInteger行の位置。
offsetXIntegerセルの角からの水平オフセット(ピクセル単位)。
offsetYIntegerセルの角からの垂直オフセット(ピクセル単位)。

戻る

OverGridImage - 挿入された画像。

認可

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

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

insertImage(url, column, row)

ドキュメント内の特定の行と列に画像を挿入します。

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

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

パラメータ

名前説明
urlString画像の URL です。
columnIntegerグリッド列の位置。
rowIntegerグリッドの行の位置。

戻る

OverGridImage - 挿入された画像。

認可

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

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

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

ドキュメント内の、特定の行と列の位置にピクセル オフセットの画像を挿入します。

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

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

パラメータ

名前説明
urlString画像の URL。
columnInteger列の位置。
rowInteger行の位置。
offsetXIntegerセルの角からの水平オフセット(ピクセル単位)。
offsetYIntegerセルの角からの垂直オフセット(ピクセル単位)。

戻る

OverGridImage - 挿入された画像。

認可

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

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

insertRowAfter(afterPosition)

指定した行の位置の後に行を挿入します。

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

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

パラメータ

名前説明
afterPositionIntegerその後ろに新しい行を追加します。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

insertRowBefore(beforePosition)

指定した行の位置より前に行を挿入します。

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

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

パラメータ

名前説明
beforePositionInteger新しい行を追加する前の行。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

insertRows(rowIndex)

スプレッドシートの指定された位置に空白行を挿入します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

パラメータ

名前説明
rowIndexInteger行の挿入場所を示すインデックス。

認可

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

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

insertRows(rowIndex, numRows)

スプレッドシート内の指定した位置から始まる空白行を 1 つ以上連続して挿入します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

パラメータ

名前説明
rowIndexInteger行の挿入場所を示すインデックス。
numRowsInteger挿入する行数。

認可

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

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

insertRowsAfter(afterPosition, howMany)

指定した行の位置の後に、行数を挿入します。

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

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

パラメータ

名前説明
afterPositionIntegerその後ろに新しい行を追加します。
howManyInteger挿入する行数。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

insertRowsBefore(beforePosition, howMany)

指定した行の位置の前に行数を挿入します。

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

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

パラメータ

名前説明
beforePositionInteger新しい行を追加する前の行。
howManyInteger挿入する行数。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

insertSlicer(range, anchorRowPos, anchorColPos)

このシートに新しいスライサーを追加します。

パラメータ

名前説明
rangeRangeスライサー スライサーが作成される範囲。
anchorRowPosIntegerスライサーの上側がこの行に固定されています。
anchorColPosIntegerスライサーの上側は、この列に固定されています。

戻る

Slicer - 新しく挿入されたスライサー。

認可

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

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

insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)

このシートに新しいスライサーを追加します。

パラメータ

名前説明
rangeRangeスライサー スライサーが作成される範囲。
anchorRowPosIntegerスライサーの上側がこの行に固定されています。
anchorColPosIntegerスライサーの上側は、この列に固定されています。
offsetXIntegerセルの角からの水平オフセット(ピクセル単位)。
offsetYIntegerセルの角からの垂直オフセット(ピクセル単位)。

戻る

Slicer - 新しく挿入されたスライサー。

認可

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

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

isColumnHiddenByUser(columnPosition)

指定された列がユーザーによって非表示になっているかどうかを返します。

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

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

パラメータ

名前説明
columnPositionInteger検証する列の位置。

戻る

Boolean - 列が非表示の場合は true、それ以外の場合は false になります。

認可

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

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

isRightToLeft()

このシート レイアウトが右から左である場合、true を返します。シートがデフォルトの左から右へのレイアウトを使用している場合、false を返します。

戻る

Boolean — 右から左(true)の場合、false

認可

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

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

isRowHiddenByFilter(rowPosition)

指定した行がフィルタ ビューではなくフィルタで非表示かどうかを返します。

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

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

パラメータ

名前説明
rowPositionInteger検証する行の位置。

戻る

Boolean - 行が非表示の場合は true、それ以外の場合は false になります。

認可

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

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

isRowHiddenByUser(rowPosition)

指定された行がユーザーによって非表示になっているかどうかを返します。

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

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

パラメータ

名前説明
rowPositionInteger検証する行の位置。

戻る

Boolean - 行が非表示の場合は true、それ以外の場合は false になります。

認可

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

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

isSheetHidden()

シートが現在非表示の場合、true を返します。

var sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

戻る

Boolean - シートが非表示の場合は true、それ以外の場合は false です。

認可

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

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

moveColumns(columnSpec, destinationIndex)

指定された範囲で選択された列を destinationIndex で示された位置に移動します。columnSpec 自体は、移動する列全体または列のグループを正確に表す必要はありません。範囲にまたがるすべての列を選択します。

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
var columnSpec = sheet.getRange("A1:B1");
sheet.moveColumns(columnSpec, 5);

パラメータ

名前説明
columnSpecRange移動する列にまたがる範囲。
destinationIndexInteger列の移動先のインデックス。このインデックスは、列が移動する前の座標に基づいています。既存の列は、シフトされた列のためにスペースを確保するために右にシフトされ、ソース列はグリッドから削除されます。そのため、データは当初指定されていたインデックスとは異なるインデックスになる可能性があります。

認可

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

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

moveRows(rowSpec, destinationIndex)

指定した範囲で選択された行を、destinationIndex で指定された位置に移動します。rowSpec 自体は、移動する行全体または行のグループを正確に表す必要はありません。範囲にまたがるすべての行を選択します。

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
var rowSpec = sheet.getRange("A1:A2");
sheet.moveRows(rowSpec, 5);

パラメータ

名前説明
rowSpecRange移動する行にまたがる範囲。
destinationIndexInteger行の移動先のインデックス。このインデックスは、行が移動される前の座標に基づいています。ソースデータがグリッドから削除される間、移動された行のスペースを確保するために既存のデータがシフトダウンされます。したがって、データは当初指定されていたものとは異なるインデックスになる可能性があります。

認可

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

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

newChart()

このシートの新しいグラフを作成するためのビルダーを返します。

次の例は、新しいグラフの作成方法を示しています。

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

戻る

EmbeddedChartBuilder - 新しいグラフを作成するためのビルダー。


protect()

権限を持つユーザーのみがシートを編集できないように保護するオブジェクトを作成します。スクリプトが実際にシートの編集者のリストを変更するまで(Protection.removeEditor(emailAddress)Protection.removeEditor(user)Protection.removeEditors(emailAddresses)Protection.addEditor(emailAddress)Protection.addEditor(user)Protection.addEditors(emailAddresses) を呼び出すか、Protection.setDomainEdit(editable) に新しい値を設定するまで)、権限はスプレッドシート自体の権限をミラーリングします。つまり、実質的にシートは保護されていません。シートがすでに保護されている場合、このメソッドは既存の保護設定を表すオブジェクトを返します。 保護されているシートには、保護されていない領域が含まれている場合があります。

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect().setDescription('Sample protected sheet');

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

removeChart(chart)

親シートからグラフを削除します。

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

// This removes all the embedded charts from the spreadsheet
var charts = sheet.getCharts();
for (var i in charts) {
  sheet.removeChart(charts[i]);
}

パラメータ

名前説明
chartEmbeddedChart削除するグラフ。

認可

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

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

setActiveRange(range)

アクティブ シート内の指定された範囲を active range として設定し、範囲内の左上のセルを current cell として設定します。

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

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

パラメータ

名前説明
rangeRangeアクティブ範囲として設定する範囲。

戻る

Range - 新しくアクティブになった範囲

認可

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

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

setActiveRangeList(rangeList)

アクティブ シート内の指定された範囲のリストを active ranges として設定します。リストの最後の範囲は active range として設定されます。

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

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

パラメータ

名前説明
rangeListRangeList選択する範囲のリスト。

戻る

RangeList - 新しく選択された範囲のリスト

認可

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

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

setActiveSelection(range)

このシートの有効な選択領域を設定します。

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

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

パラメータ

名前説明
rangeRange有効な選択範囲として設定する範囲を指定します。

戻る

Range - 新しくアクティブになった範囲

認可

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

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

setActiveSelection(a1Notation)

A1 表記または R1C1 表記で指定されているとおりに、有効な選択を設定します。

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

sheet.setActiveSelection("A1:D4");

パラメータ

名前説明
a1NotationStringA1 表記または R1C1 表記で指定してアクティブとして設定する範囲。

戻る

Range - 新しくアクティブになった範囲

認可

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

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

setColumnGroupControlPosition(position)

シート上の列グループ コントロールの切り替え位置を設定します。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);

パラメータ

名前説明
positionGroupControlTogglePosition列グループ コントロールの切り替え位置。

戻る

Sheet - チェーン用のシート。

認可

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

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

setColumnWidth(columnPosition, width)

指定した列の幅をピクセル単位で設定します。

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

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

パラメータ

名前説明
columnPositionInteger設定する特定の列の位置。
widthInteger設定する幅(ピクセル単位)。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

setColumnWidths(startColumn, numColumns, width)

指定した列の幅をピクセル単位で設定します。

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

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

パラメータ

名前説明
startColumnInteger変更する開始列の位置。
numColumnsInteger変更する列の数。
widthInteger設定する幅(ピクセル単位)。

戻る

Sheet - チェーン用のシート。

認可

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

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

setConditionalFormatRules(rules)

シートにある既存の条件付き書式ルールをすべて入力ルールに置き換えます。 ルールは入力順に評価されます。

// Remove one of the existing conditional format rules.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
rules.splice(1, 1); // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

パラメータ

名前説明
rulesConditionalFormatRule[]新しい条件付き書式ルール。

認可

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

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

setCurrentCell(cell)

指定したセルを current cell に設定します。

指定したセルがすでに選択範囲にある場合、その範囲が、現在のセルとしてのセルを含むアクティブ範囲になります。

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

注: 指定する Range は、1 つのセルで構成する必要があります。1 セルがない場合、例外をスローします。

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

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

パラメータ

名前説明
cellRange現在のセルとして設定するセル。

戻る

Range - 新しく設定された現在のセル

認可

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

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

setFrozenColumns(columns)

指定された列数をフリーズします。ゼロの場合、列は固定されません。

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

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

パラメータ

名前説明
columnsInteger固定する列の数。

認可

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

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

setFrozenRows(rows)

指定した数の行をフリーズします。ゼロの場合、行は固定されません。

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

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

パラメータ

名前説明
rowsInteger固定する行数。

認可

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

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

setHiddenGridlines(hideGridlines)

シートのグリッド線の表示と非表示を切り替えます。

パラメータ

名前説明
hideGridlinesBooleantrue の場合、このシートのグリッド線を非表示にします。それ以外の場合は、グリッド線を表示します。

戻る

Sheet - チェーン用のシート。

認可

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

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

setName(name)

シート名を設定します。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setName("not first anymore");

パラメータ

名前説明
nameStringシートの新しい名前。

戻る

Sheet - チェーン用のシート。

認可

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

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

setRightToLeft(rightToLeft)

シート レイアウトを右から左に設定または設定解除します。

パラメータ

名前説明
rightToLeftBooleantrue の場合、シート レイアウトは右から左に設定され、右上隅にはセル A1 が表示されます。false の場合、シート レイアウトはデフォルトの左から右に設定され、左上にセル A1 が表示されます。

戻る

Sheet - チェーン用のシート。

認可

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

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

setRowGroupControlPosition(position)

シートの行コントロール コントロールの位置を設定します。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);

パラメータ

名前説明
positionGroupControlTogglePosition行グループのコントロールの切り替え位置。

戻る

Sheet - チェーン用のシート。

認可

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

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

setRowHeight(rowPosition, height)

特定の行の行の高さをピクセル単位で設定します。デフォルトでは、セルのコンテンツに合わせて行が拡大されます。行を指定された高さに強制する場合は、setRowHeightsForced(startRow, numRows, height) を使用します。

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

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

パラメータ

名前説明
rowPositionInteger変更する行の位置。
heightInteger設定するピクセル単位の高さ。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

setRowHeights(startRow, numRows, height)

指定した行の高さをピクセル単位で設定します。デフォルトでは、セルのコンテンツに合わせて行が拡大されます。行を指定された高さに強制する場合は、setRowHeightsForced(startRow, numRows, height) を使用します。

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

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

パラメータ

名前説明
startRowInteger変更する開始行の位置。
numRowsInteger変更する行数。
heightInteger設定するピクセル単位の高さ。

戻る

Sheet - チェーン用のシート。

認可

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

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

setRowHeightsForced(startRow, numRows, height)

指定した行の高さをピクセル単位で設定します。デフォルトでは、セルのコンテンツに合わせて行が拡大されます。setRowHeightsForced を使用すると、セルの内容が行の高さよりも高くても、行は指定された高さに強制されます。

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

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

パラメータ

名前説明
startRowInteger変更する開始行の位置。
numRowsInteger変更する行数。
heightInteger設定するピクセル単位の高さ。

戻る

Sheet - チェーン用のシート。

認可

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

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

setTabColor(color)

シートタブの色を設定します。

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setTabColor("ff0000"); // Set the color to red.
first.setTabColor(null); // Unset the color.

パラメータ

名前説明
colorStringCSS 表記のカラーコード('#ffffff''white' など)。または、タブの色をリセットする場合は null

戻る

Sheet - チェーン用のシート。

認可

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

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

setTabColorObject(color)

シートタブの色を設定します。

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
first.setTabColorObject(color); // Set the color to theme accent 1.
first.setTabColorObject(null); // Unset the color.

パラメータ

名前説明
colorColor設定するシートタブの色。

戻る

Sheet - チェーン用のシート。

認可

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

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

showColumns(columnIndex)

指定したインデックス内の列を再表示します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

パラメータ

名前説明
columnIndexInteger再表示する列のインデックス。

認可

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

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

showColumns(columnIndex, numColumns)

指定したインデックスで始まる 1 つ以上の連続した列を再表示します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

パラメータ

名前説明
columnIndexInteger再表示する列の開始インデックス。
numColumnsInteger再表示する列の数。

認可

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

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

showRows(rowIndex)

指定したインデックスの行を再表示します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

パラメータ

名前説明
rowIndexInteger再表示する行のインデックス。

認可

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

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

showRows(rowIndex, numRows)

指定したインデックスで始まる 1 つ以上の連続した行を再表示します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

パラメータ

名前説明
rowIndexInteger再表示する行の開始インデックス。
numRowsInteger再表示する行数。

認可

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

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

showSheet()

スプレッドシートを表示します。シートがすでに表示されている場合、何も変更されません。

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

戻る

Sheet - 現在のシート。

認可

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

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

sort(columnPosition)

シートを昇順で並べ替えます。

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

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

パラメータ

名前説明
columnPositionInteger並べ替えの基準とする列。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

sort(columnPosition, ascending)

列ごとにシートを並べ替えます。パラメータを昇順または降順で指定します。

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

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

パラメータ

名前説明
columnPositionInteger並べ替えの基準とする列。
ascendingBoolean昇順の場合は true、降順の場合は false を指定します。

戻る

Sheet - メソッド チェーンに役立つシート。

認可

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

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

unhideColumn(column)

指定した範囲内の列を再表示します。

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

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

パラメータ

名前説明
columnRange再表示する範囲(非表示の場合)。

認可

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

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

unhideRow(row)

指定した範囲の行を再表示します。

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

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

パラメータ

名前説明
rowRange再表示する範囲(非表示の場合)。

認可

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

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

updateChart(chart)

このシートのグラフを更新します。

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

// This code is going to loop through all the charts and change them to
// column charts
var charts = sheet.getCharts();
for (var i in charts) {
  var chart = charts[i];
  var newChart = chart
      .modify()
      .setChartType(Charts.ChartType.COLUMN)
      .build();
  sheet.updateChart(newChart);
}

パラメータ

名前説明
chartEmbeddedChart更新するグラフ。

認可

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

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

サポート終了のメソッド