Class NamedRange

NamedRange

スプレッドシートで名前付き範囲を作成、アクセス、変更できます。名前付き範囲とは、文字列エイリアスが関連付けられた範囲です。これらは、スプレッドシート UI の [データ] > [名前付き範囲] メニューを使用して表示および編集できます。

Methods

メソッド戻り値の型概要
getName()Stringこの名前付き範囲の名前を取得します。
getRange()Rangeこの名前付き範囲によって参照される範囲を取得します。
remove()voidこの名前付き範囲を削除します。
setName(name)NamedRange名前付き範囲の名前を設定または更新します。
setRange(range)NamedRangeこの名前付き範囲の範囲を設定または更新します。

詳細なドキュメント

getName()

この名前付き範囲の名前を取得します。

リターン

String - この名前付き範囲の名前

承認

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

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

getRange()

この名前付き範囲によって参照される範囲を取得します。

リターン

Range - この名前付き範囲に関連付けられているスプレッドシートの範囲

承認

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

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

remove()

この名前付き範囲を削除します。 

// The code below deletes all the named ranges in the spreadsheet.
var namedRanges = SpreadsheetApp.getActive().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  namedRanges[i].remove();
}

承認

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

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

setName(name)

名前付き範囲の名前を設定または更新します。

// The code below updates the name for the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
if (namedRanges.length > 1) {
  namedRanges[0].setName("UpdatedNamedRange");
}

パラメータ

名前型説明
nameString名前付き範囲の新しい名前。

リターン

NamedRange - 呼び出しによって名前が設定された範囲

承認

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

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

setRange(range)

この名前付き範囲の範囲を設定または更新します。

パラメータ

名前型説明
rangeRangeこの名前付き範囲に関連付けるスプレッドシートの範囲。

リターン

NamedRange - スプレッドシートの範囲が設定されている名前付き範囲

承認

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

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