【GAS】配列に使えるメソッドまとめ

2022年9月4日GASconcat,every,filter,forEach,indexof,join,lastIndexOf,map,pop,push,reduce,reduceRight,reverse,shift,some,sort,splice,unshift

GASではプログラムを効率よく記述するために配列操作が大きな役割を果たします。この記事では配列（Arrayオブジェクト）に使えるメソッドのうち特に便利なものをご紹介します。

GASにおける配列操作の重要性

配列とは

配列は変数の一つで、通し番号（「インデックス」と呼ばれます）を付けた複数の値を扱えるようにしたものです。配列があることで、一つの変数名を用いて複数の値を扱うことができるようになります。

  let array = ['apple', 'orange', 'grape']; // 文字列の要素を3つを持つ配列

配列そのものの操作方法については下記の記事で詳しく解説を行っています。

【GAS】配列の宣言・初期化・頻出メソッド

Google Apps Script（GAS）では、効率の良いスクリプトを書くために配列がとても重要な役割を果たしま ...

 https://tetsuooo.net/gas/715/

GASで配列操作が重要な理由

GASは様々なGoogleサービスと連携してデータ処理を行える点で非常に優れています。しかし、処理速度は他の言語と比べて早いわけではなく、サービス連携して処理を行う際の制約が大きかったりもします。

【GAS】覚えておきたい制限・上限まとめ

Google Apps Script（GAS）は業務効率化に役立つ無料ツールとして有用ですが、無制限に使えるわけでは ...

 https://tetsuooo.net/gas/1101/

例えば、スプレッドシートのデータを取得したり書き出す操作を行うためにスプレッドシートAPIを使っていますが、APIを使えば使うほどスクリプトの実行速度が遅くなります。（一回の実行で処理時間が6分を超えるとタイムアウトエラーでスクリプトの処理が実行できません。これを俗に「Google Apps Scriptの6分の壁」と呼びます）

タイムアウトが起きなくするには、例えばできるだけスプレッドシートサービスのAPIを呼び出す回数を少なくするようにスクリプトを組むことが重要です。このような効率の良いスクリプトを書くために配列がとても重要な役割を果たす、というわけです。

それでは配列に使える便利なメソッドをご紹介していきます。各メソッドについてより詳しく解説した記事も用意しているのでぜひあわせてご覧ください。

joinメソッド

配列要素を結合して一つの文字列を作成するメソッドです。メソッド呼び出しで元の配列は変更されます。

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

console.log(animal.join('|')); //cat|dog|elephant|tiger|lion|monkey

//デフォルトでははカンマ','がセパレーターとなっている
console.log(animal.join()); //cat,dog,elephant,tiger,lion,monkey
console.log(animal.join(',')); //cat,dog,elephant,tiger,lion,monkey

//2つ以上の引数も可能
console.log(animal.join(['a',' '])); //	cata, doga, elephanta, tigera, liona, monkey

//改行記号の「\n」を引数に入れると出力は改行される
console.log(animal.join('\n')); 
// // cat
// // dog
// // elephant
// // tiger
// // lion
// // monkey

//二次元配列に適応すると最下層まで展開してから結合される
let animal_2 = [['cat', 'dog'], ['elephant', 'tiger'], ['lion', 'monkey']];
console.log(animal_2.join()); //cat,dog,elephant,tiger,lion,monkey

数字型は文字列として一緒に結合されますが、オブジェクト型は「object」という文字列で結合されます。

let array = ['cat', 'dog', 1, 3, {'name':'Bob', 'age':25}];
console.log(array.join()); //	cat,dog,1,3,[object Object]

reverseメソッド

配列順序を反転させるメソッドです。メソッド呼び出しで元の配列は変更されます。

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

console.log(animal.reverse()); //[ 'monkey', 'lion', 'tiger', 'elephant', 'dog', 'cat' ]

//二次元配列にrevers()した場合、最深層目までは反転されない
let animal_2 = [['cat', 'dog'], ['elephant', 'tiger'], ['lion', 'monkey']];
console.log(animal_2.reverse()); //[ [ 'lion', 'monkey' ],  [ 'elephant', 'tiger' ],  [ 'cat', 'dog' ] ]

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];
let reversed_animal = animal.reverse();

