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

Class Spreadsheet

Google スプレッドシートのファイルにアクセスして変更する。一般的な操作は、新しいシートの追加と共同編集者の追加です。

Methods

メソッド	戻り値の型	概要
`addDeveloperMetadata(key)`	`Spreadsheet`	指定したキーを持つデベロッパーメタデータを最上位のスプレッドシートに追加します。
`addDeveloperMetadata(key, visibility)`	`Spreadsheet`	指定した鍵と公開設定を含むデベロッパーメタデータをスプレッドシートに追加します。
`addDeveloperMetadata(key, value)`	`Spreadsheet`	指定したキーと値を持つデベロッパーメタデータをスプレッドシートに追加します。
`addDeveloperMetadata(key, value, visibility)`	`Spreadsheet`	指定したキー、値、公開設定を含むデベロッパーメタデータをスプレッドシートに追加します。
`addEditor(emailAddress)`	`Spreadsheet`	指定したユーザーを `Spreadsheet` の編集者のリストに追加します。
`addEditor(user)`	`Spreadsheet`	指定したユーザーを `Spreadsheet` の編集者のリストに追加します。
`addEditors(emailAddresses)`	`Spreadsheet`	指定したユーザー配列を `Spreadsheet` の編集者のリストに追加します。
`addMenu(name, subMenus)`	`void`	スプレッドシート UI で新しいメニューを作成します。
`addViewer(emailAddress)`	`Spreadsheet`	指定したユーザーを `Spreadsheet` の閲覧者リストに追加します。
`addViewer(user)`	`Spreadsheet`	指定したユーザーを `Spreadsheet` の閲覧者リストに追加します。
`addViewers(emailAddresses)`	`Spreadsheet`	指定したユーザー配列を `Spreadsheet` の閲覧者リストに追加します。
`appendRow(rowContents)`	`Sheet`	シートの現在のデータ領域の下部に行を追加します。
`autoResizeColumn(columnPosition)`	`Sheet`	指定された列の幅をコンテンツに合わせて設定します。
`copy(name)`	`Spreadsheet`	スプレッドシートをコピーして新しいスプレッドシートを返します。
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	このスプレッドシートのスコープ内でデベロッパーメタデータを見つける `DeveloperMetadataFinder` を返します。
`createTextFinder(findText)`	`TextFinder`	スプレッドシートのテキストファインダーを作成します。これは、スプレッドシート内のテキストの検索と置換に使用できます。
`deleteActiveSheet()`	`Sheet`	現在アクティブなシートを削除します。
`deleteColumn(columnPosition)`	`Sheet`	指定した列位置の列を削除します。
`deleteColumns(columnPosition, howMany)`	`void`	指定した列位置から始まる複数の列を削除します。
`deleteRow(rowPosition)`	`Sheet`	指定した行の位置にある行を削除します。
`deleteRows(rowPosition, howMany)`	`void`	指定した行位置から始まる行数を削除します。
`deleteSheet(sheet)`	`void`	指定したシートを削除します。
`duplicateActiveSheet()`	`Sheet`	アクティブシートを複製してアクティブシートにします。
`getActiveCell()`	`Range`	このシートの有効なセルを返します。
`getActiveRange()`	`Range`	アクティブシートで選択した範囲を返します。有効な範囲がない場合は `null` を返します。
`getActiveRangeList()`	`RangeList`	アクティブシート内のアクティブな範囲のリストを返します。アクティブな範囲がない場合は `null` を返します。
`getActiveSheet()`	`Sheet`	スプレッドシートの有効なシートを取得します。
`getAs(contentType)`	`Blob`	このオブジェクト内のデータを、指定されたコンテンツタイプに変換された blob として返します。
`getBandings()`	`Banding[]`	このスプレッドシートのすべての縞模様を返します。
`getBlob()`	`Blob`	このオブジェクト内のデータを blob として返します。
`getColumnWidth(columnPosition)`	`Integer`	指定した列の幅（ピクセル単位）を取得します。
`getCurrentCell()`	`Range`	アクティブなシート内の現在のセル、または現在のセルがない場合は `null` を返します。
`getDataRange()`	`Range`	データが存在するディメンションに対応する `Range` を返します。
`getDataSourceFormulas()`	`DataSourceFormula[]`	すべてのデータソースの数式を取得します。
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	すべてのデータソースピボットテーブルを取得します。
`getDataSourceRefreshSchedules()`	`DataSourceRefreshSchedule[]`	このスプレッドシートの更新スケジュールを取得します。
`getDataSourceSheets()`	`DataSourceSheet[]`	スプレッドシート内のすべてのデータソースシートを返します。
`getDataSourceTables()`	`DataSourceTable[]`	すべてのデータソーステーブルを取得します。
`getDataSources()`	`DataSource[]`	スプレッドシート内のすべてのデータソースを返します。
`getDeveloperMetadata()`	`DeveloperMetadata[]`	最上位のスプレッドシートに関連付けられているデベロッパーメタデータを取得します。
`getEditors()`	`User[]`	この `Spreadsheet` の編集者のリストを取得します。
`getFormUrl()`	`String`	回答をこのスプレッドシートに送信するフォームの URL を返します。このスプレッドシートに関連フォームがない場合は `null` を返します。
`getFrozenColumns()`	`Integer`	固定された列の数を返します。
`getFrozenRows()`	`Integer`	固定された行の数を返します。
`getId()`	`String`	このスプレッドシートの一意の識別子を取得します。
`getImages()`	`OverGridImage[]`	シート上のすべてのグリッド画像を返します。
`getIterativeCalculationConvergenceThreshold()`	`Number`	反復計算で使用するしきい値を返します。
`getLastColumn()`	`Integer`	コンテンツを含む最後の列の位置を返します。
`getLastRow()`	`Integer`	コンテンツが含まれている最後の行の位置を返します。
`getMaxIterativeCalculationCycles()`	`Integer`	反復計算で使用する最大反復回数を返します。
`getName()`	`String`	ドキュメントの名前を取得します。
`getNamedRanges()`	`NamedRange[]`	このスプレッドシート内のすべての名前付き範囲を取得します。
`getNumSheets()`	`Integer`	このスプレッドシートのシート数を返します。
`getOwner()`	`User`	ドキュメントのオーナーを返します。共有ドライブ内のドキュメントの場合は `null` を返します。
`getPredefinedSpreadsheetThemes()`	`SpreadsheetTheme[]`	事前定義されたテーマのリストを返します。
`getProtections(type)`	`Protection[]`	スプレッドシート内のすべての保護されている範囲またはシートを表すオブジェクトの配列を取得します。
`getRange(a1Notation)`	`Range`	A1 表記または R1C1 表記で指定した範囲を返します。
`getRangeByName(name)`	`Range`	名前付き範囲を返します。指定した名前の範囲が見つからない場合は `null` を返します。
`getRangeList(a1Notations)`	`RangeList`	A1 表記または R1C1 表記の空ではないリストで指定された同じシート内の範囲を表す `RangeList` コレクションを返します。
`getRecalculationInterval()`	`RecalculationInterval`	このスプレッドシートの計算間隔を返します。
`getRowHeight(rowPosition)`	`Integer`	特定の行の高さをピクセル単位で取得します。
`getSelection()`	`Selection`	スプレッドシート内の現在の `Selection` を返します。
`getSheetByName(name)`	`Sheet`	指定した名前のシートを返します。
`getSheetId()`	`Integer`	このオブジェクトが表しているシートの ID を返します。
`getSheetName()`	`String`	シート名を返します。
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	指定された座標から始まるこの範囲の値の矩形グリッドを返します。
`getSheets()`	`Sheet[]`	このスプレッドシートのすべてのシートを取得します。
`getSpreadsheetLocale()`	`String`	スプレッドシートの言語 / 地域を取得します。
`getSpreadsheetTheme()`	`SpreadsheetTheme`	スプレッドシートの現在のテーマを返します。テーマが適用されていない場合は `null` を返します。
`getSpreadsheetTimeZone()`	`String`	スプレッドシートのタイムゾーンを取得します。
`getUrl()`	`String`	指定したスプレッドシートの URL を返します。
`getViewers()`	`User[]`	この `Spreadsheet` の閲覧者と閲覧者（コメント可）のリストを取得します。
`hideColumn(column)`	`void`	指定した範囲の列を非表示にします。
`hideRow(row)`	`void`	指定した範囲内の行を非表示にします。
`insertColumnAfter(afterPosition)`	`Sheet`	指定した列位置の後に列を挿入します。
`insertColumnBefore(beforePosition)`	`Sheet`	指定した列位置の前に列を挿入します。
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	指定した列位置の後に、複数の列を挿入します。
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	指定した列位置の前に、複数の列を挿入します。
`insertDataSourceSheet(spec)`	`DataSourceSheet`	スプレッドシートに新しい `DataSourceSheet` を挿入し、データの実行を開始します。
`insertImage(blobSource, column, row)`	`OverGridImage`	指定した行と列のドキュメントに、`Spreadsheet` を画像として挿入します。
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	ドキュメント内の特定の行と列に、ピクセル単位のオフセットで、`Spreadsheet` を画像として挿入します。
`insertImage(url, column, row)`	`OverGridImage`	ドキュメント内の特定の行と列に画像を挿入します。
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	ピクセルオフセットを使用して、ドキュメント内の特定の行と列に画像を挿入します。
`insertRowAfter(afterPosition)`	`Sheet`	指定した行位置の後に行を挿入します。
`insertRowBefore(beforePosition)`	`Sheet`	特定の行位置の前に行を挿入します。
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	指定した行位置の後に、複数の行を挿入します。
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	特定の行位置の前に複数の行を挿入します。
`insertSheet()`	`Sheet`	デフォルトのシート名を使用して、スプレッドシートに新しいシートを挿入します。
`insertSheet(sheetIndex)`	`Sheet`	指定したインデックスのスプレッドシートに新しいシートを挿入します。
`insertSheet(sheetIndex, options)`	`Sheet`	スプレッドシートに特定のインデックスでシートを挿入し、オプションの高度な引数を使用します。
`insertSheet(options)`	`Sheet`	デフォルトのシート名とオプションの高度な引数を使用して、スプレッドシートに新しいシートを挿入します。
`insertSheet(sheetName)`	`Sheet`	指定した名前で新しいスプレッドシートをスプレッドシートに挿入します。
`insertSheet(sheetName, sheetIndex)`	`Sheet`	指定したインデックスに、指定した名前の新しいスプレッドシートをスプレッドシートに挿入します。
`insertSheet(sheetName, sheetIndex, options)`	`Sheet`	スプレッドシートに、指定したインデックスの指定された名前の新しいシートを挿入します。必要に応じて高度な引数を使用できます。
`insertSheet(sheetName, options)`	`Sheet`	指定した名前の新しいスプレッドシートをスプレッドシートに挿入し、オプションの高度な引数を使用します。
`insertSheetWithDataSourceTable(spec)`	`Sheet`	スプレッドシートに新しいシートを挿入し、指定されたデータソース仕様でシート全体にわたる `DataSourceTable` を作成してデータの実行を開始します。
`isColumnHiddenByUser(columnPosition)`	`Boolean`	指定した列がユーザーによって非表示になっているかどうかを返します。
`isIterativeCalculationEnabled()`	`Boolean`	このスプレッドシートで反復計算が有効になっているかどうかを返します。
`isRowHiddenByFilter(rowPosition)`	`Boolean`	特定の行が（フィルタ表示ではなく）フィルタで非表示になっているかどうかを返します。
`isRowHiddenByUser(rowPosition)`	`Boolean`	指定した行がユーザーによって非表示になっているかどうかを返します。
`moveActiveSheet(pos)`	`void`	アクティブなシートをシートのリストの所定の位置に移動します。
`moveChartToObjectSheet(chart)`	`Sheet`	新しい `SheetType.OBJECT` シートを作成し、提供されたグラフをそれに移動します。
`refreshAllDataSources()`	`void`	無効なデータソースオブジェクトをスキップして、サポートされているすべてのデータソースとそのリンクされたデータソースオブジェクトを更新します。
`removeEditor(emailAddress)`	`Spreadsheet`	`Spreadsheet` の編集者のリストから指定されたユーザーを削除します。
`removeEditor(user)`	`Spreadsheet`	`Spreadsheet` の編集者のリストから指定されたユーザーを削除します。
`removeMenu(name)`	`void`	`addMenu(name, subMenus)` によって追加されたメニューを削除します。
`removeNamedRange(name)`	`void`	指定した名前の名前付き範囲を削除します。
`removeViewer(emailAddress)`	`Spreadsheet`	`Spreadsheet` の閲覧者と閲覧者（コメント可）のリストからユーザーを削除します。
`removeViewer(user)`	`Spreadsheet`	`Spreadsheet` の閲覧者と閲覧者（コメント可）のリストからユーザーを削除します。
`rename(newName)`	`void`	ドキュメントの名前を変更します。
`renameActiveSheet(newName)`	`void`	現在アクティブなシートの名前を新しい名前に変更します。
`resetSpreadsheetTheme()`	`SpreadsheetTheme`	適用したテーマを削除し、スプレッドシートのデフォルトのテーマを設定します。
`setActiveRange(range)`	`Range`	指定した範囲をアクティブシートで `active range` として設定し、範囲内の左上のセルを `current cell` に設定します。
`setActiveRangeList(rangeList)`	`RangeList`	指定範囲のリストをアクティブシート内の `active ranges` として設定します。
`setActiveSelection(range)`	`Range`	このシートのアクティブな選択領域を設定します。
`setActiveSelection(a1Notation)`	`Range`	アクティブな選択を、A1 表記または R1C1 表記の指定に従って設定します。
`setActiveSheet(sheet)`	`Sheet`	指定したシートを、スプレッドシート内のアクティブなシートに設定します。
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	指定したシートを、スプレッドシート内のアクティブなシートに設定します。そのシート内で最新のシートを復元するオプションもあります。
`setColumnWidth(columnPosition, width)`	`Sheet`	指定した列の幅をピクセル単位で設定します。
`setCurrentCell(cell)`	`Range`	指定したセルを `current cell` に設定します。
`setFrozenColumns(columns)`	`void`	指定した数の列を固定します。
`setFrozenRows(rows)`	`void`	指定された行数を固定します。
`setIterativeCalculationConvergenceThreshold(minThreshold)`	`Spreadsheet`	反復計算の最小しきい値を設定します。
`setIterativeCalculationEnabled(isEnabled)`	`Spreadsheet`	このスプレッドシートで反復計算を有効にするかどうかを設定します。
`setMaxIterativeCalculationCycles(maxIterations)`	`Spreadsheet`	反復計算中に実行する計算の反復の最大回数を設定します。
`setNamedRange(name, range)`	`void`	範囲に名前を付けます。
`setRecalculationInterval(recalculationInterval)`	`Spreadsheet`	このスプレッドシートを再計算する頻度を設定します。
`setRowHeight(rowPosition, height)`	`Sheet`	特定の行の行の高さをピクセル単位で設定します。
`setSpreadsheetLocale(locale)`	`void`	スプレッドシートの言語 / 地域を設定します。
`setSpreadsheetTheme(theme)`	`SpreadsheetTheme`	スプレッドシートにテーマを設定します。
`setSpreadsheetTimeZone(timezone)`	`void`	スプレッドシートのタイムゾーンを設定します。
`show(userInterface)`	`void`	ブラウザのビューポートを中央に配置したダイアログに、カスタムユーザーインターフェースコンポーネントを表示します。
`sort(columnPosition)`	`Sheet`	シートを昇順で並べ替えます。
`sort(columnPosition, ascending)`	`Sheet`	シートを列で並べ替えます。
`toast(msg)`	`void`	スプレッドシートの右下に、入力したメッセージを含むポップアップウィンドウが表示されます。
`toast(msg, title)`	`void`	スプレッドシートの右下に、特定のメッセージとタイトルを含むポップアップウィンドウを表示します。
`toast(msg, title, timeoutSeconds)`	`void`	スプレッドシートの右下に、指定したタイトルとメッセージを含むポップアップウィンドウを表示します。一定期間、このウィンドウが表示されます。
`unhideColumn(column)`	`void`	指定した範囲内の列を再表示します。
`unhideRow(row)`	`void`	指定した範囲内の行を再表示します。
`updateMenu(name, subMenus)`	`void`	`addMenu(name, subMenus)` によって追加されたメニューを更新します。
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	スプレッドシートで現在の実行がすべて完了するまで待機し、指定した秒数が経過するとタイムアウトします。

