【初心者必須】GASで二次元配列を一次元化するflatメソッド

お仕事おつにゃッス🐈

文系未経験から社内SEになった、あっきょ（@daily_code_JP）です！

Google Apps Scriptで配列内の要素が配列になっていて、要素の取り出しが大変になったことありませんか？

この記事ではそのお悩みを、コピペOKのGoogle Apps Scriptのコードで解決します。

あっきょ

この記事は以下で悩んでいる人におすすめ！

そもそも二次元配列って何？
二次元配列を一次元化して、普通の配列のように扱いたい
プログラミングでJavaScriptを学んだけど、何を作っていいかわからない

誰でも無料で簡単にできますので、お気軽に学んでいきましょう！

タップできる目次

二次元配列とは？
二次元配列のデメリット
- コードが煩雑化
二次元配列を一次元化するサンプルコード
- flatメソッド | 二次元配列を一次元化
- サンプルコード
配列を一次元化するテスト
【基本】GASで二次元配列を処理するコード一覧
おわりに | GASでスキルアップを目指すには

二次元配列とは？

二次元配列とは、「配列の中にある配列」です。

GASでは、getValuesメソッドでスプレッドシートのセル複数から値を取りだすのに使います。

: 【1行で簡単】GASでシートの複数のセルの値を一括で取得
続きを見る

例えば、画像のようなスプレッドシートを作成して赤で囲んだ範囲の値を取得するとします。

Apps Scriptに複数のセルから値を取得するコードを貼り付けて実行します。

getValuesメソッドを使ってセル内のデータを得ます。

function getValuesSheet() {
 const sheet = SpreadsheetApp.getActiveSheet();
 const values = sheet.getRange("A2:A6").getValues();

 Logger.log(values);
}

関数を実行して実行ログをみると、配列の中に5つの配列が格納されています。

このように、配列内の要素も配列の状態を二次元配列といいます。

二次元配列のデメリット

二次元配列のデメリットと、配列を一次元に変換する理由を解説します。

コードが煩雑化

二次元配列を処理するとコードが無駄に長くなることがデメリットです。

例えば、for文で値を取り出してシート名をログ出力します。

function getValuesSheet() {
 const sheet = SpreadsheetApp.getActiveSheet();
 const values = sheet.getRange("A2:A6").getValues();
 const valuesLen = values.length; //配列の長さ

 for(var i = 0; i<valuesLen; i++){
   Logger.log(values[i]);
 }
 
}

結果は画像の通りです。

配列から取り出した要素が配列になっているのがわかります。

しかし、このままでは要素を処理できず、もう一度for文で取り出す必要があります。

配列内の配列から要素を取り出す場合、コードは以下のようになります。

forを二重に使うのでコードが複雑になっています。

したがって、長くて複雑なコードを簡略化して配列を一次元化します。

function getValuesSheet() {
 const sheet = SpreadsheetApp.getActiveSheet();
 const values = sheet.getRange("A2:A6").getValues();
 const valuesLen = values.length; //配列の長さ

 for(var i = 0; i<valuesLen; i++){ //外側の配列の処理
   const arrayLen = values[i].length; //配列から取り出した配列の長さ

   for(var m = 0; m<arrayLen; m++){ //配列から取り出した配列の処理
    Logger.log(values[i][m]);
   }
 }

}

二次元配列を一次元化するサンプルコード

GASで二次元配列を一次元化して配列を調整します。

解説の項目

flatメソッド | 二次元配列を一次元化
サンプルコード

flatメソッド | 二次元配列を一次元化

二次元配列を次元配列に変換するには、flatメソッドを使います。

引数はありません。

このメソッドを一度書くだけで配列処理を簡素化できます。

サンプルコード

二次元配列を一元配列にしてみましょう。

定数 valuesFlatで二次元配列のvaluesを一次元化します。

function getValuesSheet() {
 const sheet = SpreadsheetApp.getActiveSheet();
 const values = sheet.getRange("A2:A7").getValues();
 const valuesFlat = values.flat();

 Logger.log(valuesFlat);
}