このページは Cloud Translation API によって翻訳されました。

Class Sheet

スプレッドシートのシートにアクセスして変更する。一般的なオペレーションには、シートの名前の変更や、シートから範囲オブジェクトへのアクセスなどがあります。

メソッド

メソッド	戻り値の型	概要
`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)`	`Range`	A1 表記または R1C1 表記で指定された範囲を返します。
`getRangeList(a1Notations)`	`RangeList`	A1 表記または 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`	このシートのグラフを更新します。

サポート終了のメソッド

メソッド	戻り値の型	概要
`getSheetProtection()`	`PageProtection`	現在のシートの権限を記述する `PageProtection` インスタンスを返します。
`getTabColor()`	`String`	シートタブの色を取得します。シートタブに色が設定されていない場合は `null` を返します。
`setSheetProtection(permissions)`	`void`	現在のシートの権限を設定します。

詳細なドキュメント

`activate()`

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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());

パラメータ

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

戻る

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

パラメータ

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

戻る

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

パラメータ

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

戻る

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

パラメータ

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

戻る

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

承認

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

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

`appendRow(rowContents)`

シート内の現在のデータ領域の下に行を追加します。セルのコンテンツが = で始まる場合、数式として解釈されます。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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']);

パラメータ

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

戻る

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

指定した列の幅をその内容に合わせて設定します。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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);

パラメータ

名前	型	説明
`columnPosition`	`Integer`	サイズを変更する列の位置。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`autoResizeColumns(startColumn, numColumns)`

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

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

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

パラメータ

名前	型	説明
`startColumn`	`Integer`	自動調整する開始列。
`numColumns`	`Integer`	自動サイズ変更する列の数。

戻る

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

承認

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

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

`autoResizeRows(startRow, numRows)`

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

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

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

パラメータ

名前	型	説明
`startRow`	`Integer`	自動サイズ変更の開始行。
`numRows`	`Integer`	自動サイズ変更する行数。

戻る

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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clear();

戻る

Sheet - 消去されたシート。

承認

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

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

`clear(options)`

指定された高度なオプションで指定された内容や書式をシートから消去します。

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

パラメータ

名前	型	説明
`options`	`Object`	以下の詳細オプションを含む JavaScript マップ。

拡張パラメータ

名前	型	説明
`contentsOnly`	`Boolean`	コンテンツを消去するかどうか。
`formatOnly`	`Boolean`	書式をクリアするかどうか。

戻る

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

承認

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

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

`clearConditionalFormatRules()`

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

const 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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearNotes();

戻る

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

承認

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

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

`collapseAllColumnGroups()`

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

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

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

const 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)`

シートを指定のスプレッドシートにコピーします。これは、ソースと同じスプレッドシートでもかまいません。コピーされたシートの名前は「[元の名前] のコピー」になります。

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

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

パラメータ

名前	型	説明
`spreadsheet`	`Spreadsheet`	このシートをコピーするスプレッドシート。ソースと同じスプレッドシートでもかまいません。

戻る

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

シート内のテキストを検索して置換できる、シートのテキスト検索ツールを作成します。

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

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

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

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

パラメータ

名前	型	説明
`findText`	`String`	検索するテキスト。

戻る

TextFinder - シートの TextFinder。

`deleteColumn(columnPosition)`

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

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

パラメータ

名前	型	説明
`columnPosition`	`Integer`	列の位置（最初の列は 1 から始まります）。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`deleteColumns(columnPosition, howMany)`

指定した列位置から複数の列を削除します。

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

パラメータ

名前	型	説明
`columnPosition`	`Integer`	削除する最初の列の位置。
`howMany`	`Integer`	削除する列の数。

承認

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

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

`deleteRow(rowPosition)`

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

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

パラメータ

名前	型	説明
`rowPosition`	`Integer`	行の位置（最初の行は 1）。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`deleteRows(rowPosition, howMany)`

指定した行位置から複数の行を削除します。

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

パラメータ