//戻り値も、元の配列も順序は逆になる
console.log(animal); //[ 'monkey', 'lion', 'tiger', 'elephant', 'dog', 'cat' ]
console.log(reversed_animal); //[ 'monkey', 'lion', 'tiger', 'elephant', 'dog', 'cat' ]

//元の配列を参照している
//console.log(animal === reversed_animal); //true

//元の配列を参照しているので、片方に変更を加えるともう片方にも反映されている
reversed_animal.push('zebra')
console.log(animal); //	[ 'cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey', 'zebra' ]
console.log(reversed_animal); //[ 'cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey', 'zebra' ]

sortメソッド

配列の順序を並び替えるメソッドです。並び替え順序は関数で定義できます。メソッド呼び出しで元の配列は変更されます。

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];
console.log(animal.sort()); //[ 'cat', 'dog', 'elephant', 'lion', 'monkey', 'tiger' ]
console.log(animal); //[ 'cat', 'dog', 'elephant', 'lion', 'monkey', 'tiger' ]

【GAS】sortメソッドの使い方（配列の並べ替え）

配列を要素を並び替えるにはsortメソッドを使います。関数によって法則を定義することで思い通りの順序 ...

 https://tetsuooo.net/gas/2402/

pushメソッド

配列末尾に新たな要素を追加するメソッドです。メソッド呼び出しで元の配列は変更されます。

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

console.log(animal.push('giraffe')); //7
console.log(animal); //	[ 'cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey', 'giraffe' ]

詳細を下記の記事で解説しているので是非ご覧ください。

【GAS】pushメソッドで配列末尾に要素を追加する

配列の末尾に任意の要素を追加できるpushメソッドとその使い方についてご紹介します。pushメソッドを用 ...

 https://tetsuooo.net/gas/1977/

popメソッド

配列末尾から要素を削除するメソッドです。メソッド呼び出しで元の配列は変更されます。

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

console.log(animal.pop()); //monkey
console.log(animal); //	[ 'cat', 'dog', 'elephant', 'tiger', 'lion']

shiftメソッド

配列先頭から要素を削除するメソッドです。メソッド呼び出しで元の配列は変更されます。

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

console.log(animal.shift()); //cat
console.log(animal); //	['dog', 'elephant', 'tiger', 'lion', 'monkey']

unshiftメソッド

配列の先頭に新たな要素を追加するメソッドです。メソッド呼び出しで元の配列は変更されます。

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

console.log(animal.unshift('panda')); //7
console.log(animal); //	['panda', 'cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey']

spliceメソッド

配列を分割するメソッドです。元の配列に対して分割する位置と要素数を指定します。メソッド呼び出しで元の配列は変更されます。

//先頭から1つの要素を分割
let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];
console.log(animal.splice(0,1)); //[ 'cat' ]
console.log(animal); //	[ 'dog', 'elephant', 'tiger', 'lion', 'monkey' ]

//先頭2番目から1つの要素を分割
let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];
console.log(animal.splice(1,1)); //[ 'dog' ]
console.log(animal); //	[ 'cat', 'elephant', 'tiger', 'lion', 'monkey' ]

//先頭2番目から2つの要素を分割
let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];
console.log(animal.splice(1,2)); //[ 'dog', 'elephant' ]
console.log(animal); //	[ 'cat', 'tiger', 'lion', 'monkey' ]

【GAS】spliceメソッドで配列要素を削除・分割する

Google Apps Script（GAS）で配列の要素を削除（分割）する方法をご紹介します。配列の要素削除（分割 ...

 https://tetsuooo.net/gas/2359/

concatメソッド

配列同士を連結するメソッドです。元となっている配列に変更は加わりません。

let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

console.log(animal.concat(['ondor', 'eagle'])); //['cat','dog','elephant','tiger','lion','monkey','ondor','eagle']
console.log(animal); //[ 'cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey' ]

【GAS】一次元配列の結合で新たな配列を作る／配列要素を結合する

この記事ではGoogle Apps Script（GAS）で一次元配列を使った下記4つの結合シーンをご紹介しています。 ...

 https://tetsuooo.net/gas/1549/

【GAS】二次元配列の結合（縦の結合 / 横の結合 / 要素同士の結合）

Google Apps Script（GAS）における二次元配列の結合方法を、縦の結合、横の結合、要素同士の結合に分 ...

 https://tetsuooo.net/gas/3249/