サポート終了のメソッド

メソッド	戻り値の型	概要
`getSheetProtection()`	`PageProtection`	現在のシートの権限を記述する `PageProtection` インスタンスを返します。
`isAnonymousView()`	`Boolean`	ドキュメントで匿名の閲覧が許可されているかどうかを示します。
`isAnonymousWrite()`	`Boolean`	ドキュメントで匿名ユーザーによる編集が許可されているかどうかを示します。
`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`	`void`	匿名の読み取りと書き込みに関するドキュメントのポリシーを設定します。
`setSheetProtection(permissions)`	`void`	現在のシートの権限を設定します。

詳細なドキュメント

`addDeveloperMetadata(key)`

指定したキーを持つデベロッパーメタデータを最上位のスプレッドシートに追加します。

パラメータ

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

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`addDeveloperMetadata(key, visibility)`

指定した鍵と公開設定を含むデベロッパーメタデータをスプレッドシートに追加します。

パラメータ

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

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`addDeveloperMetadata(key, value)`

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

パラメータ

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

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`addDeveloperMetadata(key, value, visibility)`

指定したキー、値、公開設定を含むデベロッパーメタデータをスプレッドシートに追加します。

パラメータ

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

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`addEditor(emailAddress)`

指定したユーザーを Spreadsheet の編集者のリストに追加します。ユーザーがすでに閲覧者のリストに含まれていた場合、このメソッドはユーザーを閲覧者のリストから選択します。