名前	型	説明
`rowPosition`	`Integer`	削除する最初の行の位置。
`howMany`	`Integer`	削除する行数。

承認

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

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

`expandAllColumnGroups()`

シート上のすべての列グループを展開します。この方法では、少なくとも 1 つの列グループが必要です。

const 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 つの行グループが必要です。

const 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)`

指定した深さまですべての列グループを展開し、それ以外の列グループをすべて閉じます。

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

パラメータ

名前	型	説明
`groupDepth`	`Integer`	列グループを展開するグループの階層の深さ。

戻る

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

承認

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

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

`expandRowGroupsUpToDepth(groupDepth)`

指定された深さまですべての行グループを展開し、それ以外の行グループをすべて閉じます。

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

パラメータ

名前	型	説明
`groupDepth`	`Integer`	行グループを展開するグループの階層の深さ。

戻る

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

承認

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

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

`getActiveCell()`

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

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

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

戻る

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

承認

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

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

`getActiveRange()`

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

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

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

戻る

Range - 有効な範囲

承認

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

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

`getActiveRangeList()`

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

選択した範囲が 1 つの場合は、getActiveRange() 呼び出しと同様に動作します。

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const 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()`

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

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

for (const i in charts) {
  const 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)`

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

const 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.
const columnGroup = sheet.getColumnGroup(2, 1);

パラメータ

名前	型	説明
`columnIndex`	`Integer`	グループコントロールの切り替えボタンの列番号、またはグループ内のインデックス。
`groupDepth`	`Integer`	グループの深さ。

戻る

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

承認

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

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

`getColumnGroupControlPosition()`

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

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

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

戻る

GroupControlTogglePosition - このシートのグループの後に列グループ化コントロールの切り替えボタンが表示されている場合は true、それ以外の場合は false。

承認

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

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

`getColumnGroupDepth(columnIndex)`

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

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

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

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

パラメータ

名前	型	説明
`columnIndex`	`Integer`	列のインデックス。

戻る

Integer - 指定されたインデックスの列のグループの階層。

承認

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

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

`getColumnWidth(columnPosition)`

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

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

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

パラメータ

名前	型	説明
`columnPosition`	`Integer`	検証する列の位置。

戻る

Integer - 列の幅（ピクセル単位）

承認

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

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

`getConditionalFormatRules()`

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

// Logs the conditional format rules in a sheet.
const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const 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 つ以上のセル範囲を選択すると、選択範囲内のいずれかのセルが現在のセルになります。

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
const 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()）で囲まれた範囲を作成することと機能的に同等です。

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

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

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let 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.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();

戻る

Filter - フィルタ。

承認

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

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

`getFormUrl()`

このシートに回答を送信するフォームの URL を返します。このシートにフォームが関連付けられていない場合は null を返します。ユーザーにスプレッドシートを編集する権限がない場合、例外をスローします。

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

戻る

String - このシートに回答を配置するフォームの URL。このシートに関連付けられたフォームがない場合、null です。

承認

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

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

`getFrozenColumns()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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()`

凍結された行の数を返します。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 から開始します。

const ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
const 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()`

