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

Class Range

スプレッドシートの範囲へのアクセスと変更。範囲はシート内の単一のセルでも、セルのグループでも使用できます。隣接するセルを表示することもできます。

メソッド

メソッド	戻り値の型	概要
`activate()`	`Range`	指定された範囲を `active range` として設定します。範囲内の左側のセルを `current cell` として指定します。
`activateAsCurrentCell()`	`Range`	指定されたセルを `current cell` として設定します。
`addDeveloperMetadata(key)`	`Range`	指定されたキーを持つデベロッパーメタデータを範囲に追加します。
`addDeveloperMetadata(key, visibility)`	`Range`	指定されたキーと公開設定を持つデベロッパーメタデータを範囲に追加します。
`addDeveloperMetadata(key, value)`	`Range`	指定されたキーと値を持つデベロッパーメタデータを範囲に追加します。
`addDeveloperMetadata(key, value, visibility)`	`Range`	指定されたキー、値、公開設定を持つデベロッパーメタデータを範囲に追加します。
`applyColumnBanding()`	`Banding`	デフォルトの列バンディングテーマを範囲に適用します。
`applyColumnBanding(bandingTheme)`	`Banding`	指定した列バンディングテーマを範囲に適用します。
`applyColumnBanding(bandingTheme, showHeader, showFooter)`	`Banding`	指定された列帯域テーマを、指定されたヘッダーとフッターの範囲に適用します設定。
`applyRowBanding()`	`Banding`	デフォルトの行バンディングテーマを範囲に適用します。
`applyRowBanding(bandingTheme)`	`Banding`	指定した行バンディングテーマを範囲に適用します。
`applyRowBanding(bandingTheme, showHeader, showFooter)`	`Banding`	指定したヘッダーとフッターの設定がある範囲に、指定した行バンディングテーマを適用します。
`autoFill(destination, series)`	`void`	この範囲のデータに基づいて `destinationRange` にデータを入力します。
`autoFillToNeighbor(series)`	`void`	隣接するセルに基づいて新しいデータで入力範囲を計算し、自動的に入力しますその範囲に含まれるデータに基づいて新しい値で範囲が作成されます。
`breakApart()`	`Range`	範囲内の複数列のセルを再び個々のセルに分割します。
`canEdit()`	`Boolean`	範囲内のすべてのセルを編集する権限をユーザーに付与するかどうかを指定します。
`check()`	`Range`	範囲のチェックボックスの状態を「オン」に変更します。
`clear()`	`Range`	コンテンツと形式の範囲をクリアします。
`clear(options)`	`Range`	ファイアウォールルールを作成します
`clearContent()`	`Range`	書式はそのままにして、範囲の内容をクリアします。
`clearDataValidations()`	`Range`	範囲のデータ入力規則をクリアします。
`clearFormat()`	`Range`	この範囲の書式をクリアします。
`clearNote()`	`Range`	指定したセル（複数可）内のメモをクリアします。
`collapseGroups()`	`Range`	範囲内に含まれているすべてのグループを折りたたみます。
`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	範囲の書式を指定された場所にコピーします。
`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	範囲の書式を指定された場所にコピーします。
`copyTo(destination)`	`void`	セル範囲のデータを別のセル範囲にコピーします。
`copyTo(destination, copyPasteType, transposed)`	`void`	セル範囲のデータを別のセル範囲にコピーします。
`copyTo(destination, options)`	`void`	セル範囲のデータを別のセル範囲にコピーします。
`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	範囲の内容を指定された場所にコピーします。
`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	範囲の内容を指定された場所にコピーします。
`createDataSourcePivotTable(dataSource)`	`DataSourcePivotTable`	データソースから空のデータソースのピボットテーブルを作成し、選択します。
`createDataSourceTable(dataSource)`	`DataSourceTable`	データソースから空のデータソーステーブルを作成し、このテーブルの最初のセルに固定します。あります。
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	このスコープ内のデベロッパーメタデータを検索するための DeveloperMetadataFinderApi を返します。あります。
`createFilter()`	`Filter`	フィルタを作成し、シート上の指定した範囲に適用します。
`createPivotTable(sourceData)`	`PivotTable`	最初のセルに固定された、指定された `sourceData` から空のピボットテーブルを作成しますこの範囲内にあります。
`createTextFinder(findText)`	`TextFinder`	範囲のテキストファインダーを作成します。この範囲のテキストを検索して置換できます。
`deleteCells(shiftDimension)`	`void`	このセル範囲を削除します。
`expandGroups()`	`Range`	折りたたまれたグループ（範囲またはコントロールの切り替えボタン）が、この範囲と交差しているものを展開します。
`getA1Notation()`	`String`	範囲の文字列説明を A1 表記で返します。
`getBackground()`	`String`	範囲内の左上のセルの背景色を返します（例: `'#ffffff'`）。
`getBackgroundObject()`	`Color`	範囲内の左上のセルの背景色を返します。
`getBackgroundObjects()`	`Color[][]`	範囲内のセルの背景色を返します。
`getBackgrounds()`	`String[][]`	範囲内のセルの背景色を返します（例: `'#ffffff'`）。
`getBandings()`	`Banding[]`	この範囲の任意のセルに適用されるすべてのバンディングを返します。
`getCell(row, column)`	`Range`	範囲内の指定されたセルを返します。
`getColumn()`	`Integer`	この範囲の開始列の位置を返します。
`getDataRegion()`	`Range`	すべてを網羅するために、4 つの基数 `Direction` で拡張された範囲のコピーを返します。隣接するセルを表示することもできます。
`getDataRegion(dimension)`	`Range`	次の場合は、拡張された範囲の `Direction.UP` と `Direction.DOWN` のコピーを返します。指定されたディメンションが `Dimension.ROWS`、またはディメンションが `Dimension.COLUMNS` の場合は `Direction.NEXT` と `Direction.PREVIOUS`。
`getDataSourceFormula()`	`DataSourceFormula`	範囲内の最初のセルの `DataSourceFormula` を返します。それ以外の場合は `null` を返します。セルにデータソースの数式が含まれていません。
`getDataSourceFormulas()`	`DataSourceFormula[]`	範囲内のセルの `DataSourceFormula` を返します。
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	範囲と交差するすべてのデータソースのピボットテーブルを取得します。
`getDataSourceTables()`	`DataSourceTable[]`	範囲と交差するすべてのデータソーステーブルを取得します。
`getDataSourceUrl()`	`String`	この範囲のデータの URL を返します。この URL を使用してグラフやクエリを作成できます。
`getDataTable()`	`DataTable`	このオブジェクト内のデータを DataTable として返します。
`getDataTable(firstRowIsHeader)`	`DataTable`	この範囲内のデータを DataTable として返します。
`getDataValidation()`	`DataValidation`	範囲の左上のセルのデータ入力規則を返します。
`getDataValidations()`	`DataValidation[][]`	範囲内のすべてのセルのデータ入力規則を返します。
`getDeveloperMetadata()`	`DeveloperMetadata[]`	この範囲に関連付けられているデベロッパーメタデータを取得します。
`getDisplayValue()`	`String`	範囲内の左上のセルの表示値を返します。
`getDisplayValues()`	`String[][]`	この範囲の値の長方形のグリッドを返します。
`getFilter()`	`Filter`	この範囲が属するシートのフィルタを返します。フィルタがない場合は `null` を返します。表示されます。
`getFontColorObject()`	`Color`	範囲の左上隅にあるセルのフォントの色を返します。
`getFontColorObjects()`	`Color[][]`	範囲内のセルのフォントの色を返します。
`getFontFamilies()`	`String[][]`	範囲内のセルのフォントファミリーを返します。
`getFontFamily()`	`String`	範囲の左上隅にあるセルのフォントファミリーを返します。
`getFontLine()`	`String`	範囲の左上隅にあるセルの線のスタイルを取得します（`'underline'`、 `'line-through'`、`'none'` など）。
`getFontLines()`	`String[][]`	範囲（`'underline'`、`'line-through'`、または `'none'`）。
`getFontSize()`	`Integer`	範囲の左上隅にあるセルのフォントサイズをポイントサイズで返します。
`getFontSizes()`	`Integer[][]`	範囲内のセルのフォントサイズを返します。
`getFontStyle()`	`String`	左上のセルのフォントスタイル（`'italic'` または `'normal'`）を返します。クリックします。
`getFontStyles()`	`String[][]`	範囲内のセルのフォントスタイルを返します。
`getFontWeight()`	`String`	範囲の左上隅にあるセルのフォントの太さ（標準/太字）を返します。
`getFontWeights()`	`String[][]`	範囲内のセルのフォントの太さを返します。
`getFormula()`	`String`	範囲の左上のセルの数式（A1 表記）を返します。数式が一致しない場合は空の文字列を返します。セルが空であるか、数式が含まれていません。
`getFormulaR1C1()`	`String`	指定したセルの数式（R1C1 表記）を返します。セルがない場合は `null` を返します。
`getFormulas()`	`String[][]`	範囲内のセルの数式（A1 表記）を返します。
`getFormulasR1C1()`	`String[][]`	範囲内のセルの数式（R1C1 表記）を返します。
`getGridId()`	`Integer`	範囲の親シートのグリッド ID を返します。
`getHeight()`	`Integer`	範囲の高さを返します。
`getHorizontalAlignment()`	`String`	左上のセルのテキストの水平方向の配置（左/中央/右）を返します。クリックします。
`getHorizontalAlignments()`	`String[][]`	範囲内のセルの水平方向の配置を返します。
`getLastColumn()`	`Integer`	終了列の位置を返します。
`getLastRow()`	`Integer`	終了行の位置を返します。
`getMergedRanges()`	`Range[]`	完全に統合されたセルを表す `Range` オブジェクトの配列を返します。現在の範囲内に 1 つ以上のセルを含めることもできます。
`getNextDataCell(direction)`	`Range`	範囲の最初の列と行にあるセルから、次のセルを返します特定の方向（データが含まれる連続したセル範囲の端）またはセルの方向その方向の端をクリックします。
`getNote()`	`String`	指定した範囲に関連付けられたメモを返します。
`getNotes()`	`String[][]`	範囲内のセルに関連付けられたメモを返します。
`getNumColumns()`	`Integer`	この範囲の列数を返します。
`getNumRows()`	`Integer`	この範囲内の行数を返します。
`getNumberFormat()`	`String`	指定した範囲の左上のセルの数値または日付形式を取得します。
`getNumberFormats()`	`String[][]`	範囲内のセルの数値または日付形式を返します。
`getRichTextValue()`	`RichTextValue`	範囲の左上のセルのリッチテキスト値を返します。セルがセルの場合は `null` を返します。 value はテキストではありません。
`getRichTextValues()`	`RichTextValue[][]`	範囲内のセルのリッチテキスト値を返します。
`getRow()`	`Integer`	この範囲の行の位置を返します。
`getRowIndex()`	`Integer`	この範囲の行の位置を返します。
`getSheet()`	`Sheet`	この範囲が属するシートを返します。
`getTextDirection()`	`TextDirection`	範囲の左上のセルのテキスト方向を返します。
`getTextDirections()`	`TextDirection[][]`	範囲内のセルの方向を返します。
`getTextRotation()`	`TextRotation`	範囲の左上のセルのテキスト回転設定を返します。
`getTextRotations()`	`TextRotation[][]`	範囲内のセルのテキスト回転設定を返します。
`getTextStyle()`	`TextStyle`	範囲の左上のセルのテキストスタイルを返します。
`getTextStyles()`	`TextStyle[][]`	範囲内のセルのテキストスタイルを返します。
`getValue()`	`Object`	範囲内の左上のセルの値を返します。
`getValues()`	`Object[][]`	この範囲の値の長方形のグリッドを返します。
`getVerticalAlignment()`	`String`	セルの左上隅にあるセルの垂直方向の配置（上、中央、下）を返します。あります。
`getVerticalAlignments()`	`String[][]`	範囲内のセルの垂直方向の配置を返します。
`getWidth()`	`Integer`	範囲の幅を列単位で返します。
`getWrap()`	`Boolean`	セル内のテキストを折り返すかどうかを返します。
`getWrapStrategies()`	`WrapStrategy[][]`	範囲内のセルのテキストの折り返し方法を返します。
`getWrapStrategy()`	`WrapStrategy`	範囲の左上のセルのテキストの折り返し方法を返します。
`getWraps()`	`Boolean[][]`	セル内のテキストを折り返すかどうかを返します。
`insertCells(shiftDimension)`	`Range`	この範囲に空のセルを挿入します。
`insertCheckboxes()`	`Range`	範囲内の各セルにチェックボックスを挿入します。チェックボックスがオンの場合は `true`、オフの場合は `false`。
`insertCheckboxes(checkedValue)`	`Range`	範囲内の各セルにチェックボックスを挿入します。このチェックボックスは、オンにされたセルと、オフの場合は空の文字列を返します。
`insertCheckboxes(checkedValue, uncheckedValue)`	`Range`	選択範囲にカスタム値が設定された、範囲内の各セルにチェックボックスを挿入します未確認の状態を表します
`isBlank()`	`Boolean`	範囲が完全に空白の場合、`true` を返します。
`isChecked()`	`Boolean`	範囲内のすべてのセルのチェックボックスの状態が「オン」かどうかを返します。
`isEndColumnBounded()`	`Boolean`	範囲の終端を特定の列にバインドするかどうかを決定します。
`isEndRowBounded()`	`Boolean`	範囲の終端を特定の行にバインドするかどうかを決定します。
`isPartOfMerge()`	`Boolean`	現在の範囲内のセルが結合されたセルと重なっている場合、`true` を返します。
`isStartColumnBounded()`	`Boolean`	範囲の先頭を特定の列にバインドするかどうかを決定します。
`isStartRowBounded()`	`Boolean`	範囲の先頭を特定の行にバインドするかどうかを決定します。
`merge()`	`Range`	範囲内のセルを 1 つのブロックに結合します。
`mergeAcross()`	`Range`	範囲の複数の列を結合して範囲内のセルを結合します。
`mergeVertically()`	`Range`	範囲内のセルを結合します。
`moveTo(target)`	`void`	この範囲（書式と値の両方）を切り取って目的の範囲に貼り付けます。
`offset(rowOffset, columnOffset)`	`Range`	この範囲から指定された行数と列数だけオフセットされた新しい範囲を返します（負の値でもかまいません）。
`offset(rowOffset, columnOffset, numRows)`	`Range`	現在の範囲を基準として、左上の点がオフセットされた新しい範囲を返します現在の範囲から指定された行と列のセル数と、セルの高さを指定した値を返します。
`offset(rowOffset, columnOffset, numRows, numColumns)`	`Range`	現在の範囲を基準として、左上の点がオフセットされた新しい範囲を返します現在の範囲から指定した行と列で、指定された高さと幅の選択します。
`protect()`	`Protection`	アクセス権を持っているユーザー以外による範囲の編集を防止できるオブジェクトを作成します。付与します。
`randomize()`	`Range`	指定された範囲内の行の順序をランダム化します。
`removeCheckboxes()`	`Range`	範囲からすべてのチェックボックスを削除します。
`removeDuplicates()`	`Range`	この範囲内で、いずれかの値と重複する値を含む行を削除します選択します。
`removeDuplicates(columnsToCompare)`	`Range`	この範囲内で、指定された列の値が重複している行を削除します確認できます。
`setBackground(color)`	`Range`	範囲内のすべてのセルの背景色を CSS 表記（`'#ffffff'` など）で設定しますまたは `'white'`）。
`setBackgroundObject(color)`	`Range`	範囲内のすべてのセルの背景色を設定します。
`setBackgroundObjects(color)`	`Range`	背景色の長方形のグリッドを設定します（この範囲の寸法と一致する必要があります）。
`setBackgroundRGB(red, green, blue)`	`Range`	RGB 値（0 ～ 255 の整数）を使用して、背景を指定された色に設定します。
`setBackgrounds(color)`	`Range`	背景色の長方形のグリッドを設定します（この範囲の寸法と一致する必要があります）。
`setBorder(top, left, bottom, right, vertical, horizontal)`	`Range`	枠線のプロパティを設定します。
`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`	`Range`	枠線のプロパティを色やスタイルで設定します。
`setDataValidation(rule)`	`Range`	範囲内のすべてのセルに対して 1 つのデータ入力規則を設定します。
`setDataValidations(rules)`	`Range`	範囲内のすべてのセルに対してデータの入力規則を設定します。
`setFontColor(color)`	`Range`	フォントの色を CSS 表記（`'#ffffff'` や `'white'` など）で設定します。
`setFontColorObject(color)`	`Range`	指定された範囲のフォントの色を設定します。
`setFontColorObjects(colors)`	`Range`	フォント色の長方形のグリッドを設定します（この範囲のサイズと一致する必要があります）。
`setFontColors(colors)`	`Range`	フォント色の長方形のグリッドを設定します（この範囲のサイズと一致する必要があります）。
`setFontFamilies(fontFamilies)`	`Range`	フォントファミリーの長方形のグリッドを設定します（この範囲のサイズと一致する必要があります）。
`setFontFamily(fontFamily)`	`Range`	フォントファミリーを設定します（「Arial」など）。「Helvetica」を入力します。
`setFontLine(fontLine)`	`Range`	指定した範囲（`'underline'`、`'line-through'`、または `'none'`）。
`setFontLines(fontLines)`	`Range`	線スタイルの長方形のグリッドを設定します（この範囲の寸法と一致する必要があります）。
`setFontSize(size)`	`Range`	フォントサイズを設定します。サイズは使用するポイントサイズです。
`setFontSizes(sizes)`	`Range`	フォントサイズの長方形のグリッドを設定します（この範囲のサイズと一致する必要があります）。
`setFontStyle(fontStyle)`	`Range`	指定した範囲（`'italic'` または `'normal'`）のフォントスタイルを設定します。
`setFontStyles(fontStyles)`	`Range`	フォントスタイルの長方形のグリッドを設定します（この範囲のサイズと一致している必要があります）。
`setFontWeight(fontWeight)`	`Range`	指定した範囲（標準/太字）のフォントの太さを設定します。
`setFontWeights(fontWeights)`	`Range`	フォントの太さの長方形のグリッドを設定します（この範囲のサイズと一致する必要があります）。
`setFormula(formula)`	`Range`	この範囲の数式を更新します。
`setFormulaR1C1(formula)`	`Range`	この範囲の数式を更新します。
`setFormulas(formulas)`	`Range`	長方形の数式グリッドを設定します（この範囲の寸法と一致する必要があります）。
`setFormulasR1C1(formulas)`	`Range`	長方形の数式グリッドを設定します（この範囲の寸法と一致する必要があります）。
`setHorizontalAlignment(alignment)`	`Range`	指定した範囲（左/中央/右）で水平（左から右）の配置を設定します。
`setHorizontalAlignments(alignments)`	`Range`	水平方向の配置の長方形のグリッドを設定します。
`setNote(note)`	`Range`	指定された値にメモを設定します。
`setNotes(notes)`	`Range`	メモの長方形のグリッドを設定します（この範囲の寸法と一致する必要があります）。
`setNumberFormat(numberFormat)`	`Range`	数値または日付形式を、指定された形式設定文字列に設定します。
`setNumberFormats(numberFormats)`	`Range`	数値形式または日付形式の長方形のグリッドを設定します（この範囲のディメンションと一致する必要があります）。
`setRichTextValue(value)`	`Range`	範囲内のセルにリッチテキスト値を設定します。
`setRichTextValues(values)`	`Range`	リッチテキスト値の長方形のグリッドを設定します。
`setShowHyperlink(showHyperlink)`	`Range`	範囲にハイパーリンクを表示するかどうかを設定します。
`setTextDirection(direction)`	`Range`	範囲内のセルのテキスト方向を設定します。
`setTextDirections(directions)`	`Range`	テキスト方向の長方形のグリッドを設定します。
`setTextRotation(degrees)`	`Range`	範囲内のセルのテキスト回転設定を設定します。
`setTextRotation(rotation)`	`Range`	範囲内のセルのテキスト回転設定を設定します。
`setTextRotations(rotations)`	`Range`	テキストの回転を示す長方形のグリッドを設定します。
`setTextStyle(style)`	`Range`	範囲内のセルのテキストスタイルを設定します。
`setTextStyles(styles)`	`Range`	テキストスタイルの長方形グリッドを設定します。
`setValue(value)`	`Range`	範囲の値を設定します。
`setValues(values)`	`Range`	長方形のグリッドで値を設定します（この範囲の寸法と一致する必要があります）。
`setVerticalAlignment(alignment)`	`Range`	指定した範囲（上、中央、下）の垂直方向（上から下）の配置を設定します。
`setVerticalAlignments(alignments)`	`Range`	垂直方向の配置の長方形のグリッドを設定します（この範囲の寸法と一致する必要があります）。
`setVerticalText(isVertical)`	`Range`	範囲内のセルのテキストを積み重ねるかどうかを設定します。
`setWrap(isWrapEnabled)`	`Range`	指定した範囲のセル折り返しを設定します。
`setWrapStrategies(strategies)`	`Range`	ラップ戦略の長方形グリッドを設定します。
`setWrapStrategy(strategy)`	`Range`	範囲内のセルのテキストの折り返し方法を設定します。
`setWraps(isWrapEnabled)`	`Range`	キーワード折り返しポリシーの長方形のグリッドを設定します（この範囲のサイズと一致する必要があります）。
`shiftColumnGroupDepth(delta)`	`Range`	範囲の列グループ化の深さを指定の量だけ変更します。
`shiftRowGroupDepth(delta)`	`Range`	範囲の行グループ化の深さを指定の金額で変更します。
`sort(sortSpecObj)`	`Range`	指定した範囲のセルを、指定された列と順序で並べ替えます。
`splitTextToColumns()`	`void`	自動検出された区切り文字に基づいて、テキストの列を複数の列に分割します。
`splitTextToColumns(delimiter)`	`void`	指定された文字列をカスタムの区切り文字として使用して、テキストの列を複数の列に分割します。
`splitTextToColumns(delimiter)`	`void`	指定された区切り文字に基づいて、テキストの列を複数の列に分割します。
`trimWhitespace()`	`Range`	この範囲のすべてのセルの空白（スペース、タブ、改行など）を削除します。
`uncheck()`	`Range`	範囲のチェックボックスの状態を「オフ」に変更します。

