More than 1 year has passed since last update.

【GAS】スプレッドシートでGASを使用する

GoogleAppsScript

Posted at 2022-03-18

はじめに

GASを使う機会があり、その際に調べたことを共有したいと思います。
サンプルとして下記の整列前のデータを、No順に整列させて整列後に入力します。
GASを使用したスプレッドシートからの値の入出力について、学べる内容となってますので、
初心者の方は参考になると思います。

①スプレッドシートにGASを追加する

スプレッドシートの拡張機能からApps Scriptを選択します。

すると下記のように自動で作成されるので、ここにコードを書いていきます。

②GASでコードを書く

GASの文法はJavaScriptと同じです。
ただ、Googleのアプリを操作するためには、用意された特有のメソッドを使用する必要があります。
あと最初に頭に入れておいたほうがいいのは、 アプリを操作するためのメソッドの呼び出し回数は少ないほうがいい 、ということです。
スプレッドシートで説明すると、セルの内容を取得するメソッドがありますが、
セルの内容を一つ一つ取得するより、必要な範囲を一括で取得するほうがいいということです。
理由はその方が動作が高速になるからです。
コードの全文は以下になります。
説明はコメントにしておきます。

function myFunction() {
  // 整列前のデータの範囲はB4:C8
  // GASでは、行と列は、1始まり(A1は、行1,列1でアクセス)
  // 整列前のデータのはじめのセルの行
  const START_INPUT_ROW = 4;
  // 整列前のデータのはじめのセルの列
  const START_INPUT_COLUMN = 2;

  // 整列後のデータの範囲はE4:F8
  // 整列後のデータのはじめのセルの行
  const START_OUTPUT_ROW = 4;
  // 整列後のデータのはじめのセルの列
  const START_OUTPUT_COLUMN = 5;

  // 整列前後で共通のデータ数
  // データの行数
  const ROW_COUNT = 5;
  // データの列数
  const COLUMN_COUNT = 2;

  // スクリプトと紐づいているスプレッドシートを取得
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

  // スプレッドシートからシートを取得
  const sheet = spreadsheet.getSheetByName("シート1");
  
  // getRange(行, 列, 行数,　列数)で、範囲を取得
  // 他にも、getRange('B4:C8')とかでも取得可能
  const inputRange = sheet.getRange(START_INPUT_ROW, START_INPUT_COLUMN, ROW_COUNT, COLUMN_COUNT);

  // 範囲の値を取得
  let inputValues = inputRange.getValues();

  // 取得した値は、「行 x 列」の二次元配列です。
  // Noの内容でソートします。
  inputValues.sort((a, b) => a[0] - b[0]);

  // ソートしたデータをセルに出力します
  // 出力範囲を取得
  const outputRange = sheet.getRange(START_OUTPUT_ROW, START_OUTPUT_COLUMN, ROW_COUNT, COLUMN_COUNT);

  // 出力範囲に値を出力
  outputRange.setValues(inputValues);
}