パラメータ

氏名	型	説明
`emailAddress`	`String`	追加するユーザーのメールアドレス。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`addEditor(user)`

パラメータ

氏名	型	説明
`user`	`User`	追加するユーザーの表現。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`addEditors(emailAddresses)`

指定したユーザー配列を Spreadsheet の編集者のリストに追加します。すでにいずれかのユーザーが閲覧者のリストに含まれていた場合、このメソッドはユーザーを閲覧者のリストから選択します。

パラメータ

氏名	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`addMenu(name, subMenus)`

スプレッドシート UI で新しいメニューを作成します。

各メニューエントリは、ユーザー定義関数を実行します。通常は、スプレッドシートの読み込み時にメニューが自動的に作成されるように、onOpen() 関数から呼び出します。

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

パラメータ

氏名	型	説明
`name`	`String`	作成するメニューの名前。
`subMenus`	`Object[]`	`name` パラメータと `functionName` パラメータを含む JavaScript マップの配列。`Library.libFunction1` などの組み込みライブラリの関数を使用できます。

承認

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

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

`addViewer(emailAddress)`

指定したユーザーを Spreadsheet の閲覧者リストに追加します。ユーザーがすでに編集者のリストに含まれていた場合、このメソッドは無視されます。

パラメータ

氏名	型	説明
`emailAddress`	`String`	追加するユーザーのメールアドレス。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`addViewer(user)`

