スプレッドシート シートにアクセスして変更します。一般的なオペレーションでは、シートの名前の変更や、シートから範囲オブジェクトへのアクセスが行われます。
Methods
詳細なドキュメント
activate()
このシートを有効にします。シート自体は変更されず、アクティブなシートの親の概念のみが変更されます。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.activate();
戻る
Sheet
- 新しくアクティブになったシート。
addDeveloperMetadata(key)
指定したキーを持つデベロッパー メタデータをシートに追加します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' to the developer metadata for the sheet. sheet.addDeveloperMetadata('NAME'); // Gets the updated metadata info and logs it to the console. console.log(sheet.getDeveloperMetadata()[0].getKey());
パラメータ
氏名 | 型 | 説明 |
---|---|---|
key | String | 新しいデベロッパー メタデータのキー。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, visibility)
指定したキーとデベロッパー シートを持つデベロッパー メタデータをシートに追加します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' and sets the developer metadata visibility to PROJECT // for the sheet. sheet.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getVisibility().toString());
パラメータ
氏名 | 型 | 説明 |
---|---|---|
key | String | 新しいデベロッパー メタデータのキー。 |
visibility | DeveloperMetadataVisibility | 新しいデベロッパー メタデータの公開設定。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, value)
指定したキーと値を持つデベロッパー メタデータをシートに追加します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for the sheet. sheet.addDeveloperMetadata('COMPANY', 'TECH'); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());
パラメータ
氏名 | 型 | 説明 |
---|---|---|
key | String | 新しいデベロッパー メタデータのキー。 |
value | String | 新しいデベロッパー メタデータの値。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, value, visibility)
指定したキー、値、公開設定を含むデベロッパー メタデータをシートに追加します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and sets the // visibility to DOCUMENT for the sheet. sheet.addDeveloperMetadata( 'COMPANY', 'TECH', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
パラメータ
氏名 | 型 | 説明 |
---|---|---|
key | String | 新しいデベロッパー メタデータのキー。 |
value | String | 新しいデベロッパー メタデータの値。 |
visibility | DeveloperMetadataVisibility | 新しいデベロッパー メタデータの公開設定。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
appendRow(rowContents)
シートの現在のデータ領域の下部に行を追加します。
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
asDataSourceSheet()
シートのタイプが SheetType.DATASOURCE
である場合は DataSourceSheet
として、それ以外の場合は null
を返します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the data source sheet value if the sheet is of type // SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value. const dataSourceSheet = sheet.asDataSourceSheet(); // Gets the data source sheet value and logs it to the console. console.log(dataSourceSheet); console.log(sheet.getType().toString());
戻る
DataSourceSheet
- データソース シート
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumn(columnPosition)
列の情報に合わせて特定の列の幅を設定します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...'); // Sets the first column to a width which fits the text sheet.autoResizeColumn(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnPosition | Integer | サイズ変更する列の位置。 |
戻る
Sheet
- メソッド チェーンに便利なシート
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(startColumn, numColumns)
特定の列位置から始まるすべての列の幅を、内容に合わせて設定します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first 15 columns to a width that fits their text. sheet.autoResizeColumns(1, 15);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
startColumn | Integer | 自動サイズ変更の開始列。 |
numColumns | Integer | 自動的にサイズ変更される列の数。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeRows(startRow, numRows)
特定の行位置から始まるすべての行の高さを、そのコンテンツに合うように設定します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first 15 rows to a height that fits their text. sheet.autoResizeRows(1, 15);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
startRow | Integer | 自動サイズ変更の開始行。 |
numRows | Integer | 自動サイズ変更する行数。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clear()
コンテンツと書式情報のシートを削除します。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clear();
戻る
Sheet
- クリアされたシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clear(options)
指定された詳細オプションで指定されているコンテンツまたは形式のシートを削除します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.clear({ formatOnly: true, contentsOnly: true });
パラメータ
氏名 | 型 | 説明 |
---|---|---|
options | Object | 詳細オプションを含む JavaScript マップを以下に示します。 |
拡張パラメータ
氏名 | 型 | 説明 |
---|---|---|
contentsOnly | Boolean | コンテンツを削除するかどうか。 |
formatOnly | Boolean | 形式を削除するかどうか。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearConditionalFormatRules()
シートから条件付き書式ルールをすべて削除します。これは、入力として空の配列を使用して setConditionalFormatRules(rules)
を呼び出す場合と同じです。
var sheet = SpreadsheetApp.getActiveSheet(); sheet.clearConditionalFormatRules();
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearContents()
書式情報を維持したまま、コンテンツのシートをクリアします。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearContents();
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearFormats()
コンテンツを保持しながら、フォーマット シートをクリアします。
書式設定とは、セルの幅と高さではなく、[表示形式] メニューで選択した形式(太字、斜体、条件付き書式など)でデータの形式を指定することを意味します。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearFormats();
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearNotes()
すべてのメモのシートを削除します。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearNotes();
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
collapseAllColumnGroups()
シートのすべての列グループを閉じます。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are collapsed. sheet.collapseAllColumnGroups();
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
collapseAllRowGroups()
シートのすべての行グループを折りたたみます。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are collapsed. sheet.collapseAllRowGroups();
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyTo(spreadsheet)
指定したスプレッドシート(ソースと同じスプレッドシート)にシートをコピーします。コピーしたシートの名前は「[元の名前] のコピー」です。
var source = SpreadsheetApp.getActiveSpreadsheet(); var sheet = source.getSheets()[0]; var destination = SpreadsheetApp.openById('ID_GOES HERE'); sheet.copyTo(destination);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
spreadsheet | Spreadsheet | このシートのコピー先のスプレッドシート(ソースと同じスプレッドシート)。 |
戻る
Sheet
- チェーンに使用する新しいシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDeveloperMetadataFinder()
このシートのスコープ内でデベロッパー メタデータを見つけるための DeveloperMetadataFinder
を返します。メタデータは、シート自体に関連付けられているか、そのシートの行、列、または範囲に関連付けられている場合、特定のシートのスコープになります。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Creates the developer metadata finder. const metadatafinder = sheet.createDeveloperMetadataFinder(); // Finds the metadata with value 'PARIS' and displays its key in the console. console.log(metadatafinder.withValue('PARIS').find()[0].getKey());
戻る
DeveloperMetadataFinder
- このシートの範囲でメタデータを検索するデベロッパー メタデータの検索。
createTextFinder(findText)
シート内のテキストを検索して置換できる、テキスト ファインダーを作成します。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Creates a text finder. var textFinder = sheet.createTextFinder('dog'); // Returns the first occurrence of 'dog' in the sheet. var firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. var numOccurrencesReplaced = findOccurrence.replaceWith('cat');
パラメータ
氏名 | 型 | 説明 |
---|---|---|
findText | String | 検索するテキストです。 |
戻る
TextFinder
- シートの TextFinder
。
deleteColumn(columnPosition)
指定した列位置の列を削除します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first column sheet.deleteColumn(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
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
expandAllColumnGroups()
シートのすべての列グループを展開します。このメソッドには、少なくとも 1 つの列グループが必要です。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are expanded. sheet.expandAllColumnGroups();
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
expandAllRowGroups()
シートのすべての行グループを展開します。このメソッドには、少なくとも 1 つの行グループが必要です。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are expanded. sheet.expandAllRowGroups();
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
expandColumnGroupsUpToDepth(groupDepth)
指定した深度まですべての列グループを展開し、その他のすべての行グループを閉じます。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandColumnGroupsUpToDepth(2);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
groupDepth | Integer | 列グループを開くグループの深さ。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
expandRowGroupsUpToDepth(groupDepth)
すべての行グループを、指定した深度まで展開し、他のすべての行グループを折りたたみます。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandRowGroupsUpToDepth(2);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
groupDepth | Integer | 行グループを開くグループの深さ。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getActiveCell()
このシートの有効なセルを返します。
注:現在のハイライト表示されたセルを返す getCurrentCell()
を使用することをおすすめします。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Returns the active cell var cell = sheet.getActiveCell();
戻る
Range
- 現在アクティブなセル
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getActiveRange()
アクティブ シートで選択した範囲を返します。有効な範囲がない場合は null
を返します。複数の範囲が選択されている場合、このメソッドは、最後に選択された範囲のみを返します。
「アクティブ範囲」という用語は、ユーザーがアクティブ シートで選択した範囲を指しますが、カスタム関数では、アクティブに再計算されるセルを指します。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var activeRange = sheet.getActiveRange();
戻る
Range
- アクティブ範囲
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
関連ドキュメント
getActiveRangeList()
アクティブ シート内のアクティブな範囲のリストを返します。アクティブな範囲がない場合は null
を返します。
単一の範囲が選択されている場合、getActiveRange()
呼び出しとして機能します。
var sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. var activeRangeList = sheet.getActiveRangeList();
戻る
RangeList
- アクティブ範囲のリスト
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
関連ドキュメント
getBandings()
このシートのすべての縞模様を返します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the banding info for the sheet. const bandings = sheet.getBandings(); // Gets info on the bandings' second row color and logs it to the console. for (const banding of bandings) { console.log(banding.getSecondRowColor()); }
戻る
Banding[]
- このシートのすべての縞線。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCharts()
このシートでグラフの配列を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; // Do something with the chart }
戻る
EmbeddedChart[]
- グラフの配列。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnGroup(columnIndex, groupDepth)
指定されたインデックスとグループの深度にある列グループを返します。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at column 2 and has a depth of 1, or // null if the group doesn’t exist. var columnGroup = sheet.getColumnGroup(2, 1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnIndex | Integer | グループ コントロールの切り替え列のインデックスまたはグループ内のインデックス。 |
groupDepth | Integer | グループの階層。 |
戻る
Group
- コントロール インデックスと深度の列グループ。グループが存在しない場合は例外をスローします。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnGroupControlPosition()
シート内のすべての列グループの GroupControlTogglePosition
を返します。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the // group. var columnGroupControlPosition = sheet.getColumnGroupControlPosition();
戻る
GroupControlTogglePosition
- 列のグループ切り替えコントロールの切り替えが、このシート上のグループの後に表示される場合は true
、それ以外の場合は false
です。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnGroupDepth(columnIndex)
指定されたインデックスにおける列のグループ深度を返します。
グループの深度は、列と重複するグループの数を示します。範囲は 0 ~ 8 です。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over columns 1 through 3 var groupDepth = sheet.getColumnGroupDepth(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnIndex | Integer | 列のインデックス。 |
戻る
Integer
- 指定されたインデックスにおける列のグループ深度。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnPosition)
指定した列の幅(ピクセル単位)を取得します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnPosition | Integer | 検証する列の位置。 |
戻る
Integer
- 列幅(ピクセル単位)
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getConditionalFormatRules()
このシート内のすべての条件付き書式ルールを取得します。
// Logs the conditional format rules in a sheet. var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules(); for (var i = 0; i < rules.length; i++) { var rule = rules[i]; Logger.log(rule); }
戻る
ConditionalFormatRule[]
- シート内のすべてのルールの配列。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCurrentCell()
アクティブなシート内の現在のセル、または現在のセルがない場合は null
を返します。現在のセルは、Google スプレッドシートの UI でフォーカスされているセルで、暗い枠線でハイライト表示されます。現在のセルは 1 つだけです。ユーザーが 1 つ以上のセル範囲を選択すると、選択範囲内のセルが現在のセルになります。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. var currentCell = sheet.getCurrentCell();
戻る
Range
- 現在のセル
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataRange()
データが存在するディメンションに対応する Range
を返します。
これは、A1 と Sheet.getLastColumn()(Sheet.getLastRow())にバインドされた範囲を作成するのと機能的には同じです。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This represents ALL the data var range = sheet.getDataRange(); var values = range.getValues(); // This logs the spreadsheet in CSV format with a trailing comma for (var i = 0; i < values.length; i++) { var row = ""; for (var j = 0; j < values[i].length; j++) { if (values[i][j]) { row = row + values[i][j]; } row = row + ","; } Logger.log(row); }
戻る
Range
- スプレッドシート内のすべてのデータで構成される範囲
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormulas()
すべてのデータソースの数式を取得します。
戻る
DataSourceFormula[]
- データソースの数式のリスト。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourcePivotTables()
すべてのデータソース ピボット テーブルを取得します。
戻る
DataSourcePivotTable[]
- データソースのピボット テーブルのリスト。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceTables()
すべてのデータソース テーブルを取得します。
戻る
DataSourceTable[]
- データソース テーブルのリスト。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDeveloperMetadata()
このシートに関連付けられているすべてのデベロッパー メタデータを取得します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Gets all the developer metadata for the sheet. const developerMetaDataList = sheet.getDeveloperMetadata(); // Logs the developer metadata to the console. for (const developerMetaData of developerMetaDataList) { console.log(developerMetaData.getKey()); }
戻る
DeveloperMetadata[]
- このシートに関連付けられているデベロッパー メタデータ。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDrawings()
シート上の図形描画の配列を返します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the drawings from the sheet. const allDrawings = sheet.getDrawings(); // Logs the number of drawings present on the sheet. console.log(allDrawings.length);
戻る
Drawing[]
- このシート上の図形描画のリスト。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilter()
このシートのフィルタを返します。フィルタがない場合は null
を返します。
// Gets the filter on the active sheet. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter();
戻る
Filter
- フィルタ。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormUrl()
回答をこのシートに送信するフォームの URL を返します。このシートに関連フォームがない場合は null
を返します。
var sheet = SpreadsheetApp.getActiveSheet(); var url = sheet.getFormUrl();
戻る
String
- 回答をこのシートに配置するフォームの URL。このシートに関連フォームがない場合は null
。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFrozenColumns()
固定された列の数を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());
戻る
Integer
- 固定された列の数
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFrozenRows()
固定された行の数を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());
戻る
Integer
- 固定された行数
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getImages()
シート上のすべてのグリッド画像を返します。
戻る
OverGridImage[]
- グリッド画像の配列。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getIndex()
親スプレッドシート内のシートの位置を取得します。1 から開始します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); // Note that the JavaScript index is 0, but this logs 1 var sheet = ss.getSheets()[0]; // ... because spreadsheets are 1-indexed Logger.log(sheet.getIndex());
戻る
Integer
- 親スプレッドシート内のシートの位置。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastColumn()
コンテンツが含まれている最後の列の位置を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
戻る
Integer
- コンテンツを含むシートの最後の列
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastRow()
コンテンツが含まれている最後の行の位置を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
戻る
Integer
- コンテンツを含むシートの最後の行
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getMaxColumns()
内容に関係なく、シート内の現在の列数を返します。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxColumns());
戻る
Integer
- シートの最大幅。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getMaxRows()
内容に関係なく、シートの現在の行数を返します。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxRows());
戻る
Integer
- シートの最大高。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getName()
getNamedRanges()
このシートのすべての名前付き範囲を取得します。
// The code below logs the name of the first named range. var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges(); if (namedRanges.length > 1) { Logger.log(namedRanges[0].getName()); }
戻る
NamedRange[]
- シート内のすべての名前付き範囲の配列。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getParent()
このシートを含む Spreadsheet
を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // parent is identical to ss var parent = sheet.getParent();
戻る
Spreadsheet
- 親スプレッドシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getPivotTables()
このシート上のすべてのピボット テーブルを返します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the pivot table info for the sheet. const pivotTables = sheet.getPivotTables(); // Logs the pivot tables to the console. for (const pivotTable of pivotTables) { console.log(pivotTable.getSourceDataRange().getValues()); }
戻る
PivotTable[]
- このシートのピボット テーブル。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getProtections(type)
シート内のすべての保護範囲を表すオブジェクトの配列、またはシート自体の保護を表す単一要素配列を取得します。
// Remove all range protections in the spreadsheet that the user has permission to edit. var sheet = SpreadsheetApp.getActiveSheet(); var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE); for (var i = 0; i < protections.length; i++) { var protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
// Remove sheet protection from the active sheet, if the user has permission to edit it. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0]; if (protection && protection.canEdit()) { protection.remove(); }
パラメータ
氏名 | 型 | 説明 |
---|---|---|
type | ProtectionType | 保護領域のタイプ(SpreadsheetApp.ProtectionType.RANGE または SpreadsheetApp.ProtectionType.SHEET )。 |
戻る
Protection[]
- シート内の保護されたすべての範囲を表すオブジェクトの配列、またはシート自体の保護を表す単一要素の配列。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(row, column)
特定の座標で、左上のセルを含む範囲を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Passing only two arguments returns a "range" with a single cell. var range = sheet.getRange(1, 1); var values = range.getValues(); Logger.log(values[0][0]);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
row | Integer | 返すセルの行インデックス。行のインデックスは 1 から始まります。 |
column | Integer | 返されるセルの列インデックスです。列のインデックスは 1 から始まります。 |
戻る
Range
- このセルのみを含む範囲。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(row, column, numRows)
特定の座標で、指定した数の行の左上にあるセルを含む範囲を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // When the "numRows" argument is used, only a single column of data is returned. var range = sheet.getRange(1, 1, 3); var values = range.getValues(); // Prints 3 values from the first column, starting from row 1. for (var row in values) { for (var col in values[row]) { Logger.log(values[row][col]); } }
パラメータ
氏名 | 型 | 説明 |
---|---|---|
row | Integer | 範囲の開始行インデックス。行のインデックス登録は 1 から始まります。 |
column | Integer | 範囲の列インデックス。列のインデックスは 1 から始まります。 |
numRows | Integer | 返される行数。 |
戻る
Range
- 指定した行数を含む単一のデータ列を含む範囲。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(row, column, numRows, numColumns)
指定された座標と、指定された行数と列数の左上のセルを含む範囲を返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange(1, 1, 3, 3); var values = range.getValues(); // Print values from a 3x3 box. for (var row in values) { for (var col in values[row]) { Logger.log(values[row][col]); } }
パラメータ
氏名 | 型 | 説明 |
---|---|---|
row | Integer | 範囲の開始行インデックス。行のインデックス登録は 1 から始まります。 |
column | Integer | 範囲の開始列のインデックス。列のインデックスは 1 から始まります。 |
numRows | Integer | 返される行数。 |
numColumns | Integer | 返される列の数。 |
戻る
Range
- 指定した領域に対応する範囲。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(a1Notation)
A1 表記または R1C1 表記で指定された範囲を返します。
// Get a range A1:D4 on sheet titled "Invoices" 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
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
getRowGroup(rowIndex, groupDepth)
指定されたインデックスとグループの深度にある行グループを返します。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at row 2 and has a depth of 1, or // null if the group doesn’t exist. var rowGroup = sheet.getRowGroup(2, 1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowIndex | Integer | グループ コントロール切り替えの行インデックス、またはグループ内のインデックス。 |
groupDepth | Integer | グループの階層。 |
戻る
Group
- コントロール インデックスと深度にある行グループ。グループが存在しない場合は例外をスローします。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowGroupControlPosition()
シートのすべての行グループの GroupControlTogglePosition
を返します。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the // group. var rowGroupControlPosition = sheet.getRowGroupControlPosition();
戻る
GroupControlTogglePosition
- このグループのグループの後に行グループ化コントロールを切り替える場合は true
、それ以外の場合は false
です。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowGroupDepth(rowIndex)
指定したインデックスの行のグループ深度を返します。
グループの階層は、その行と重複するグループの数を示します。範囲は 0 ~ 8 です。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over rows 1 through 3 var groupDepth = sheet.getRowGroupDepth(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowIndex | Integer | 行のインデックス。 |
戻る
Integer
- 指定されたインデックスの行のグループ深度。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowHeight(rowPosition)
指定した行の高さをピクセル単位で取得します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
パラメータ
氏名 | 型 | 説明 |
---|---|---|
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
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()
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
getSlicers()
シート上のスライサーの配列を返します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all slicers in the spreadsheet. const slicers = sheet.getSlicers(); // Logs the slicer titles to the console. for (const slicer of slicers) { console.log(slicer.getTitle()); }
戻る
Slicer[]
- このシート上のスライサーのリスト。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTabColorObject()
シートタブの色を取得します。シートタブに色がない場合は null
を取得します。
// This example assumes there is a sheet named "Sheet1" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = first.getTabColorObject();
戻る
Color
- シートタブの色、またはシートタブに色がない場合は null
。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getType()
シートのタイプを返します。
デフォルトのシートタイプは SheetType.GRID
です。EmbeddedChart
などの埋め込みオブジェクトが 1 つ含まれているシートは SheetType.OBJECT
シートになります。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getType());
戻る
SheetType
- シートのタイプ。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hasHiddenGridlines()
シートのグリッド線が隠れている場合は true
を返し、そうでない場合は false
を返します。グリッド線はデフォルトで表示されます。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if the spreadsheet has hidden gridelines and logs the result to the console. console.log(sheet.hasHiddenGridlines());
戻る
Boolean
- グリッド線が非表示の場合は true
、それ以外の場合は false
。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideColumn(column)
指定した範囲の列を非表示にします。
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // This hides the first column let range = sheet.getRange("A1"); sheet.hideColumn(range); // This hides the first 3 columns let range = sheet.getRange("A:C"); sheet.hideColumn(range);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
column | Range | 非表示にする列の範囲。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideColumns(columnIndex)
指定されたインデックスで単一の列を非表示にします。このメソッドでは 1 のインデックスを使用します。
インデックスを使用して複数の列を非表示にするには、hideColumns(columnIndex, numColumns)
を使用します。
範囲を使用して複数の列を非表示にするには、hideColumn()
を使用します。
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // Hides the first column sheet.hideColumns(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnIndex | Integer | 非表示にする列のインデックス。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideColumns(columnIndex, numColumns)
指定されたインデックスで始まる 1 つ以上の連続する列を非表示にします。このメソッドでは 1 のインデックスを使用します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first three columns sheet.hideColumns(1, 3);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnIndex | Integer | 非表示にする列の開始インデックス。 |
numColumns | Integer | 非表示にする列の数。 |
承認
このメソッドを使用するスクリプトには、次の 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
hideRows(rowIndex)
指定されたインデックスの行を非表示にします。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first row sheet.hideRows(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowIndex | Integer | 非表示にする行のインデックス。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideRows(rowIndex, numRows)
指定されたインデックスで始まる 1 つ以上の連続する行を非表示にします。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first three rows sheet.hideRows(1, 3);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowIndex | Integer | 非表示にする行の開始インデックス。 |
numRows | Integer | 非表示にする行数。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideSheet()
このシートを非表示にします。シートがすでに非表示になっている場合、影響はありません。このメソッドを唯一の表示シートで呼び出すと、例外がスローされます。
var sheet = SpreadsheetApp.getActiveSheet(); sheet.hideSheet();
戻る
Sheet
- 現在のシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertChart(chart)
このシートに新しいグラフを追加します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This creates a simple bar chart from the first three rows // of the first two columns of the spreadsheet var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange("A1:B4")) .setPosition(5, 5, 0, 0) .setOption("title", "Dynamic Chart") .build(); sheet.insertChart(chart);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
chart | EmbeddedChart | 挿入するグラフ。 |
承認
このメソッドを使用するスクリプトには、次の 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
insertColumns(columnIndex)
指定した位置に空白の列を挿入します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all columns by one sheet.insertColumns(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnIndex | Integer | 列を挿入する場所を示すインデックス。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumns(columnIndex, numColumns)
指定した位置から 1 つ以上の連続した空白の列をシートに挿入します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all columns by three sheet.insertColumns(1, 3);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnIndex | Integer | 列を挿入する場所を示すインデックス。 |
numColumns | Integer | 挿入する列の数。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumnsAfter(afterPosition, howMany)
指定した列位置の後に、複数の列を挿入します。
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
insertImage(blobSource, column, row)
指定した行と列のドキュメントに、BlobSource
を画像として挿入します。画像サイズは blob コンテンツから取得されます。blob の最大サイズは 2 MB です。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
blobSource | BlobSource | 画像コンテンツ、MIME タイプ、(省略可)名前を含む blob。 |
column | Integer | 列の位置。 |
row | Integer | 行の位置。 |
戻る
OverGridImage
- 挿入された画像。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(blobSource, column, row, offsetX, offsetY)
ドキュメント内の特定の行と列に、ピクセル単位のオフセットで、BlobSource
を画像として挿入します。画像サイズは blob コンテンツから取得されます。blob の最大サイズは 2 MB です。
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
insertRows(rowIndex)
指定した位置に空白行を挿入します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all rows down by one sheet.insertRows(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowIndex | Integer | 行を挿入する場所を示すインデックス。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRows(rowIndex, numRows)
指定した位置から 1 つ以上の連続した空白行をシートに挿入します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all rows down by three sheet.insertRows(1, 3);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowIndex | Integer | 行を挿入する場所を示すインデックス。 |
numRows | Integer | 挿入する行数。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowsAfter(afterPosition, howMany)
指定した行位置の後に、複数の行を挿入します。
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
insertSlicer(range, anchorRowPos, anchorColPos)
このシートに新しいスライサーを追加します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range of the sheet. const range = sheet.getRange('A1:D10'); // Inserts the slicer with a random range into the sheet. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10); // Logs the insert slicer result to the console. console.log(insertSlicers);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
range | Range | スライサー スライサーが作成される範囲。 |
anchorRowPos | Integer | スライサーの上面がこの行に固定されています。 |
anchorColPos | Integer | スライサーの上面がこの色で固定されます。 |
戻る
Slicer
- 新しく挿入されたスライサー。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)
このシートに新しいスライサーを追加します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range. const range = sheet.getRange('A1:D10'); // Inserts a slicer using the random range function. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0); // Logs the insert slicer result to the console. console.log(insertSlicers);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
range | Range | スライサー スライサーが作成される範囲。 |
anchorRowPos | Integer | スライサーの上面がこの行に固定されています。 |
anchorColPos | Integer | スライサーの上面がこの色で固定されます。 |
offsetX | Integer | セルの角からの水平オフセット(ピクセル単位)。 |
offsetY | Integer | セルの角からの垂直オフセット(ピクセル単位)。 |
戻る
Slicer
- 新しく挿入されたスライサー。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isColumnHiddenByUser(columnPosition)
指定した列がユーザーによって非表示になっているかどうかを返します。
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
isRightToLeft()
このシート レイアウトが右から左の場合、true
を返します。シートがデフォルトの左から右へのレイアウトを使用している場合に、false
を返します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if a spreadsheet is ordered from right to left and logs the result to the console. console.log(sheet.isRightToLeft());
戻る
Boolean
— 右から左の場合は true
、それ以外の場合は false
です。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isRowHiddenByFilter(rowPosition)
指定した行がフィルタで非表示になっている(フィルタ表示ではない)かどうかを返します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByFilter(1));
パラメータ
氏名 | 型 | 説明 |
---|---|---|
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
isSheetHidden()
シートが現在非表示になっている場合は、true
を返します。
var sheet = SpreadsheetApp.getActiveSheet(); if (sheet.isSheetHidden()) { // do something... }
戻る
Boolean
- シートが非表示の場合は true
、それ以外の場合は false
。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
moveColumns(columnSpec, destinationIndex)
指定された範囲によって選択された列を、destinationIndex
で指定された位置に移動します。columnSpec
自体は、移動する列全体または列のグループを正確に表す必要はありません。範囲にまたがるすべての列を選択します。
// The code below moves rows A-B to destination index 5. // This results in those columns becoming columns C-D. var sheet = SpreadsheetApp.getActiveSheet(); // Selects column A and column B to be moved. var columnSpec = sheet.getRange("A1:B1"); sheet.moveColumns(columnSpec, 5);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnSpec | Range | 移動する列にまたがる範囲。 |
destinationIndex | Integer | 列の移動先のインデックス。このインデックスは、列が移動される前の座標に基づいています。既存の列は右に移動され、移動された列用のスペースを確保するために、ソース列はグリッドから削除されます。したがって、データは最初に指定されたインデックスとは異なるインデックスに達する可能性があります。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
moveRows(rowSpec, destinationIndex)
指定された範囲によって選択された行を、destinationIndex
で指定された位置に移動します。rowSpec
自体は、移動する行または行のグループを正確に表す必要はありません。範囲がまたがっているすべての行を選択します。
// The code below moves rows 1-2 to destination index 5. // This results in those rows becoming rows 3-4. var sheet = SpreadsheetApp.getActiveSheet(); // Selects row 1 and row 2 to be moved. var rowSpec = sheet.getRange("A1:A2"); sheet.moveRows(rowSpec, 5);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowSpec | Range | 移動する行にまたがる範囲。 |
destinationIndex | Integer | 行の移動先のインデックス。このインデックスは、行が移動される前の座標に基づいています。ソース行がグリッドから削除され、既存の行は移動された行のためにスペースを空けられます。そのため、データが最初に指定されたインデックスとは異なるインデックスに達する可能性があります。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
newChart()
このシート用に新しいグラフを作成するビルダーを返します。
次の例は、新しいグラフを作成する方法を示しています。
var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("A1:B8"); var chartBuilder = sheet.newChart(); chartBuilder.addRange(range) .setChartType(Charts.ChartType.LINE) .setPosition(2, 2, 0, 0) .setOption('title', 'My Line Chart!'); sheet.insertChart(chartBuilder.build());
戻る
EmbeddedChartBuilder
- 新しいグラフを作成するビルダー。
protect()
権限を持つユーザー以外がシートを編集しないように保護できるオブジェクトを作成します。スクリプトによって実際にシートの編集者のリストが変更されるまで(Protection.removeEditor(emailAddress)
、Protection.removeEditor(user)
、Protection.removeEditors(emailAddresses)
、Protection.addEditor(emailAddress)
、Protection.addEditor(user)
、Protection.addEditors(emailAddresses)
を呼び出すか、Protection.setDomainEdit(editable)
の新しい値を設定するまで)、権限はスプレッドシート自体の権限を反映するため、事実上、シートは保護されないままになります。シートがすでに保護されている場合、このメソッドは既存の保護設定を表すオブジェクトを返します。保護されているシートには、保護されていない領域が含まれている可能性があります。
// Protect the active sheet, then remove all other users from the list of editors. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.protect().setDescription('Sample protected sheet'); // Ensure the current user is an editor before removing others. Otherwise, if the user's edit // permission comes from a group, the script throws an exception upon removing the group. var me = Session.getEffectiveUser(); protection.addEditor(me); protection.removeEditors(protection.getEditors()); if (protection.canDomainEdit()) { protection.setDomainEdit(false); }
戻る
Protection
- 保護設定を表すオブジェクト。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeChart(chart)
親シートからグラフを削除します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This removes all the embedded charts from the spreadsheet var charts = sheet.getCharts(); for (var i in charts) { sheet.removeChart(charts[i]); }
パラメータ
氏名 | 型 | 説明 |
---|---|---|
chart | EmbeddedChart | 削除するグラフ。 |
承認
このメソッドを使用するスクリプトには、次の 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
setColumnGroupControlPosition(position)
シートでの列グループ コントロールの切り替え位置を設定します。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setColumnGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
position | GroupControlTogglePosition | 列グループのコントロールの切り替え位置。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidth(columnPosition, width)
指定した列の幅をピクセル単位で設定します。
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
setColumnWidths(startColumn, numColumns, width)
指定した列の幅をピクセル単位で設定します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three columns to a width of 200 pixels sheet.setColumnWidths(1, 3, 200);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
startColumn | Integer | 変更する開始列の位置。 |
numColumns | Integer | 変更する列の数。 |
width | Integer | 設定する幅(ピクセル単位)。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setConditionalFormatRules(rules)
シート内の既存の条件付き書式ルールをすべて入力ルールに置き換えます。ルールは入力された順序で評価されます。
// Remove one of the existing conditional format rules. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); rules.splice(1, 1); // Deletes the 2nd format rule. sheet.setConditionalFormatRules(rules);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rules | ConditionalFormatRule[] | 新しい条件付き書式ルール。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setCurrentCell(cell)
指定したセルを current cell
として設定します。
指定したセルがすでに選択範囲内に存在する場合、その範囲が、そのセルを現在のセルとするアクティブ範囲になります。
選択したセルが指定した範囲にない場合は、既存の選択内容が削除され、セルが現在のセルおよびアクティブ範囲になります。
注: 指定する Range
は、1 つのセルで構成されている必要があります。そうでない場合、例外がスローされます。
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
setHiddenGridlines(hideGridlines)
シートのグリッド線を表示または非表示にします。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Hides the gridlines in the sheet. sheet.setHiddenGridlines(true);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
hideGridlines | Boolean | true の場合は、このシートのグリッド線を非表示にします。それ以外の場合は、グリッド線を表示します。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setName(name)
シート名を設定します。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.setName("not first anymore");
パラメータ
氏名 | 型 | 説明 |
---|---|---|
name | String | シートの新しい名前。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRightToLeft(rightToLeft)
シート レイアウトを右から左に設定するか、設定を解除します。
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets the sheet layout, so that the sheet is ordered from right to left. sheet.setRightToLeft(true);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rightToLeft | Boolean | true の場合、シート レイアウトは右から左に設定され、右上にセル A1 があります。false の場合、シート レイアウトはデフォルトの左から右に設定され、セル A1 は左上になります。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowGroupControlPosition(position)
シートでの行グループ コントロールの切り替え位置を設定します。
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setRowGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
position | GroupControlTogglePosition | 行グループ コントロールの切り替え位置。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowHeight(rowPosition, height)
特定の行の行の高さをピクセル単位で設定します。デフォルトでは、行はセルのコンテンツに合わせて拡大されます。指定した高さに行を強制する場合は、setRowHeightsForced(startRow, numRows, height)
を使用します。
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
setRowHeights(startRow, numRows, height)
指定した行の高さをピクセル単位で設定します。デフォルトでは、行はセルのコンテンツに合わせて拡大されます。指定した高さに行を強制する場合は、setRowHeightsForced(startRow, numRows, height)
を使用します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 20 pixels sheet.setRowHeights(1, 3, 20);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
startRow | Integer | 変更する開始行の位置。 |
numRows | Integer | 変更する行数。 |
height | Integer | 設定する高さ(ピクセル単位)。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowHeightsForced(startRow, numRows, height)
指定した行の高さをピクセル単位で設定します。デフォルトでは、行はセルのコンテンツに合わせて拡大されます。setRowHeightsForced
を使用すると、セルの内容が行の高さよりも高い場合でも、指定された高さに行が強制されます。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 5 pixels. sheet.setRowHeightsForced(1, 3, 5);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
startRow | Integer | 変更する開始行の位置。 |
numRows | Integer | 変更する行数。 |
height | Integer | 設定する高さ(ピクセル単位)。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTabColor(color)
シートのタブの色を設定します。
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.setTabColor("ff0000"); // Set the color to red. first.setTabColor(null); // Unset the color.
パラメータ
氏名 | 型 | 説明 |
---|---|---|
color | String | CSS 表記('#ffffff' や 'white' など)のカラーコード。タブの色をリセットする場合は null 。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTabColorObject(color)
シートのタブの色を設定します。
// This example assumes there is a sheet named "Sheet1" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); first.setTabColorObject(color); // Set the color to theme accent 1. first.setTabColorObject(null); // Unset the color.
パラメータ
氏名 | 型 | 説明 |
---|---|---|
color | Color | 設定するシートのタブの色。 |
戻る
Sheet
- 連結に使用するシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showColumns(columnIndex)
指定されたインデックスで列を再表示します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first column sheet.showColumns(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnIndex | Integer | 再表示する列のインデックス。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showColumns(columnIndex, numColumns)
指定されたインデックスで始まる 1 つ以上の連続する列を再表示します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first three columns sheet.showColumns(1, 3);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
columnIndex | Integer | 再表示する列の開始インデックス。 |
numColumns | Integer | 再表示する列の数。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showRows(rowIndex)
指定されたインデックスの行を再表示します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first row sheet.showRows(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowIndex | Integer | 再表示する行のインデックス。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showRows(rowIndex, numRows)
指定されたインデックスで始まる 1 つ以上の連続した行を再表示します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first three rows sheet.showRows(1, 3);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
rowIndex | Integer | 再表示する行の開始インデックス。 |
numRows | Integer | 再表示する行数。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
showSheet()
スプレッドシートを表示します。シートがすでに表示されている場合、影響はありません。
var sheet = SpreadsheetApp.getActiveSheet(); sheet.showSheet();
戻る
Sheet
- 現在のシート。
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
sort(columnPosition)
シートを昇順で並べ替えます。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, ascending sheet.sort(1);
パラメータ
氏名 | 型 | 説明 |
---|---|---|
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
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
updateChart(chart)
このシートのグラフを更新します。
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This code is going to loop through all the charts and change them to // column charts var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; var newChart = chart .modify() .setChartType(Charts.ChartType.COLUMN) .build(); sheet.updateChart(newChart); }
パラメータ
氏名 | 型 | 説明 |
---|---|---|
chart | EmbeddedChart | 更新するグラフ。 |
承認
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets