GASでスプレッドシートの値を指定されたオプションで削除する

指定範囲の値をすべて削除する：clear(options)

指定範囲の値について、コメント・値・書式・条件付き書式の削除を選択することができ、フィルターされた行をスキップすることができます。

パラメータ

名前	タイプ	説明
options	Object	削除するコンテンツを指定

オプション

名前	タイプ	説明
commentsOnly	Boolean	メモが削除されます
contentsOnly	Boolean	値が削除されます
formatOnly	Boolean	書式が削除されます
validationsOnly	Boolean	データの入力規則が削除されます
skipFilteredRows	Boolean	フィルターされた行の削除はスキップされます

戻り値

Range

セルの範囲

メモのみを削除する

function myFunction() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
  const range = sheet.getRange('B2:D10');
  range.clear({
    commentsOnly: true,
    contentsOnly: false,
    formatOnly: false,
    validationsOnly: false,
    skipFilteredRows: false
  });
}

このような状態から、

サンプルコードを実行すると、

値のみを削除する

function myFunction() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
  const range = sheet.getRange('B2:D10');
  range.clear({
    commentsOnly: false,
    contentsOnly: true,
    formatOnly: false,
    validationsOnly: false,
    skipFilteredRows: false
  });
}

このような状態から、

サンプルコードを実行すると、

書式のみを削除する

function myFunction() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
  const range = sheet.getRange('B2:D10');
  range.clear({
    commentsOnly: false,
    contentsOnly: false,
    formatOnly: true,
    validationsOnly: false,
    skipFilteredRows: false
  });
}

このような状態から、

サンプルコードを実行すると、

データの入力規則のみを削除する

function myFunction() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
  const range = sheet.getRange('B2:D10');
  range.clear({
    commentsOnly: false,
    contentsOnly: false,
    formatOnly: false,
    validationsOnly: true,
    skipFilteredRows: false
  });
}

このような状態から、

サンプルコードを実行すると、

削除対象からフィルターされた行はスキップする

function myFunction() {
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
  const range = sheet.getRange('A2:D10');
  range.clear({
    commentsOnly: false,
    contentsOnly: true,
    formatOnly: false,
    validationsOnly: false,
    skipFilteredRows: true
  });
}

このような状態から、

花子以外を表示させるようにフィルターを設定する

サンプルコードを実行すると、

フィルターを解除すると、

フィルターがスキップされていることが確認できる。

公式ドキュメント：Range > clear(options)

まとめ