パラメータ

氏名	型	説明
`user`	`User`	追加するユーザーの表現。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`addViewers(emailAddresses)`

指定したユーザー配列を Spreadsheet の閲覧者リストに追加します。すでに編集者のリストに含まれていたユーザーが存在する場合、この方法による影響はありません。

パラメータ

氏名	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`appendRow(rowContents)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`autoResizeColumn(columnPosition)`

列の情報に合わせて特定の列の幅を設定します。

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

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

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

パラメータ

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

戻る

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

承認

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

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

`copy(name)`

スプレッドシートをコピーして新しいスプレッドシートを返します。

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

パラメータ

氏名	型	説明
`name`	`String`	コピーの名前。

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`createDeveloperMetadataFinder()`

このスプレッドシートのスコープ内でデベロッパーメタデータを見つける DeveloperMetadataFinder を返します。デフォルトでは、スプレッドシート、シート、行、列に関連付けられているすべてのメタデータが考慮されます。

戻る

DeveloperMetadataFinder - このスプレッドシートの範囲内でメタデータを検索するデベロッパーメタデータ検索。

`createTextFinder(findText)`

スプレッドシートのテキストファインダーを作成します。これは、スプレッドシート内のテキストの検索と置換に使用できます。検索はスプレッドシートの最初のシートから開始します。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

パラメータ

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

戻る

TextFinder - スプレッドシートの TextFinder。

`deleteActiveSheet()`

現在アクティブなシートを削除します。

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

戻る

Sheet - 新しいアクティブシート。

承認

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

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

`deleteColumn(columnPosition)`

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

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

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

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

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

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

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

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

`deleteSheet(sheet)`

指定したシートを削除します。

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

パラメータ

氏名	型	説明
`sheet`	`Sheet`	削除するシート。

承認

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

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

`duplicateActiveSheet()`

アクティブシートを複製してアクティブシートにします。

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

戻る

Sheet - 新しいシート。

承認

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

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

`getActiveCell()`

このシートの有効なセルを返します。

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

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

戻る

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

承認

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

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

`getActiveRange()`

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

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

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

戻る

Range - アクティブ範囲

承認

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

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

`getActiveRangeList()`

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

単一の範囲が選択されている場合、getActiveRange() 呼び出しとして機能します。

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

戻る

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

承認

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

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

`getActiveSheet()`

スプレッドシートのアクティブシートを取得します。

スプレッドシートのアクティブシートは、スプレッドシートの UI に表示されているシートです。

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

戻る

Sheet - スプレッドシート内のアクティブなシート。

`getAs(contentType)`

このオブジェクト内のデータを、指定されたコンテンツタイプに変換された blob として返します。このメソッドでは、適切な拡張子が「myfile.pdf」のようにファイル名に追加されます。ただし、ファイル名の最後のピリオド（存在する場合）の後に続く部分は、既存の拡張子とみなし、それを置換する必要があります。そのため、「ShoppingList.12.25.2014」は「ShoppingList.12.25.pdf」になります。

コンバージョンに対する 1 日の割り当てを確認するには、Google サービスの割り当てをご覧ください。新しく作成された Google Workspace ドメインは、より厳格な割り当ての適用対象となる場合があります。

パラメータ

氏名	型	説明
`contentType`	`String`	変換先の MIME タイプ。ほとんどの blob で有効なオプションは `'application/pdf'` です。BMP、GIF、JPEG、PNG 形式の画像の場合は、`'image/bmp'`、`'image/gif'`、`'image/jpeg'`、`'image/png'` のいずれかも有効です。

戻る

Blob - blob としてのデータ。

`getBandings()`

このスプレッドシートのすべての縞模様を返します。

戻る

Banding[] - このスプレッドシートの縞模様。

承認

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

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

`getBlob()`

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

戻る

Blob - blob としてのデータ。

`getColumnWidth(columnPosition)`

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

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

`getCurrentCell()`

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

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

戻る

Range - 現在のセル

承認

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

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

`getDataRange()`

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

これは、A1 と Sheet.getLastColumn()（Sheet.getLastRow()）にバインドされた範囲を作成するのと機能的には同じです。

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

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

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

戻る

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

承認

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

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

`getDataSourceFormulas()`

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

戻る

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

承認

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

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

`getDataSourcePivotTables()`

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

戻る

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

承認

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

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

`getDataSourceRefreshSchedules()`

このスプレッドシートの更新スケジュールを取得します。

戻る

DataSourceRefreshSchedule[] - このスプレッドシートの更新スケジュール。

承認

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

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

`getDataSourceSheets()`

スプレッドシート内のすべてのデータソースシートを返します。

戻る

DataSourceSheet[] - すべてのデータソースシートの配列。

承認

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

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

`getDataSourceTables()`

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

戻る

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

承認

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

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

`getDataSources()`

スプレッドシート内のすべてのデータソースを返します。

戻る

DataSource[] - すべてのデータソースの配列。

承認

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

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

`getDeveloperMetadata()`

最上位のスプレッドシートに関連付けられているデベロッパーメタデータを取得します。

戻る

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

承認

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

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

`getEditors()`

この Spreadsheet の編集者のリストを取得します。

戻る

User[] - 編集権限を持つユーザーの配列。

承認

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

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

`getFormUrl()`

回答をこのスプレッドシートに送信するフォームの URL を返します。このスプレッドシートに関連フォームがない場合は null を返します。複数のフォームがこのスプレッドシートに応答を送信した場合、返されるフォームの URL は不確定です。代わりに、Sheet.getFormUrl() メソッドでシートごとの URL の関連付けを取得できます。

戻る

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

承認

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

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

`getFrozenColumns()`

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

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

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

戻る

Integer - 固定された列の数

承認

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

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

`getFrozenRows()`

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

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

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

戻る

Integer - 固定された行数

承認

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

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

`getId()`

このスプレッドシートの一意の識別子を取得します。スプレッドシート ID は URL から抽出できます。たとえば、URL が「https://docs.google.com/spreadsheet/d/abc1234567/edit#gid=0」の場合、スプレッドシート ID は「abc1234567」です。

// The code below logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

戻る

String - スプレッドシートの一意の ID（キー）。

`getImages()`

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

戻る

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

承認

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

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

`getIterativeCalculationConvergenceThreshold()`

反復計算で使用するしきい値を返します。連続計算の結果がこの値より小さい場合、反復計算は停止します。

戻る

Number - 収束しきい値。

承認

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

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

`getLastColumn()`

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

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

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

戻る

Integer - コンテンツを含むシートの最後の列

承認

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

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

`getLastRow()`

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

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

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

戻る

Integer - コンテンツを含むシートの最後の行

承認

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

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

`getMaxIterativeCalculationCycles()`

反復計算で使用する最大反復回数を返します。

戻る

Integer - 計算の反復回数の最大数。

承認

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

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

`getName()`

ドキュメントの名前を取得します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

戻る

String - スプレッドシートの名前。

承認

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

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

`getNamedRanges()`

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

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

戻る

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

承認

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

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

`getNumSheets()`

このスプレッドシート内のシート数を返します。

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

戻る

Integer - スプレッドシート内のシート数。

`getOwner()`

ドキュメントのオーナーを返します。共有ドライブ内のファイルの場合は null を返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

戻る

User - ドキュメントのオーナー。ドキュメントが共有ドライブにある場合は null。

承認

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

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

`getPredefinedSpreadsheetThemes()`

事前定義されたテーマのリストを返します。

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

戻る

SpreadsheetTheme[] - 事前定義テーマのリスト。

承認

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

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

`getProtections(type)`

スプレッドシート内のすべての保護されている範囲またはシートを表すオブジェクトの配列を取得します。

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

// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  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(a1Notation)`

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

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

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