サポート終了のメソッド

メソッド	戻り値の型	概要
`getFontColor()`	`String`	範囲の左上隅にあるセルのフォント色を CSS 表記（ `'#ffffff'` や `'white'` など）。
`getFontColors()`	`String[][]`	範囲内のセルのフォントの色を CSS 表記（`'#ffffff'` や `'white'`）。

詳細なドキュメント

`activate()`

指定された範囲を active range として設定します。範囲内の左側のセルを current cell として指定します。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:D10');
range.activate();

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

戻る

Range - この範囲（チェーン）。

`activateAsCurrentCell()`

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

指定したセルが既存の範囲に存在する場合は、その範囲がアクティブになります。範囲を現在のセルとして返します。

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

注: 指定した Range は、1 つのセルで構成する必要があります。そうでない場合は、次のエラーがスローされます。発生します。

// Gets the first sheet of the spreadsheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
var range = sheet.getRange('B5');
var currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

戻る

Range - この範囲（チェーン）。

承認

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

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

`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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

パラメータ

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

戻る

Range - この範囲（チェーン）。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

パラメータ

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

戻る

Range - この範囲（チェーン）。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

パラメータ

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

戻る

Range - この範囲（チェーン）。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
  'NAME',
  'GOOGLE',
  SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

パラメータ

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

戻る

Range - この範囲（チェーン）。

承認

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

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

`applyColumnBanding()`

デフォルトの列バンディングテーマを範囲に適用します。デフォルトでは、バンディングにはヘッダーがあり、フッターの色。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject().asRgbColor().asHexString());

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

戻る

Banding - 新しいバンド。

承認

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

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

`applyColumnBanding(bandingTheme)`

指定した列バンディングテーマを範囲に適用します。デフォルトでは、バンディングにはヘッダーとフッターの色はありません。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

パラメータ

名前	型	説明
`bandingTheme`	`BandingTheme`	範囲内の列に適用するカラーテーマ。

戻る

Banding - 新しいバンド。

承認

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

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

`applyColumnBanding(bandingTheme, showHeader, showFooter)`

指定された列帯域テーマを、指定されたヘッダーとフッターの範囲に適用します設定。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.BLUE, false, true);

// Gets the banding color and logs it to the console.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

// Gets the header color object and logs it to the console. Returns null because the header
// visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(sheet.getBandings()[0].getFooterColumnColorObject().asRgbColor().asHexString());

パラメータ

名前	型	説明
`bandingTheme`	`BandingTheme`	範囲内の列に適用するカラーテーマ。
`showHeader`	`Boolean`	`true` の場合、縞模様テーマのヘッダーの色が最初の色に適用されます。選択します。
`showFooter`	`Boolean`	`true` の場合、縞模様テーマのフッター色が最後の要素に適用されます。選択します。

戻る

Banding - 新しいバンド。

承認

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

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

`applyRowBanding()`

デフォルトの行バンディングテーマを範囲に適用します。デフォルトでは、バンディングにはヘッダーがあり、フッターの色。

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

戻る

Banding - 縞模様。

承認

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

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

`applyRowBanding(bandingTheme)`

指定した行バンディングテーマを範囲に適用します。デフォルトでは、バンディングにはヘッダーがあり、フッターの色。

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

パラメータ

名前	型	説明
`bandingTheme`	`BandingTheme`	範囲内の行に適用するカラーテーマ。

戻る

Banding - 新しいバンド。

承認

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

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

`applyRowBanding(bandingTheme, showHeader, showFooter)`

指定したヘッダーとフッターの設定がある範囲に、指定した行帯テーマを適用します。

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

パラメータ

名前	型	説明
`bandingTheme`	`BandingTheme`	範囲内の行に適用するカラーテーマ。
`showHeader`	`Boolean`	`true` の場合、縞模様テーマのヘッダーの色が最初の行に適用されます。
`showFooter`	`Boolean`	`true` の場合、縞模様テーマのフッター色が最後の行に適用されます。

戻る

Banding - 新しいバンド。

承認

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

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

`autoFill(destination, series)`

この範囲のデータに基づいて destinationRange にデータを入力します。新しい値指定された series タイプによっても決定されます。宛先範囲には次を含める必要があります一方向にのみ拡張できます次の例では、A1:A20 が入力されます。 A1:A4 の現在の値に基づいて増加していく一連の数値で表します。

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var destination = sheet.getRange("A1:A20");

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

パラメータ

名前	型	説明
`destination`	`Range`	値が自動入力される範囲です。宛先範囲は、この範囲を含み、一方向（上、下、左、またはです。
`series`	`AutoFillSeries`	新しい値の計算に使用する自動入力シリーズの型。「この系列の効果は、ソースデータの種類と量によって異なります。

承認

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

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

`autoFillToNeighbor(series)`

隣接するセルに基づいて新しいデータで範囲を計算し、自動的に入力しますその範囲に含まれるデータに基づいて新しい値で範囲が作成されます。これらの新しい値は指定された series タイプによって決定されます。

計算された目的地の範囲では、周囲のデータを考慮して、新しい挿入する必要があります。つまり、ある列のすぐ左または右に新しい値は隣接するデータのみに拡張されます。

たとえば、A1:A20 に連続する数字が入力されている場合、このメソッドを使用して一連の日付を含む範囲 B1:B4 で呼び出され、新しい値は B5:B20 に挿入しました。このようにして、これらの新しい値はテキストを含むセルに値を集計します

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var sourceRange = sheet.getRange("B1:B4");

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

パラメータ

名前	型	説明
`series`	`AutoFillSeries`	新しい値の計算に使用する自動入力シリーズの型。「この系列の効果は、ソースデータの種類と量によって異なります。

承認

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

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

`breakApart()`

範囲内の複数列のセルを再び個々のセルに分割します。

範囲に対してこの関数を呼び出すことは、範囲を選択して [表示形式] > [セルを結合] > [結合を解除] をタップします。

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

戻る

Range - この範囲（チェーン）。

承認

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

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

`canEdit()`

範囲内のすべてのセルを編集する権限をユーザーに付与するかどうかを指定します。スプレッドシートオーナーは常に保護されている範囲とシートを編集できます。

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

戻る

Boolean - ユーザーが範囲内のすべてのセルを編集する権限を持っている場合は true。false できません。

承認

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

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

`check()`

範囲のチェックボックスの状態を「オン」に変更します。範囲内のセルを無視しますには現在設定されている値（オン、オフ）が含まれていません。

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'checked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

戻る

Range - この範囲（チェーン）。

承認

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

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

`clear()`

コンテンツと形式の範囲をクリアします。

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

var range = sheet.getRange("A1:D10");
range.clear();

戻る

Range - この範囲（チェーン）。

承認

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

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

`clear(options)`

ファイアウォールルールを作成しますデフォルトでは、すべてのデータが消去されます。

// The code below clears range C2:G7 in the active sheet, but preserves the format,
// data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({contentsOnly: true});

パラメータ

名前	型	説明
`options`	`Object`	詳細パラメータを指定する JavaScript オブジェクト（下記を参照）。

拡張パラメータ

名前	型	説明
`commentsOnly`	`Boolean`	コメントのみを消去するかどうか。
`contentsOnly`	`Boolean`	コンテンツのみを消去するかどうか。
`formatOnly`	`Boolean`	書式のみをクリアするかどうかを指定します。なお、データの入力規則も消去されます。
`validationsOnly`	`Boolean`	データの入力規則のみを消去するかどうか。
`skipFilteredRows`	`Boolean`	フィルタされた行の消去を回避するかどうかを指定します。

戻る

Range - この範囲（チェーン）。

承認

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

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

`clearContent()`

書式はそのままにして、範囲の内容をクリアします。

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

var range = sheet.getRange("A1:D10");
range.clearContent();

戻る

Range - この範囲（チェーン）。

承認

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

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

`clearDataValidations()`

範囲のデータ入力規則をクリアします。

// Clear the data validation rules for cells A1:B5.
var range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

戻る

Range - この範囲（チェーン）。

承認

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

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

`clearFormat()`

この範囲の書式をクリアします。

1 つまたは複数のセルの書式をクリアします。ただし、書式はリセットされません。数値形式ルールを使用します。

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

var range = sheet.getRange("A1:D10");
range.clearFormat();

戻る

Range - この範囲（チェーン）。

承認

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

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

`clearNote()`

指定したセル（複数可）内のメモをクリアします。

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

var range = sheet.getRange("A1:D10");
range.clearNote();

戻る

Range - この範囲（チェーン）。

承認

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

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

`collapseGroups()`

範囲内に含まれているすべてのグループを折りたたみます。完全に一致するグループがない場合は、その範囲内の最も奥深く開いているグループが折りたたまれます。

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

// All row and column groups within the range are collapsed.
range.collapseGroups();

戻る

Range - この範囲（チェーン）。

承認

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

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

`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`

範囲の書式を指定された場所にコピーします。リンク先がそれより大きいか小さいかソース範囲よりも大きい場合は、ソースが繰り返されるか、切り詰められます。なお、メソッドは書式のみをコピーします。

gridId パラメータの詳細については、getGridId() をご覧ください。

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

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

パラメータ

名前	型	説明
`gridId`	`Integer`	スプレッドシート内のシートの一意の ID（位置に関係なく）。
`column`	`Integer`	ターゲット範囲の最初の列です。
`columnEnd`	`Integer`	ターゲット範囲の終了列。
`row`	`Integer`	ターゲット範囲の開始行。
`rowEnd`	`Integer`	ターゲット範囲の終了行。

承認

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

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

`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

