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指定されたインデックスで 1 つの列を非表示にします。
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シート内の指定した位置に、1 つ以上の連続する空白の列を挿入します。
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)Rangeアクティブな選択を A1 表記または 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)

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

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

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

パラメータ

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

リターン

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

承認

この方法を使用するスクリプトには、次の 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

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

パラメータ

Name説明
keyString新しいデベロッパー メタデータのキー。
visibilityDeveloperMetadataVisibility新しいデベロッパー メタデータの可視性。

リターン

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

承認

この方法を使用するスクリプトには、次の 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

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

パラメータ

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

リターン

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

承認

この方法を使用するスクリプトには、次の 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and sets the
// visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
  'COMPANY',
  'TECH',
  SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

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

パラメータ

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

パラメータ

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

リターン

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

承認

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

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

asDataSourceSheet()

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

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

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

リターン

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

Name説明
optionsObject詳細オプションを含む JavaScript マップ(下記)。

拡張パラメータ

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

パラメータ

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

リターン

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

承認

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

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

createDeveloperMetadataFinder()

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

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

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

リターン

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

Name説明
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 を返します。

範囲が 1 つ選択された場合は、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()

このシートのすべての縞模様を返します。

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

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

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

リターン

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

パラメータ

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

パラメータ

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

パラメータ

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

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

// Opens the spreadsheet by its ID. If you created your script from within 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 an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

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

リターン

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 an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.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 an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

リターン

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

承認

この方法を使用するスクリプトには、次の 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

リターン

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

承認

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

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

getDrawings()

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

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

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

 // Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

リターン

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

承認

この方法を使用するスクリプトには、次の 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()

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

// Opens the spreadsheet file 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 over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

リターン

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

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

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

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

リターン

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

リターン

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

承認

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

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

getSlicers()

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

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

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

リターン

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 を返します。 グリッド線はデフォルトで表示されます。

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

// Checks if the spreadsheet has hidden gridelines and logs the result to the console.
console.log(sheet.hasHiddenGridlines());

リターン

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

パラメータ

Name説明
columnRange非表示にする列の範囲です。

承認

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

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

hideColumns(columnIndex)

指定されたインデックスで 1 つの列を非表示にします。このメソッドでは 1-index を使用します。

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

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

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

パラメータ

Name説明
columnIndexInteger非表示にする列の番号です。

承認

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

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

hideColumns(columnIndex, numColumns)

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

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

Name説明
columnIndexInteger列の挿入位置を示すインデックス。
numColumnsInteger挿入する列の数。

承認

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

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

insertColumnsAfter(afterPosition, howMany)

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

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

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

ドキュメントの指定された行と列に画像を挿入します。

指定された URL は一般公開されている必要があります。

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

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

パラメータ

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

ドキュメント内の指定された行と列に、ピクセル オフセットで画像を挿入します。

指定された URL は一般公開されている必要があります。

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

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

リターン

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

承認

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

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

insertSlicer(range, anchorRowPos, anchorColPos)

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

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

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

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

パラメータ

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

リターン

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

承認

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

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

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

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

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

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

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

パラメータ

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

パラメータ

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

リターン

Boolean - 列が非表示の場合は true、それ以外の場合は false

承認

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

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

isRightToLeft()

このシート レイアウトが右から左の場合、true を返します。シートがデフォルトの左から右のレイアウトを使用している場合、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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to the console.
console.log(sheet.isRightToLeft());

リターン

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

Name説明
a1NotationStringアクティブに設定する範囲。A1 表記または 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);

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

承認

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

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

setCurrentCell(cell)

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

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

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

注: 指定する Range は 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();

パラメータ

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

パラメータ

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

パラメータ

Name説明
rowsInteger固定する行数。

承認

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

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

setHiddenGridlines(hideGridlines)

シートのグリッド線を表示または非表示にします。

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

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

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

パラメータ

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

パラメータ

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

リターン

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

承認

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

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

setRightToLeft(rightToLeft)

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

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

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

Name説明
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.

パラメータ

Name説明
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.

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

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

パラメータ

Name説明
chartEmbeddedChart更新するグラフ。

承認

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

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

サポート終了のメソッド