indexOfメソッド / lastIndexOfメソッド

配列の中に指定した文字列が存在するかを検索するメソッドです。indexOfメソッドは先頭から末尾にかけて、lastIndexOfメソッドは末尾から先頭にかけて検索をかけて最初に一致した要素の位置を返します。

  let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

  //配列先頭からすべての要素を検索、最初に一致した位置を返す
  console.log(animal.indexOf('dog'));　//1
　//インデックス2（3番目の要素）から検索をかけると'dog'は一致しない
  console.log(animal.indexOf('dog',2)); //-1

 //末尾からカウントした位置から検索スタートした場合
　//'lione' → 'monkey'の順で検索して検索終了となるため'tiger'は一致しない
  console.log(animal.indexOf('tiger',-2)); //-1
  //'lion'は一致する
  console.log(animal.indexOf('lion',-2)); //4

indexOfメソッドとlastIndexOfメソッドは文字列にも配列にも適応可能です。

【GAS】文字列に指定文字列が含まれているかの確認（match / indexOf / lastIndexOf /

Google Apps Script（GAS）で、特定の文字列が含まれているかどうか検索する方法をご紹介します。

 https://tetsuooo.net/gas/2035/

【GAS】配列に指定文字列が含まれているか検索する（includes / indexOf / lastIndexO

GAS（Google Apps Script）で配列内の要素を完全一致・部分一致・正規表現で検索する方法をご紹介しま ...

 https://tetsuooo.net/gas/2265/

everyメソッド

配列のすべての要素が関数を満たすかどうかを判定するメソッドです。

  let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

  //文字列であるかどうかの判定
  function isString(value) {
    return typeof value === 'string'
  }

  console.log(animal.every(isString));　//true
  

  //値に't'が含まれているかの判定
  function includingT(value) {
    return value.includes('t')
  }

 console.log(animal.every(includingT)); //false

someメソッド

配列の要素のうち少なくとも1つが関数を満たすかどうかを判定するメソッドです。

  let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

  //値に'c'が含まれているかの判定
  function includingC(value) {
    return value.includes('c')
  }

  console.log(animal.some(includingC)); //true
  
  //数字であるかどうかの判定
  function isString(value) {
    return typeof value === 'number'
  }

  console.log(animal.some(isString));//false

filterメソッド

  let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

  //値に'l'が含まれているかの判定
  function includingL(value) {
    return value.includes('l')
  }

  console.log(animal.filter(includingL)); //[ 'elephant', 'lion' ]

forEachメソッド

配列の各要素に対して関数を実行するメソッドです。

  let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];

 //各要素をログする関数
  function logAnimal(value) {
    console.log(value);
  }

  animal.forEach(logAnimal);

mapメソッド

配列の各要素に対して関数を実行し、その実行結果を要素とした新たな配列を返すメソッドです。

  let animal = ['cat', 'dog', 'elephant', 'tiger', 'lion', 'monkey'];
 
 //各要素の先頭に'a 'を加える関数
  function logAnimal(value) {
    return 'a ' + value;
  }

 console.log(animal.map(logAnimal));//[ 'a cat', 'a dog', 'a elephant', 'a tiger', 'a lion', 'a monkey' ]

reduceメソッド / reduceRightメソッド

前の処理を引き継ぎながら関数の処理を実行するメソッドです。reduceメソッは配列の先頭から末尾に向かって処理を行います。reduceRightメソッドは配列の末尾から先頭に向かって処理を行います。

  let array = [2,3,4];

  //前の処理値を足し合わせる関数
  function sum(previousOutput, value) {
    return previousOutput + value;
  }

  console.log(array.reduce(sum)); //9
  console.log(array.reduce(sum,2)); //11

//reduceメソッドとreduceRightメソッドの挙動の違い
 let array = [2,3,4];

  //前の処理値を足し合わせる関数
  function sum(previousOutput, value) {
    return previousOutput + value;
  }

  console.log(array.reduce(sum)); //9
  console.log(array.reduceRight(sum)); //9


  let array_2 = ['a','b','c'];

  //前の処理値を結合する関数
  function con(previousOutput, value) {
    return previousOutput + value;
  }

  console.log(array_2.reduce(con)); //abc
  console.log(array_2.reduceRight(con)); //cba

まとめ

配列（Arrayオブジェクト）に使える便利なメソッドをご紹介しました。