パラメータ

名前	型	説明
`sheet`	`Sheet`	ターゲットシート。
`column`	`Integer`	ターゲット範囲の最初の列です。
`columnEnd`	`Integer`	ターゲット範囲の終了列。
`row`	`Integer`	ターゲット範囲の開始行。
`rowEnd`	`Integer`	ターゲット範囲の終了行。

承認

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

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

`copyTo(destination)`

セル範囲のデータを別のセル範囲にコピーします。値と形式の両方がコピーされます。

// The code below copies the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

パラメータ

名前	型	説明
`destination`	`Range`	コピー先の範囲。適切なのは左上のセルの位置のみです。

承認

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

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

`copyTo(destination, copyPasteType, transposed)`

セル範囲のデータを別のセル範囲にコピーします。

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES,
false);

パラメータ

名前	型	説明
`destination`	`Range`	コピー先の範囲。適切なのは左上のセルの位置のみです。
`copyPasteType`	`CopyPasteType`	範囲の内容を貼り付ける方法を指定する型あります。
`transposed`	`Boolean`	転置した向きで範囲を貼り付けるかどうかを指定します。

承認

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

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

`copyTo(destination, options)`

セル範囲のデータを別のセル範囲にコピーします。デフォルトでは、書式はコピーされますが、高度な引数を使用してオーバーライドできます。

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});