パラメータ

氏名	型	説明
`a1Notation`	`String`	返される範囲です。A1 表記または R1C1 表記で指定します。

戻る

Range - 指定されたロケーションの範囲

承認

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

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

`getRangeByName(name)`

名前付き範囲を返します。指定した名前の範囲が見つからない場合は null を返します。スプレッドシートの複数のシートが同じ範囲名を使用している場合は、追加の引用符なしでシート名を指定します（例: getRangeByName('"Sheet Name"!TaxRates') ではなく getRangeByName('TaxRates') または getRangeByName('Sheet Name!TaxRates')）。

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

パラメータ

氏名	型	説明
`name`	`String`	取得する範囲の名前。

戻る

Range - 指定した名前を持つセルの範囲。

`getRangeList(a1Notations)`

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

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

パラメータ

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

戻る

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

承認

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

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

`getRecalculationInterval()`

このスプレッドシートの計算間隔を返します。

戻る

RecalculationInterval - このスプレッドシートの計算間隔。

承認

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

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

`getRowHeight(rowPosition)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`getSelection()`

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

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

戻る

Selection - 現在の選択

承認

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

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

`getSheetByName(name)`

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

同じ名前の複数のシートがある場合は、一番左のシートが返されます。指定された名前のシートがない場合、null を返します。

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

パラメータ

氏名	型	説明
`name`	`String`	取得するシートの名前。

戻る

Sheet - 指定した名前のシート。

`getSheetId()`

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

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

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

Logger.log(sheet.getSheetId());

戻る

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

承認

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

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

`getSheetName()`

シート名を返します。

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

Logger.log(sheet.getSheetName());

戻る

String - シートの名前

承認

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

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

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

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

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

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

パラメータ

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

戻る

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

承認

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

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

`getSheets()`

このスプレッドシートのすべてのシートを取得します。

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

戻る

Sheet[] - スプレッドシート内のすべてのシートの配列。

`getSpreadsheetLocale()`

スプレッドシートの言語 / 地域を取得します。

戻る

String - スプレッドシートの言語 / 地域。

承認

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

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

`getSpreadsheetTheme()`

スプレッドシートの現在のテーマを返します。テーマが適用されていない場合は null を返します。

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

戻る

SpreadsheetTheme - 現在適用されているテーマ。

承認

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

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

`getSpreadsheetTimeZone()`

スプレッドシートのタイムゾーンを取得します。

戻る

String - 「long」形式のタイムゾーン（例: Joda.org の「America/New_York」など）。

承認

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

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

`getUrl()`

指定したスプレッドシートの URL を返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

戻る

String - 指定したスプレッドシートの URL。

承認

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

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

`getViewers()`

この Spreadsheet の閲覧者と閲覧者（コメント可）のリストを取得します。

戻る

User[] - 表示またはコメントの権限を持つユーザーの配列。

承認

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

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

`hideColumn(column)`

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

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

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

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

パラメータ

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

承認

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

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

`hideRow(row)`

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

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

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

パラメータ

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

承認

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

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

`insertColumnAfter(afterPosition)`

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

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

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

パラメータ

氏名	型	説明
`afterPosition`	`Integer`	その後に新しい列を追加します。

戻る

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

承認

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

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

`insertColumnBefore(beforePosition)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`insertColumnsAfter(afterPosition, howMany)`

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

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

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

パラメータ

氏名	型	説明
`afterPosition`	`Integer`	その後に新しい列を追加します。
`howMany`	`Integer`	挿入する列の数。

戻る

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

承認

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

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

`insertColumnsBefore(beforePosition, howMany)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`insertDataSourceSheet(spec)`

スプレッドシートに新しい DataSourceSheet を挿入し、データの実行を開始します。これにより、新しいシートはアクティブなシートになります。

データソースの種類が有効になっていない場合は、例外をスローします。SpreadsheetApp#enable...Execution() メソッドを使用して、特定のデータソースタイプに対してデータの実行を有効にします。

パラメータ

氏名	型	説明
`spec`	`DataSourceSpec`	挿入するデータソースの仕様。

戻る

DataSourceSheet - 新しいデータソースシート。

承認

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

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

`insertImage(blobSource, column, row)`

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

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

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

パラメータ

氏名	型	説明
`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)`

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

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

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

パラメータ

氏名	型	説明
`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 は一般公開されている必要があります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 は一般公開されている必要があります。

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

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

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

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

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

`insertRowsAfter(afterPosition, howMany)`

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

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

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

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

`insertSheet()`