コンテンツを含む最後の列の位置を返します。

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

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const 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()`

コンテンツを含む最後の行の位置を返します。

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

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const 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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxRows());

戻る

Integer - シートの最大高さ。

承認

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

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

`getName()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
const 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 を返します。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// parent is identical to ss
const 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)`

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

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

// Remove sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
  protection.remove();
}

パラメータ

名前	型	説明
`type`	`ProtectionType`	保護区域のタイプ（`SpreadsheetApp.ProtectionType.RANGE` または `SpreadsheetApp.ProtectionType.SHEET`）。

戻る

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

承認

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

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

`getRange(row, column)`

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

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

パラメータ

名前	型	説明
`row`	`Integer`	返すセルの行番号。行番号は 1 から始まります。
`column`	`Integer`	返すセルの列番号。列番号は 1 から始まります。

戻る

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

承認

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

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

`getRange(row, column, numRows)`

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

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

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

パラメータ

名前	型	説明
`row`	`Integer`	範囲の開始行番号。行番号は 1 から始まります。
`column`	`Integer`	範囲の列番号。列番号は 1 から始まります。
`numRows`	`Integer`	返す行数。

戻る

Range - 行数が指定された単一の列データを含む範囲。

承認

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

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

`getRange(row, column, numRows, numColumns)`

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

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

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

パラメータ

名前	型	説明
`row`	`Integer`	範囲の開始行番号。行番号は 1 から始まります。
`column`	`Integer`	範囲の開始列番号。列番号は 1 から始まります。
`numRows`	`Integer`	返す行数。
`numColumns`	`Integer`	返す列数です。

戻る

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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

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

パラメータ

名前	型	説明
`a1Notation`	`String`	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.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);

パラメータ

名前	型	説明
`a1Notations`	`String[]`	A1 表記または R1C1 表記で指定された、返される範囲のリスト。

戻る

RangeList - 指定されたロケーションの範囲リスト

承認

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

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

`getRowGroup(rowIndex, groupDepth)`

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

const 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.
const rowGroup = sheet.getRowGroup(2, 1);

パラメータ

名前	型	説明
`rowIndex`	`Integer`	グループコントロールの切り替えボタンの行番号、またはグループ内のインデックス。
`groupDepth`	`Integer`	グループの深さ。

戻る

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

承認

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

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

`getRowGroupControlPosition()`

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

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

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

戻る

GroupControlTogglePosition - このシートのグループの後に行グループ化コントロールの切り替えボタンが表示されている場合は true、それ以外の場合は false。

承認

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

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

`getRowGroupDepth(rowIndex)`

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

グループの深さは、行と重複するグループの数を示します。0 ～ 8 の範囲で指定できます。

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

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

パラメータ

名前	型	説明
`rowIndex`	`Integer`	行のインデックス。

戻る

Integer - 指定されたインデックスの行のグループの階層。

承認

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

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

`getRowHeight(rowPosition)`

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

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

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

パラメータ

名前	型	説明
`rowPosition`	`Integer`	検証する行の位置。

戻る

Integer - 行の高さ（ピクセル単位）

承認

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

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

`getSelection()`

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

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const 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) などのメソッドと組み合わせて使用すると便利です。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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()`

シート名を返します。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 値を指定すると、シート内にデータが存在する最後の行または列が取得されます。

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

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

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

パラメータ

名前	型	説明
`startRow`	`Integer`	開始行の位置。
`startColumn`	`Integer`	開始列の位置。
`numRows`	`Integer`	値を返す行数。
`numColumns`	`Integer`	値を返す列の数。

戻る

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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const 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 シートです。

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

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

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

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

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

パラメータ

名前	型	説明
`column`	`Range`	非表示にする列の範囲。

承認

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

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

`hideColumns(columnIndex)`

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

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

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

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

パラメータ

名前	型	説明
`columnIndex`	`Integer`	非表示にする列のインデックス。

承認

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

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

`hideColumns(columnIndex, numColumns)`

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

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

パラメータ

名前	型	説明
`columnIndex`	`Integer`	非表示にする列の開始インデックス。
`numColumns`	`Integer`	非表示にする列の数。

承認

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

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

`hideRow(row)`

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

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

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

パラメータ

名前	型	説明
`row`	`Range`	非表示にする行の範囲。

承認

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

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

`hideRows(rowIndex)`

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

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

パラメータ

名前	型	説明
`rowIndex`	`Integer`	非表示にする行のインデックス。

承認

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

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

`hideRows(rowIndex, numRows)`

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

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

パラメータ

名前	型	説明
`rowIndex`	`Integer`	非表示にする行の開始インデックス。
`numRows`	`Integer`	非表示にする行数。

承認

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

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

`hideSheet()`

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

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

戻る

Sheet - 現在のシート。

承認

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

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

`insertChart(chart)`

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

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
const 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);

パラメータ

