Class Spreadsheet

スプレッドシート

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

メソッド

メソッド	戻り値の型	概要
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)

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

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

パラメータ

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

戻る

Spreadsheet - チェーン用のスプレッドシート。

承認

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

パラメータ

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

戻る

Spreadsheet - チェーン用のスプレッドシート。

承認

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

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

パラメータ

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

戻る

Spreadsheet - チェーン用のスプレッドシート。

承認

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

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

パラメータ

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

指定されたユーザーを Spreadsheet の編集者のリストに追加します。ユーザーがすでに視聴者のリストに登録されている場合、このメソッドはユーザーを視聴者のリストから除外します。

パラメータ

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

指定したユーザーを Spreadsheet の視聴者のリストに追加します。ユーザーがすでに編集者のリストに登録されている場合、このメソッドは効果がありません。

パラメータ

名前	型	説明
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 を返します。デフォルトでは、スプレッドシート、シート、行、列に関連付けられたすべてのメタデータが考慮されます。

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

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

戻る

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

関連情報

• setActiveRange(range)

---

getActiveRangeList()

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

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

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

戻る

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

承認

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

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

関連情報

• setActiveRangeList(rangeList)

---

getActiveSheet()

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

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

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

戻る

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

---

getAs(contentType)

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

コンバージョンの日別割り当てを表示するには、Google サービスの割り当てをご覧ください。新しく作成された Google Workspace ドメインには、一時的に厳しい割り当てが適用される場合があります。

パラメータ

名前	型	説明
contentType	String	変換する MIME タイプ。ほとんどの blob の場合、'application/pdf' が唯一の有効なオプションです。BMP、GIF、JPEG、PNG 形式の画像の場合は、'image/bmp'、'image/gif'、'image/jpeg'、'image/png' のいずれも有効です。Google ドキュメント ドキュメントの場合は、'text/markdown' も有効です。

戻る

Blob - BLOB としてのデータ。

---

getBandings()

このスプレッドシート内のすべてのバンドを返します。

// 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 an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

戻る

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

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

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

---

getDataSourceRefreshSchedules()

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

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

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

戻る

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

承認

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

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

---

getDataSourceSheets()

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

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// 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 the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

戻る

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

承認

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

---

getDataSources()

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

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// 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 the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

戻る

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

承認

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

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

戻る

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 の関連付けを取得することもできます。

// 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 the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

戻る

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

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

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

---

getIterativeCalculationConvergenceThreshold()

反復計算で使用されるしきい値を返します。連続した計算の結果の差がこの値未満になると、反復計算は停止します。

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

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.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()

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

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

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.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('TaxRates')、getRangeByName('Sheet Name!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()

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

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

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

戻る

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

スプレッドシートのロケールを取得します。

// 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 the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

戻る

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

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

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

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

戻る

String - タイムゾーン（「長い」形式で指定します。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)

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

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

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

パラメータ

名前	型	説明
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() メソッドを使用して、特定のデータソース タイプのデータ実行を有効にします。

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setTableProjectId('bigquery-public-data')
 .setDatasetId('ncaa_basketball')
 .setTableId('mbb_historical_teams_games')
 .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

パラメータ

名前	型	説明
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	テンプレート シート オブジェクトのすべてのデータが新しいシートにコピーされます。シート テンプレートは、スプレッドシート オブジェクトのシートの一つである必要があります。

戻る

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	テンプレート シート オブジェクトのすべてのデータが新しいシートにコピーされます。シート テンプレートは、この Spreadsheet オブジェクトのシートの一つである必要があります。

戻る

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	テンプレート シート オブジェクトのすべてのデータが新しいシートにコピーされます。シート テンプレートは、スプレッドシート オブジェクトのシートの一つである必要があります。

戻る

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	テンプレート シート オブジェクトのすべてのデータが新しいシートにコピーされます。シート テンプレートは、スプレッドシート オブジェクトのシートの一つである必要があります。

戻る

Sheet - 新しいシート。

承認

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

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

---

insertSheetWithDataSourceTable(spec)

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

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

パラメータ

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

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

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

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.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 シートを作成し、指定されたグラフをそのシートに移動します。グラフがすでに独自のシートに配置されている場合は、新しいシートを作成せずにそのシートが返されます。