デフォルトのシート名を使用して、スプレッドシートに新しいシートを挿入します。新しいシートがアクティブシートになります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

戻る

Sheet - 新しいシート。

承認

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

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

`insertSheet(sheetIndex)`

指定したインデックスのスプレッドシートに新しいシートを挿入します。新しいシートがアクティブなシートになります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

パラメータ

氏名	型	説明
`sheetIndex`	`Integer`	新しく作成されたシートのインデックス。スプレッドシートで最初のシートとして挿入する場合は、0 に設定します。

戻る

Sheet - 新しいシート。

承認

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

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

`insertSheet(sheetIndex, options)`

スプレッドシートに特定のインデックスでシートを挿入し、オプションの高度な引数を使用します。新しいシートがアクティブシートになります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

パラメータ

氏名	型	説明
`sheetIndex`	`Integer`	新しく作成されたシートのインデックス。スプレッドシートで最初のシートとして挿入する場合は、0 に設定します。
`options`	`Object`	オプションの JavaScript の高度な引数。

拡張パラメータ

氏名	型	説明
`template`	`Sheet`	テンプレートシートオブジェクトのすべてのデータが新しいシートにコピーされます。シートテンプレートは、スプレッドシートオブジェクトのシートの 1 つにする必要があります。

戻る

Sheet - 新しいシート。

承認

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

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

`insertSheet(options)`

デフォルトのシート名とオプションの高度な引数を使用して、スプレッドシートに新しいシートを挿入します。新しいシートがアクティブシートになります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

パラメータ

氏名	型	説明
`options`	`Object`	オプションの JavaScript の高度な引数（下記を参照）。

拡張パラメータ

氏名	型	説明
`template`	`Sheet`	テンプレートシートオブジェクトのすべてのデータが新しいシートにコピーされます。シートテンプレートは、このスプレッドシートオブジェクトのシートの 1 つにする必要があります。

戻る

Sheet - 新しいシート。

承認

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

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

`insertSheet(sheetName)`

指定した名前で新しいスプレッドシートをスプレッドシートに挿入します。新しいシートがアクティブなシートになります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

パラメータ

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

戻る

Sheet - 新しいシート。

承認

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

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

`insertSheet(sheetName, sheetIndex)`

指定したインデックスに、指定した名前の新しいスプレッドシートをスプレッドシートに挿入します。新しいシートがアクティブシートになります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

パラメータ

氏名	型	説明
`sheetName`	`String`	新しいシートの名前。
`sheetIndex`	`Integer`	新しく作成されたシートのインデックス。スプレッドシートで最初のシートとして挿入する場合は、0 に設定します。

戻る

Sheet - 新しいシート。

承認

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

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

`insertSheet(sheetName, sheetIndex, options)`

スプレッドシートに、指定したインデックスの指定された名前の新しいシートを挿入します。必要に応じて高度な引数を使用できます。新しいシートがアクティブシートになります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

パラメータ

氏名	型	説明
`sheetName`	`String`	新しいシートの名前。
`sheetIndex`	`Integer`	新しく挿入されたシートのインデックス。スプレッドシートで最初のシートとして挿入する場合は、0 に設定します。
`options`	`Object`	オプションの JavaScript の高度な引数。

拡張パラメータ

氏名	型	説明
`template`	`Sheet`	テンプレートシートオブジェクトのすべてのデータが新しいシートにコピーされます。シートテンプレートは、スプレッドシートオブジェクトのシートの 1 つにする必要があります。

戻る

Sheet - 新しいシート。

承認

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

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

`insertSheet(sheetName, options)`

指定した名前の新しいスプレッドシートをスプレッドシートに挿入し、オプションの高度な引数を使用します。新しいシートがアクティブシートになります。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

パラメータ

氏名	型	説明
`sheetName`	`String`	新しいシートの名前。
`options`	`Object`	オプションの JavaScript の高度な引数。

拡張パラメータ

氏名	型	説明
`template`	`Sheet`	テンプレートシートオブジェクトのすべてのデータが新しいシートにコピーされます。シートテンプレートは、スプレッドシートオブジェクトのシートの 1 つにする必要があります。

戻る

Sheet - 新しいシート。

承認

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

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

`insertSheetWithDataSourceTable(spec)`

スプレッドシートに新しいシートを挿入し、指定されたデータソース仕様でシート全体にわたる DataSourceTable を作成してデータの実行を開始します。副作用として、新しいシートがアクティブシートになります。

パラメータ

氏名	型	説明
`spec`	`DataSourceSpec`	挿入するデータソースの仕様。

戻る

Sheet - 新しいシート。

承認

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

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