名前	型	説明
`chart`	`EmbeddedChart`	挿入するグラフ。

承認

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

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

`insertColumnAfter(afterPosition)`

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

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

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

パラメータ

名前	型	説明
`afterPosition`	`Integer`	新しい列を追加する列。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`insertColumnBefore(beforePosition)`

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

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

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

パラメータ

名前	型	説明
`beforePosition`	`Integer`	新しい列を追加する列。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`insertColumns(columnIndex)`

シートの指定した位置に空白の列を挿入します。

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

パラメータ

名前	型	説明
`columnIndex`	`Integer`	列を挿入する位置を示すインデックス。

承認

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

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

`insertColumns(columnIndex, numColumns)`

指定した位置からシートに 1 つ以上の連続した空白列を挿入します。

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

パラメータ

名前	型	説明
`columnIndex`	`Integer`	列を挿入する位置を示すインデックス。
`numColumns`	`Integer`	挿入する列の数。

承認

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

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

`insertColumnsAfter(afterPosition, howMany)`

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

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

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

パラメータ

名前	型	説明
`afterPosition`	`Integer`	新しい列を追加する列。
`howMany`	`Integer`	挿入する列の数。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`insertColumnsBefore(beforePosition, howMany)`

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

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

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

パラメータ

名前	型	説明
`beforePosition`	`Integer`	新しい列を追加する列。
`howMany`	`Integer`	挿入する列の数。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`insertImage(blobSource, column, row)`

指定した行と列に、BlobSource を画像としてドキュメントに挿入します。画像サイズは blob の内容から取得されます。サポートされている blob の最大サイズは 2 MB です。

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

パラメータ

名前	型	説明
`blobSource`	`BlobSource`	画像の内容、MIME タイプ、（省略可）名前を含む blob。
`column`	`Integer`	列の位置。
`row`	`Integer`	行の位置。

戻る

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

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

パラメータ

名前	型	説明
`blobSource`	`BlobSource`	画像の内容、MIME タイプ、（省略可）名前を含む blob。
`column`	`Integer`	列の位置。
`row`	`Integer`	行の位置。
`offsetX`	`Integer`	セルの角からの水平方向のオフセット（ピクセル単位）。
`offsetY`	`Integer`	セルの角からの垂直オフセット（ピクセル単位）。

戻る

OverGridImage - 挿入された画像。

承認

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

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

`insertImage(url, column, row)`

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

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

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

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

パラメータ

名前	型	説明
`url`	`String`	画像の URL です。
`column`	`Integer`	グリッドの列位置。
`row`	`Integer`	グリッドの行の位置。

戻る

OverGridImage - 挿入された画像。

承認

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

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

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

指定した行と列に、ピクセル単位のオフセットで画像を挿入します。

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

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

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

パラメータ

名前	型	説明
`url`	`String`	画像の URL。
`column`	`Integer`	列の位置。
`row`	`Integer`	行の位置。
`offsetX`	`Integer`	セルの角からの水平方向のオフセット（ピクセル単位）。
`offsetY`	`Integer`	セルの角からの垂直オフセット（ピクセル単位）。

戻る

OverGridImage - 挿入された画像。

承認

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

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

`insertRowAfter(afterPosition)`

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

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

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

パラメータ

名前	型	説明
`afterPosition`	`Integer`	新しい行を追加する行。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`insertRowBefore(beforePosition)`

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

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

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

パラメータ

名前	型	説明
`beforePosition`	`Integer`	新しい行を追加する行。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`insertRows(rowIndex)`

シートの指定した位置に空白の行を挿入します。

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

パラメータ

名前	型	説明
`rowIndex`	`Integer`	行を挿入する位置を示すインデックス。

承認

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

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

`insertRows(rowIndex, numRows)`

指定した位置からシートに 1 つ以上の連続した空白行を挿入します。

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

パラメータ

名前	型	説明
`rowIndex`	`Integer`	行を挿入する位置を示すインデックス。
`numRows`	`Integer`	挿入する行数。