パラメータ

名前	型	説明
`destination`	`Range`	コピー先の範囲。適切なのは左上のセルの位置のみです。
`options`	`Object`	詳細パラメータを指定する JavaScript オブジェクト（下記を参照）。

拡張パラメータ

名前	型	説明
`formatOnly`	`Boolean`	フォーマットのみをコピーすること
`contentsOnly`	`Boolean`	は、コンテンツのみがコピーされるように指定します

承認

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

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

`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`

範囲の内容を指定された場所にコピーします。リンク先がそれより大きいか小さいかソース範囲よりも大きい場合は、ソースが繰り返されるか、切り詰められます。

gridId パラメータの詳細については、getGridId() をご覧ください。

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

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

パラメータ

名前	型	説明
`gridId`	`Integer`	スプレッドシート内のシートの一意の ID（位置に関係なく）。
`column`	`Integer`	ターゲット範囲の最初の列です。
`columnEnd`	`Integer`	ターゲット範囲の終了列。
`row`	`Integer`	ターゲット範囲の開始行。
`rowEnd`	`Integer`	ターゲット範囲の終了行。

承認

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

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

`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

パラメータ

名前	型	説明
`sheet`	`Sheet`	ターゲットシート。
`column`	`Integer`	ターゲット範囲の最初の列です。
`columnEnd`	`Integer`	ターゲット範囲の終了列。
`row`	`Integer`	ターゲット範囲の開始行。
`rowEnd`	`Integer`	ターゲット範囲の終了行。

承認

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

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

`createDataSourcePivotTable(dataSource)`

データソースから空のデータソースのピボットテーブルを作成し、選択します。

この例では、新しいデータソースのピボットテーブルを作成して構成する方法を示します。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM);
pivotTable.addFilter('dataColumnA',
                     SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());

パラメータ

名前	型	説明
`dataSource`	`DataSource`	ピボットテーブルの作成元となるデータソース。

戻る

DataSourcePivotTable - 新しく作成されたデータソースのピボットテーブル。

承認

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

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

`createDataSourceTable(dataSource)`

データソースから空のデータソーステーブルを作成し、このテーブルの最初のセルに固定します。あります。

この例では、新しいデータソーステーブルを作成して構成する方法を示します。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var dataSourceTable = anchorCell.createDataSourceTable(dataSource);
    .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
    .addSortSpec('dataColumnA', /* ascending= *\/ true)
    .addSortSpec('dataColumnB', /* ascending= *\/ false);

パラメータ

名前	型	説明
`dataSource`	`DataSource`	ピボットテーブルの作成元となるデータソース。

戻る

DataSourceTable - 新しく作成されたデータソーステーブル。

承認

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

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

`createDeveloperMetadataFinder()`

このスコープ内のデベロッパーメタデータを検索するための DeveloperMetadataFinderApi を返します。あります。メタデータは、その範囲内に完全に含まれている場合にのみ、範囲のスコープに含まれます。あります。たとえば、行「3:3」に関連付けられたメタデータは範囲のスコープ外です「A1:D5」であるが、「1:5」の範囲内にある。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

戻る

DeveloperMetadataFinder - この範囲のスコープ内のメタデータを検索するデベロッパーメタデータファインダー。

`createFilter()`

フィルタを作成し、シート上の指定した範囲に適用します。作成できるのは最大でフィルタを 1 つ作成することもできます作成したフィルタにアクセスして変更するには、getFilter() または Sheet.getFilter() を使用します。

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}

このメソッドを使用して、Grid シート（デフォルトのシートタイプ）のフィルタを作成します。グリッドシートは、データベースに接続されていないシートです。他のタイプのフィルタを作成するには、以下を参照してください。 <ph type="x-smartling-placeholder">

PivotTable.addFilter(sourceDataColumn, filterCriteria) を使用してピボットテーブルフィルタを作成する
DataSourceSheet.addFilter(columnName, filterCriteria) を使用して、データベースに接続されているシートのフィルタを作成する
DataSourcePivotTable.addFilter(columnName, filterCriteria) を使用してデータベースに接続されているピボットテーブルのフィルタを作成する

戻る

Filter - 新しいフィルタ。

承認

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

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

`createPivotTable(sourceData)`

最初のセルに固定された、指定された sourceData から空のピボットテーブルを作成しますこの範囲内にあります。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

パラメータ

名前	型	説明
`sourceData`	`Range`	ピボットテーブルの作成元となるデータ。

戻る

PivotTable - 新しく作成された PivotTable。

承認

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

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

`createTextFinder(findText)`

範囲のテキストファインダーを作成します。この範囲のテキストを検索して置換できます。

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

// Creates  a text finder for the range.
var textFinder = range.createTextFinder('dog');

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

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

パラメータ

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

戻る

TextFinder - 範囲の TextFinder

`deleteCells(shiftDimension)`

このセル範囲を削除します。指定したディメンションに沿ってシート内の既存のデータが移動されます削除されます。

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

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

パラメータ

名前	型	説明
`shiftDimension`	`Dimension`	既存のデータのシフトに使用するディメンション。

承認

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

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

`expandGroups()`

折りたたまれたグループ（範囲またはコントロールの切り替えボタン）が、この範囲と交差しているものを展開します。「コントロール切り替えの場所は、コントロール切り替えボタンの直前またはグループに属します。同じ場所に複数のグループがある場合最も浅いグループが拡大されます

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

// All row and column groups within the range are expanded.
range.expandGroups();

戻る

Range - この範囲（チェーン）。

承認

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

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

`getA1Notation()`

範囲の文字列説明を A1 表記で返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

戻る

String - A1 表記での範囲の文字列の説明。

承認

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

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

`getBackground()`

範囲内の左上のセルの背景色を返します（例: '#ffffff'）。

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackground());

戻る

String - 背景のカラーコード。

承認

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

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

`getBackgroundObject()`

範囲内の左上のセルの背景色を返します。

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

戻る

Color - 範囲内の左上のセルの背景色。

承認

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

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

`getBackgroundObjects()`

範囲内のセルの背景色を返します。

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

戻る

Color[][] - 背景色の 2 次元配列。

承認

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

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

`getBackgrounds()`

範囲内のセルの背景色を返します（例: '#ffffff'）。

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

戻る

String[][] — 背景のカラーコードの 2 次元配列。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (let banding of bandings) {
  console.log(banding.getSecondRowColor());
}

戻る

Banding[] - この範囲の任意のセルに適用されるすべての縞模様。

承認

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

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

`getCell(row, column)`

範囲内の指定されたセルを返します。

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

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

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
var cell = range.getCell(1, 1);
Logger.log(cell.getValue());

パラメータ

名前	型	説明
`row`	`Integer`	範囲を基準とするセルの行。
`column`	`Integer`	範囲を基準とするセルの列。

戻る

Range - 指定された座標にある 1 つのセルを含む範囲。

承認

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

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

`getColumn()`

この範囲の開始列の位置を返します。

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

var range = sheet.getRange("B2:D4");
// Logs "2.0"
Logger.log(range.getColumn());

戻る

Integer - スプレッドシート内の範囲の開始列の位置。

承認

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

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

`getDataRegion()`

すべてを網羅するために、4 つの基数 Direction で拡張された範囲のコピーを返します。隣接セルを選択し、範囲が空白のセルで囲まれている場合、空白のセルは含まれません。対角線に沿って移動した場合、範囲そのものが返されます。これは範囲を選択してエディタに「Ctrl+A」と入力します。

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());

戻る

Range - 範囲のデータ領域、またはスプレッドシート全体の範囲です。

承認

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

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

`getDataRegion(dimension)`

次の場合は、拡張された範囲の Direction.UP と Direction.DOWN のコピーを返します。指定されたディメンションが Dimension.ROWS、またはディメンションが Dimension.COLUMNS の場合は Direction.NEXT と Direction.PREVIOUS。範囲の拡大表のように整理された範囲の隣のデータの検出に基づいています。拡張された範囲表を含む指定されたディメンションに沿って、隣接するすべてのセルのデータが含まれるできます。元の範囲が、指定したサイズに沿って空のセルで囲まれている場合は、範囲自体が返されます。この方法は、エディタで範囲を選択して列に対して「Ctrl+Space」、行に「Shift+Space」を入力する方法と似ています。

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "C2:C4"
Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation());
// Logs "B3:D3"
Logger.log(
    sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());

パラメータ

名前	型	説明
`dimension`	`Dimension`	範囲を拡張するディメンション。

戻る

Range - 範囲のデータ領域、またはコピーされます。

承認

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

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

`getDataSourceFormula()`

範囲内の最初のセルの DataSourceFormula を返します。それ以外の場合は null を返します。セルにデータソースの数式が含まれていません。

// 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 the range A1 on Sheet1.
const range = sheet.getRange('A1');

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

戻る

DataSourceFormula - セルの DataSourceFormula。

承認

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

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

`getDataSourceFormulas()`

範囲内のセルの DataSourceFormula を返します。

// 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 the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

// Logs the first formula in the array.
console.log(dataSourceFormulas[0].getFormula());

戻る

DataSourceFormula[] - 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

戻る

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

承認

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

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

`getDataSourceTables()`

範囲と交差するすべてのデータソーステーブルを取得します。

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

戻る

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

承認

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

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

`getDataSourceUrl()`

この範囲のデータの URL を返します。この URL を使用してグラフやクエリを作成できます。

コード.gs

function doGet() {
  var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c');
  var sheet = ss.getSheetByName('ContinentData');
  var range = sheet.getRange('A1:B8');

  var template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

piechart.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

戻る

String - グラフなどの他の API に渡すことができるデータソースとしてのこの範囲の URL。

承認

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

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

`getDataTable()`

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

// 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 the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

// Gets the range A1:B7 as a data table. The values in each column must be of the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

戻る

DataTable - データテーブルとしてのデータ。

`getDataTable(firstRowIsHeader)`

この範囲内のデータを DataTable として返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:B7");

// Calling this method with "true" sets the first line to be the title of the axes
var datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
var chart = Charts.newBarChart()
    .setDataTable(datatable)
    .setOption("title", "Your Title Here")
    .build();

パラメータ

名前	型	説明
`firstRowIsHeader`	`Boolean`	最初の行をヘッダーとして扱うかどうかを指定します。

戻る

DataTable - データテーブルとしてのデータ。

承認

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

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

`getDataValidation()`

範囲の左上のセルのデータ入力規則を返します。データの入力規則がセルに設定されていない場合、このメソッドは null を返します。

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

戻る

DataValidation - 範囲の左上のセルのデータ入力規則。

承認

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

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

`getDataValidations()`

範囲内のすべてのセルのデータ入力規則を返します。データの入力規則がまだ入力されていない場合指定されたセルに指定された場合、このメソッドは配列内のそのセルの位置について null を返します。

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

戻る

DataValidation[][] - 次のセルのセルに関連付けられたデータ入力規則の 2 次元配列あります。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

戻る

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

承認

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

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

`getDisplayValue()`

範囲内の左上のセルの表示値を返します。値は String です。表示される値では、次のような日付、時刻、通貨の形式が考慮されます。スプレッドシートの言語 / 地域設定によって、自動的に適用される書式。空のセルは空白を返します使用します。

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

戻る

String - このセルに表示される値。

承認

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

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

`getDisplayValues()`

この範囲の値の長方形のグリッドを返します。

行、列の順にインデックス付けされた、表示された値の 2 次元配列を返します。「値は String オブジェクトです。表示される値では、日時、通貨の書式設定（スプレッドシートの言語 / 地域によって自動的に適用される書式を含む）設定されます。空のセルは、配列内の空の文字列で表されます。前述のとおり、範囲インデックスは 1, 1 から始まり、JavaScript 配列のインデックスは [0][0] から始まります。

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

戻る

String[][] - 値の 2 次元配列。

承認

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

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

`getFilter()`

この範囲が属するシートのフィルタを返します。フィルタがない場合は null を返します。表示されます。

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

戻る

Filter - フィルタ。

承認

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

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

`getFontColorObject()`

範囲の左上隅にあるセルのフォントの色を返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

戻る

Color - 範囲内の左上のセルのフォント色。

承認

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

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

`getFontColorObjects()`

範囲内のセルのフォントの色を返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColorObjects();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

戻る

Color[][] — 範囲内のセルに関連付けられたフォント色の 2 次元配列。

承認

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

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

`getFontFamilies()`

範囲内のセルのフォントファミリーを返します。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontFamilies();

for (var i in results) {
  for (var j in results[i