`isColumnHiddenByUser(columnPosition)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`isIterativeCalculationEnabled()`

このスプレッドシートで反復計算が有効になっているかどうかを返します。

戻る

Boolean - 反復計算が有効になっている場合は true、そうでない場合は false。

承認

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

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

`isRowHiddenByFilter(rowPosition)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`isRowHiddenByUser(rowPosition)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`moveActiveSheet(pos)`

アクティブなシートをシートのリストの所定の位置に移動します。位置が負の場合、またはシート数を超える場合は、例外をスローします。

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

パラメータ

氏名	型	説明
`pos`	`Integer`	シートのリストでアクティブなシートを移動するときの 1 インデックスの位置。

承認

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

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

`moveChartToObjectSheet(chart)`

新しい SheetType.OBJECT シートを作成し、提供されたグラフをそれに移動します。グラフがすでに独自のシート上にある場合、そのシートは新しいシートを作成せずに返されます。

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

パラメータ

氏名	型	説明
`chart`	`EmbeddedChart`	移動するグラフ。

戻る

Sheet - グラフが表示されているシート。

承認

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

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

`refreshAllDataSources()`

サポートされているすべてのデータソースとそのリンクされたデータソースオブジェクトを更新し、無効なデータソースオブジェクトをスキップします。

SpreadsheetApp#enable...Execution() メソッドを使用して、特定のデータソースタイプに対してデータの実行を有効にします。

承認

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

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

`removeEditor(emailAddress)`

Spreadsheet の編集者のリストから指定されたユーザーを削除します。このメソッドは、ユーザーが一般的なアクセス権を持つクラスに属している場合（Spreadsheet がユーザーのドメイン全体と共有されている場合や、Spreadsheet がユーザーが所有する共有ドライブ内にある場合など）、Spreadsheet へのアクセスをブロックしません。

ドライブファイルの場合は、閲覧者のリストからもそのユーザーが削除されます。

パラメータ

氏名	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`removeEditor(user)`

ドライブファイルの場合は、閲覧者のリストからもそのユーザーが削除されます。

パラメータ

氏名	型	説明
`user`	`User`	削除するユーザーの表現。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`removeMenu(name)`

addMenu(name, subMenus) によって追加されたメニューを削除します。name 引数は、addMenu(name, subMenus) に対する対応する呼び出しと同じ値にする必要があります。

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

パラメータ

氏名	型	説明
`name`	`String`	削除するメニューの名前。

承認

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

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

`removeNamedRange(name)`

指定した名前の名前付き範囲を削除します。指定された名前を持つ範囲がスプレッドシートで見つからない場合は、例外をスローします。

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

パラメータ

氏名	型	説明
`name`	`String`	範囲名。

承認

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

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

`removeViewer(emailAddress)`

Spreadsheet の閲覧者と閲覧者（コメント可）のリストからユーザーを削除します。ユーザーが閲覧者または閲覧者（コメント可）ではなく編集者である場合、このメソッドは無視されます。また、このメソッドでは、一般的なアクセス権を持つユーザーのクラスに属している場合でも、そのユーザーが Spreadsheet にアクセスできないわけではありません。たとえば、Spreadsheet がユーザーのドメイン全体と共有されている場合や、Spreadsheet がユーザーがアクセスできる共有ドライブにある場合などです。

ドライブのファイルについては、編集者のリストからも削除されます。

パラメータ

氏名	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`removeViewer(user)`

Spreadsheet の閲覧者と閲覧者（コメント可）のリストからユーザーを削除します。ユーザーが閲覧者ではなく編集者である場合は、このメソッドは無視されます。また、Spreadsheet がユーザーのドメイン全体と共有されている場合や、Spreadsheet がユーザーがアクセスできる共有ドライブにある場合など、一般的なアクセス権を持つユーザーのクラスに属している場合でも、このメソッドは Spreadsheet へのアクセスをブロックしません。

ドライブのファイルについては、編集者のリストからも削除されます。

パラメータ

氏名	型	説明
`user`	`User`	削除するユーザーの表現。

戻る

Spreadsheet - 連結用の Spreadsheet。

承認

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

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

`rename(newName)`

ドキュメントの名前を変更します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

パラメータ

氏名	型	説明
`newName`	`String`	ドキュメントの新しい名前。

承認

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

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

`renameActiveSheet(newName)`

現在アクティブなシートの名前を新しい名前に変更します。

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

パラメータ

氏名	型	説明
`newName`	`String`	現在アクティブなシートの新しい名前。

承認

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

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

`resetSpreadsheetTheme()`

適用したテーマを削除し、スプレッドシートのデフォルトのテーマを設定します。

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

戻る

SpreadsheetTheme - デフォルトのテーマ。

承認

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

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

`setActiveRange(range)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`setActiveRangeList(rangeList)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`setActiveSelection(range)`

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

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

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

パラメータ

氏名	型	説明
`range`	`Range`	有効な選択範囲として設定する範囲。

戻る

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

承認

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

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

`setActiveSelection(a1Notation)`

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

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

sheet.setActiveSelection("A1:D4");

パラメータ

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

戻る

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

承認

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

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

`setActiveSheet(sheet)`

指定したシートを、スプレッドシート内のアクティブなシートに設定します。選択したシートは、別のスプレッドシートに属している場合を除き、Google スプレッドシートの UI に表示されます。

// The code below makes the first sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

パラメータ

氏名	型	説明
`sheet`	`Sheet`	アクティブシートとして設定するシート。

戻る

Sheet - アクティブなシート。

承認

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

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

`setActiveSheet(sheet, restoreSelection)`

指定したシートを、スプレッドシート内のアクティブなシートに設定します。そのシート内で最新のシートを復元するオプションもあります。選択したシートは、別のスプレッドシートに属している場合を除き、Google スプレッドシートの UI に表示されます。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

パラメータ

氏名	型	説明
`sheet`	`Sheet`	新しいアクティブシート。
`restoreSelection`	`Boolean`	新しいシート `true` がアクティブになると、新しいアクティブなシートの最新の選択が再び選択されます。`false` の場合、現在の選択を変更せずに、新しいシートがアクティブになります。

戻る

Sheet - 新しいアクティブシート。

承認

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

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

`setColumnWidth(columnPosition, width)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`setCurrentCell(cell)`

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

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

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

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

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

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

パラメータ

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

戻る

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

承認

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

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

`setFrozenColumns(columns)`

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

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

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

パラメータ

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

承認

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

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

`setFrozenRows(rows)`

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

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

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

パラメータ

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

承認

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

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

`setIterativeCalculationConvergenceThreshold(minThreshold)`

反復計算の最小しきい値を設定します。連続計算の結果がこの値より小さい場合、反復計算は停止します。この値は負の数にせず、デフォルトは 0.05 にします。

パラメータ

氏名	型	説明
`minThreshold`	`Number`	最小収束しきい値（負でない値でなければなりません）

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`setIterativeCalculationEnabled(isEnabled)`

このスプレッドシートで反復計算を有効にするかどうかを設定します。計算が有効になったときに、最大計算サイクル数と収束しきい値が設定されていない場合、それぞれデフォルトの 50 と 0.05 になります。いずれかが設定されている場合は、以前の値を保持します。

パラメータ

氏名	型	説明
`isEnabled`	`Boolean`	反復計算を有効にするには `true`、それ以外の場合は `false` を指定します。

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`setMaxIterativeCalculationCycles(maxIterations)`

反復計算中に実行する計算の反復の最大回数を設定します。この値は 1 ～ 10,000 の間で指定する必要があります。デフォルトは 50 です。

パラメータ

氏名	型	説明
`maxIterations`	`Integer`	計算の反復回数の最大数（1 ～ 10,000）。

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`setNamedRange(name, range)`

範囲に名前を付けます。

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

パラメータ

氏名	型	説明
`name`	`String`	範囲に付ける名前。
`range`	`Range`	範囲の指定。

承認

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

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

`setRecalculationInterval(recalculationInterval)`

このスプレッドシートを再計算する頻度を設定します。

パラメータ

氏名	型	説明
`recalculationInterval`	`RecalculationInterval`	新しい再計算の間隔です。