承認

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

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

`insertRowsAfter(afterPosition, howMany)`

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

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

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

パラメータ

名前	型	説明
`afterPosition`	`Integer`	新しい行を追加する行。
`howMany`	`Integer`	挿入する行数。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`insertRowsBefore(beforePosition, howMany)`

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

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

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

パラメータ

名前	型	説明
`beforePosition`	`Integer`	新しい行を追加する行。
`howMany`	`Integer`	挿入する行数。

戻る

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

パラメータ

名前	型	説明
`range`	`Range`	スライサーが作成される範囲。
`anchorRowPos`	`Integer`	スライサーの上部は、この行に固定されます。
`anchorColPos`	`Integer`	スライサーの上部がこの列に固定されます。

戻る

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

パラメータ

名前	型	説明
`range`	`Range`	スライサーが作成される範囲。
`anchorRowPos`	`Integer`	スライサーの上部は、この行に固定されます。
`anchorColPos`	`Integer`	スライサーの上部がこの列に固定されます。
`offsetX`	`Integer`	セルの角からの水平方向のオフセット（ピクセル単位）。
`offsetY`	`Integer`	セルの角からの垂直オフセット（ピクセル単位）。

戻る

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

承認

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

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

`isColumnHiddenByUser(columnPosition)`

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

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

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

パラメータ

名前	型	説明
`columnPosition`	`Integer`	検証する列の位置。

戻る

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

指定された行がフィルタ（フィルタビューではない）によって非表示になっているかどうかを返します。

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

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

パラメータ

名前	型	説明
`rowPosition`	`Integer`	検証する行の位置。

戻る

Boolean - 行が非表示の場合は true、そうでない場合は false。

承認

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

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

`isRowHiddenByUser(rowPosition)`

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

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

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

パラメータ

名前	型	説明
`rowPosition`	`Integer`	検証する行の位置。

戻る

Boolean - 行が非表示の場合は true、そうでない場合は false。

承認

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

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

`isSheetHidden()`

シートが現在非表示になっている場合は true を返します。

const 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.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

パラメータ

名前	型	説明
`columnSpec`	`Range`	移動する列を含む範囲。
`destinationIndex`	`Integer`	列を移動するインデックス。このインデックスは、列が移動される前の座標に基づいています。既存のデータは右にシフトされ、移動された列のためのスペースが確保されます。一方、ソース列はグリッドから削除されます。したがって、データは、最初に指定したインデックスとは異なるインデックスに配置される場合があります。

承認

このメソッドを使用するスクリプトには、次のスコープの 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.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

パラメータ

名前	型	説明
`rowSpec`	`Range`	移動する行を含む範囲。
`destinationIndex`	`Integer`	行を移動するインデックス。このインデックスは、行が移動される前の座標に基づいています。既存のデータは下に移動され、移動された行のスペースが確保されます。一方、移動元の行はグリッドから削除されます。したがって、データは、最初に指定したインデックスとは異なるインデックスに配置される場合があります。

承認

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

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

`newChart()`

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

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const 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.
const sheet = SpreadsheetApp.getActiveSheet();
const 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.
const 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)`

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

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

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

パラメータ

名前	型	説明
`chart`	`EmbeddedChart`	削除するグラフ。

承認

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

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

`setActiveRange(range)`

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

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

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

パラメータ

名前	型	説明
`range`	`Range`	アクティブな範囲として設定する範囲。

戻る

Range - 新たに有効になった範囲

承認

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

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

`setActiveRangeList(rangeList)`

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

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

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

パラメータ

名前	型	説明
`rangeList`	`RangeList`	選択する範囲のリスト。

戻る

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

承認

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

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

`setActiveSelection(range)`

このシートのアクティブな選択領域を設定します。

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

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

パラメータ

名前	型	説明
`range`	`Range`	アクティブな選択範囲として設定する範囲。

戻る

Range - 新たに有効になった範囲

承認

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

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

`setActiveSelection(a1Notation)`

A1 表記または R1C1 表記で指定されたアクティブな選択を設定します。

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

sheet.setActiveSelection('A1:D4');

パラメータ

名前	型	説明
`a1Notation`	`String`	A1 表記または R1C1 表記で指定された、アクティブとして設定する範囲。

戻る

Range - 新たに有効になった範囲

承認

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

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

`setColumnGroupControlPosition(position)`

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

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

パラメータ

名前	型	説明
`position`	`GroupControlTogglePosition`	列グループのコントロール切り替えボタンの位置。

戻る

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

承認

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

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

`setColumnWidth(columnPosition, width)`

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

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

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

パラメータ

名前	型	説明
`columnPosition`	`Integer`	設定する特定の列の位置。
`width`	`Integer`	設定する幅（ピクセル単位）。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`setColumnWidths(startColumn, numColumns, width)`

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

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

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

パラメータ

名前	型	説明
`startColumn`	`Integer`	変更する列の開始位置。
`numColumns`	`Integer`	変更する列の数。
`width`	`Integer`	設定する幅（ピクセル単位）。

戻る

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.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
rules.splice(1, 1);  // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

パラメータ

名前	型	説明
`rules`	`ConditionalFormatRule[]`	新しい条件付き書式設定ルール。

承認

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

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

`setCurrentCell(cell)`

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

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

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

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

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

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

パラメータ

名前	型	説明
`cell`	`Range`	現在のセルとして設定するセル。

戻る

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

承認

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

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

`setFrozenColumns(columns)`

指定した数の列を固定します。0 の場合、列は凍結されません。

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

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

パラメータ

名前	型	説明
`columns`	`Integer`	固定する列の数。

承認

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

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

`setFrozenRows(rows)`

指定した行数を固定します。0 の場合、行は凍結されません。

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

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

パラメータ

名前	型	説明
`rows`	`Integer`	固定する行数。

承認

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

パラメータ

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

戻る

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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setName('not first anymore');

パラメータ

名前	型	説明
`name`	`String`	シートの新しい名前。

戻る

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

パラメータ

名前	型	説明
`rightToLeft`	`Boolean`	`true` の場合、シートのレイアウトは右から左に設定され、セル A1 が右上に配置されます。`false` の場合、シートのレイアウトはデフォルトの左から右に設定され、左上がセル A1 になります。

戻る

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

承認

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

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

`setRowGroupControlPosition(position)`

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

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

パラメータ

名前	型	説明
`position`	`GroupControlTogglePosition`	行グループのコントロール切り替えボタンの位置。

戻る

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

承認

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

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

`setRowHeight(rowPosition, height)`

指定した行の行の高さをピクセル単位で設定します。デフォルトでは、行はセルの内容に合わせて大きくなります。行の高さを強制的に指定する場合は、setRowHeightsForced(startRow, numRows, height) を使用します。

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

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

パラメータ

名前	型	説明
`rowPosition`	`Integer`	変更する行の位置。
`height`	`Integer`	設定する高さ（ピクセル単位）。

戻る

Sheet - メソッドのチェーンに便利なシート。

承認

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

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

`setRowHeights(startRow, numRows, height)`

指定した行の高さをピクセル単位で設定します。デフォルトでは、行はセルの内容に合わせて大きくなります。行の高さを強制的に指定する場合は、setRowHeightsForced(startRow, numRows, height) を使用します。

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

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

パラメータ

名前	型	説明
`startRow`	`Integer`	変更する開始行位置。
`numRows`	`Integer`	変更する行数。
`height`	`Integer`	設定する高さ（ピクセル単位）。

戻る

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

承認

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

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

`setRowHeightsForced(startRow, numRows, height)`

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

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

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

パラメータ

名前	型	説明
`startRow`	`Integer`	変更する開始行位置。
`numRows`	`Integer`	変更する行数。
`height`	`Integer`	設定する高さ（ピクセル単位）。

戻る

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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setTabColor('ff0000');  // Set the color to red.
first.setTabColor(null);      // Unset the color.

パラメータ

名前	型	説明
`color`	`String`	CSS 表記のカラーコード（`'#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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                  .build();
first.setTabColorObject(color);  // Set the color to theme accent 1.
first.setTabColorObject(null);   // Unset the color.