戻る

Spreadsheet - 連結用のこのスプレッドシート。

承認

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

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

`setRowHeight(rowPosition, height)`

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

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

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

パラメータ

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

戻る

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

承認

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

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

`setSpreadsheetLocale(locale)`

スプレッドシートの言語 / 地域を設定します。

パラメータ

氏名	型	説明
`locale`	`String`	使用する言語 / 地域コード（例: 「en」、「fr」、「en_US」）。

承認

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

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

`setSpreadsheetTheme(theme)`

スプレッドシートにテーマを設定します。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

パラメータ

氏名	型	説明
`theme`	`SpreadsheetTheme`	適用するテーマ。

戻る

SpreadsheetTheme - 新しい現在のテーマ。

承認

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

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

`setSpreadsheetTimeZone(timezone)`

スプレッドシートのタイムゾーンを設定します。

パラメータ

氏名	型	説明
`timezone`	`String`	「long」形式で指定されたタイムゾーン（Joda.org のリストにある「America/New_York」など）。

承認

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

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

`show(userInterface)`

ブラウザのビューポートを中央に配置したダイアログに、カスタムユーザーインターフェースコンポーネントを表示します。サーバー側のスクリプトの実行は停止されません。サーバー側と通信するには、ユーザーインターフェースコンポーネントをサーバー側のスクリプトに非同期でコールバックする必要があります。

以前に閉じたダイアログがサーバー側のスクリプトによって以前に表示された場合、既存のダイアログは新しくリクエストされたダイアログのユーザーインターフェースに置き換えられます。

次のコードスニペットは、指定されたタイトル、高さ、幅を持つシンプルな HtmlService アプリをダイアログに表示します。

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

パラメータ

氏名	型	説明
`userInterface`	`Object`	`HtmlOutput`。

承認

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

https://www.googleapis.com/auth/script.container.ui

`sort(columnPosition)`

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

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

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

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

`toast(msg)`

スプレッドシートの右下に、該当のメッセージを含むポップアップウィンドウが表示されます。

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

パラメータ

氏名	型	説明
`msg`	`String`	トーストに表示されるメッセージ。

承認

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

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

`toast(msg, title)`

スプレッドシートの右下に、特定のメッセージとタイトルを含むポップアップウィンドウを表示します。

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

パラメータ

氏名	型	説明
`msg`	`String`	トーストに表示されるメッセージ。
`title`	`String`	トーストのタイトル（省略可）。

承認

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

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

`toast(msg, title, timeoutSeconds)`

スプレッドシートの右下に特定のタイトルとメッセージを示すポップアップウィンドウを表示し、一定期間表示されるようにします。

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

パラメータ

氏名	型	説明
`msg`	`String`	トーストに表示されるメッセージ。
`title`	`String`	トーストのタイトル（省略可）。
`timeoutSeconds`	`Number`	タイムアウト（秒）。`null` の場合、トーストはデフォルトで 5 秒です。負の場合、トーストは閉じられるまで残ります。

承認

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

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

`unhideColumn(column)`

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

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

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

パラメータ

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

承認

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

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

`unhideRow(row)`

指定した範囲内の行を再表示します。

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

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

パラメータ

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

承認

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

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

`updateMenu(name, subMenus)`

addMenu(name, subMenus) によって追加されたメニューを更新します。addMenu(name, subMenus) と同様に動作します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

パラメータ

氏名	型	説明
`name`	`String`	更新するメニューの名前。
`subMenus`	`Object[]`	`name` パラメータと `functionName` パラメータを含む JavaScript マップの配列。`Library.libFunction1` などの組み込みライブラリの関数を使用できます。

承認

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

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

スプレッドシートで現在の実行がすべて完了するまで待機し、指定した秒数が経過するとタイムアウトします。タイムアウト時に実行が完了していない場合に例外をスローしますが、データ実行はキャンセルしません。

パラメータ

氏名	型	説明
`timeoutInSeconds`	`Integer`	データの実行を待つ時間（秒）。最大値は 300 秒です。

承認

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

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

サポート終了のメソッド

`getSheetProtection()`

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

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

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

var 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.
var users = permissions.getUsers();
Logger.log(users);

戻る

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

承認

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

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

`isAnonymousView()`

非推奨。2014 年 1 月の時点で、この関数のサポートは終了しており、新しいバージョンの Google スプレッドシートではご利用いただけません。

ドキュメントで匿名の閲覧が許可されているかどうかを示します。これは、Google スプレッドシートの新しいバージョンではサポートされなくなったため、代わりに File.getSharingAccess() と File.getSharingPermission() を使用してください。

// Determine if the document allows anonymous viewing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission != DriveApp.Permission.NONE;

戻る

Boolean - ドキュメントで匿名の閲覧が許可されている場合は true、そうでない場合は false。

承認

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

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

`isAnonymousWrite()`

非推奨。2014 年 1 月の時点で、この関数のサポートは終了しており、新しいバージョンの Google スプレッドシートではご利用いただけません。

ドキュメントで匿名ユーザーによる編集が許可されているかどうかを示します。Google スプレッドシートの新しいバージョンではサポートされなくなったため、代わりに File.getSharingAccess() と File.getSharingPermission() を使用してください。

// Determine if the document allow anonymous edits via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission == DriveApp.Permission.EDIT;

戻る

Boolean - ドキュメントで匿名の編集が許可されている場合は true、そうでない場合は false。

承認

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

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

`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`

非推奨。2014 年 1 月の時点で、この関数のサポートは終了しており、新しいバージョンの Google スプレッドシートではご利用いただけません。

匿名の読み取りと書き込みに関するドキュメントのポリシーを設定します。Google スプレッドシートの新しいバージョンではサポートされなくなったため、代替手段として File.setSharing(accessType, permissionType) を使用してください。

// Set the document's policy on anonymous reading and writing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApi.Access.PRIVATE, file.getSharingPermission());

パラメータ

氏名	型	説明
`anonymousReadAllowed`	`Boolean`	匿名読み取りを許可する場合は `true`、それ以外の場合は `false` を指定します。
`anonymousWriteAllowed`	`Boolean`	匿名読み取りを許可する場合は `true`、それ以外の場合は `false` を指定します。

承認

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

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

`setSheetProtection(permissions)`

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

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

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

var permissions = sheet.getSheetProtection();

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

パラメータ

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

承認

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

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