パラメータ

名前	型	説明
`color`	`Color`	設定するシートタブの色。

戻る

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

承認

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

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

`showColumns(columnIndex)`

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

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

パラメータ

名前	型	説明
`columnIndex`	`Integer`	非表示を解除する列のインデックス。

承認

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

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

`showColumns(columnIndex, numColumns)`

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

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

パラメータ

名前	型	説明
`columnIndex`	`Integer`	非表示を解除する列の開始インデックス。
`numColumns`	`Integer`	非表示を解除する列の数。

承認

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

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

`showRows(rowIndex)`

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

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

パラメータ

名前	型	説明
`rowIndex`	`Integer`	非表示を解除する行のインデックス。

承認

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

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

`showRows(rowIndex, numRows)`

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

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

パラメータ

名前	型	説明
`rowIndex`	`Integer`	非表示を解除する行の開始インデックス。
`numRows`	`Integer`	非表示を解除する行数。

承認

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

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

`showSheet()`

シートを表示します。シートがすでに表示されている場合、効果はありません。

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

戻る

Sheet - 現在のシート。

承認

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

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

`sort(columnPosition)`

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

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

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

パラメータ

名前	型	説明
`columnPosition`	`Integer`	並べ替えの基準となる列。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`sort(columnPosition, ascending)`

シートを列で並べ替えます。昇順または降順を指定するためのパラメータを受け取ります。

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

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

パラメータ

名前	型	説明
`columnPosition`	`Integer`	並べ替えの基準となる列。
`ascending`	`Boolean`	昇順の場合は `true`、降順の場合は `false` です。

戻る

Sheet - メソッドのチェーンに便利なシート

承認

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

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

`unhideColumn(column)`

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

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

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

パラメータ

名前	型	説明
`column`	`Range`	非表示にする範囲（非表示の場合）。

承認

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

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

`unhideRow(row)`

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

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

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

パラメータ

名前	型	説明
`row`	`Range`	非表示にする範囲（非表示の場合）。

承認

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

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

`updateChart(chart)`

このシートのグラフを更新します。

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

// This code is going to loop through all the charts and change them to
// column charts
const charts = sheet.getCharts();
for (const i in charts) {
  const chart = charts[i];
  const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build();
  sheet.updateChart(newChart);
}

パラメータ

名前	型	説明
`chart`	`EmbeddedChart`	更新するグラフ。

承認

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

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

サポート終了のメソッド

`getSheetProtection()`

非推奨。新しいバージョンの Google スプレッドシートで作成されたスプレッドシートの場合は、getProtections(type) を使用します。これにより、より強力な Protection クラスが返されます。このメソッドは非推奨ですが、以前のバージョンのスプレッドシートとの互換性を確保するために引き続き使用できます。

現在のシートの権限を記述する PageProtection インスタンスを返します。

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

const permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser('user@example.com');

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
const users = permissions.getUsers();
Logger.log(users);

戻る

PageProtection - シートのアクセス権限を記述するオブジェクト

承認

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

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

`getTabColor()`

非推奨。getTabColorObject() に置き換え

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

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
const color = first.getTabColor();

戻る

String - CSS の色コード（'#ffffff' など）。

承認

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

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

`setSheetProtection(permissions)`

非推奨。新しいバージョンの Google スプレッドシートで作成されたスプレッドシートの場合は、protect() を使用します。これにより、より強力な Protection クラスが返されます。このメソッドは非推奨ですが、以前のバージョンのスプレッドシートとの互換性を確保するために引き続き使用できます。

現在のシートの権限を設定します。

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

const permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
const sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

パラメータ

名前	型	説明
`permissions`	`PageProtection`	このシートに設定するアクセス権限オブジェクト。

承認

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

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