Google App Script (Gas) 参考サイトとメモ

概要

関数

function 関数名(){
  実行される処理1;
  実行される処理2;
  ...

  return 戻り値;
}

よく使うメソッド一覧

配列（Array）

配列の作成
多次元配列
配列の長さ array.length
配列のループ
配列の検査
配列の連結 array.concat(array2, ...) ,array.join([separator])
配列要素の取り出しと追加
配列の並べ替え array.sort([func]),array.reverse()
配列から文字列への変換 array.toString(),array.toLocaleString([locales[, options]])
配列要素の変更
分割代入
スプレッド構文
型付き配列

配列処理のメソッド

メソッド	効果
shiftメソッド	配列の最初の要素を取り出す
unshiftメソッド	配列の先頭に新しい要素を追加する
pushメソッド	配列の末尾に新しい要素を追加する
popメソッド	配列の最後の要素を取り出す

正規表現 RegExp()

matchを使って文字列を抽出する方法
replaceを使って置換を行う方法

正規表現　　$ , \d{4}

.appendRow()

SheetオブジェクトのappendRowメソッドは 引数 で与えた一次元配列を、シートの 最終行の次の行のデータとして追加する ことができる。

for

for (var i = 0; i < arr.length; i++)

配列のループ 項目参照

i++

.next()/ .hasNext()

.getFiles()・.getFolders()のメソッドで、すべてのファイル／フォルダを取得できる。
返値は配列などではなく、FileIterator・FolderIteratorといったオブジェクト。
これは イテレーター と呼ばれる機能を提供するオブジェクト。
イテレーターというのは、配列のようにたくさんのオブジェクトをまとめ、そこから１つずつ順番に値を取り出していくための仕組み。

FileIterator・FolderIteratorのオブジェクトには、以下のようなメソッドが要されており、これらを使って順にオブジェクトを取り出していくことができる。

ファイル／フォルダを取り出す

変数 = 《イテレーター》.next();

nextを呼び出す度に順番にオブジェクトが取り出されていく。すべて取り出し終えた後、更にnextを呼ぶとnullになる。

ファイル／フォルダが残っているか調べる

変数 = 《イテレーター》.hasNext();

nextで取り出せるオブジェクトが残っているかどうかを調べる。返値がtrueならば残っており、falseならばすべて取り出し終えたことを示す。

file.hasnext()

次のファイルがあればtrueを返す。
while構文を組み合わせてファイル数分のループ処理を実行できる。

while(files.hasNext()){
    
    let file = files.next();
}

.getFolders()　/ .getFiles()

子フォルダは、指定したフォルダに対してgetFoldersで取得。getFoldersの　戻り値 はFolderIterator

ファイルは、指定したフォルダに対してgetFilesで取得。getFilesの 戻り値 はFileIterator

getFolders、 getFiles で得られるのは Iterator なので、何か操作したい場合は hasnext や next を用いる

Iterator とは？

.getFolderById(ID) / .getFileById(ID)

ファイル情報の取得に使うコード　.get〜

全てのファイルを取得するメソッド

.getFiles()

ID・ファイル名・ファイルタイプを指定するメソッド

メソッド	説明
getFolderById(ID)	指定されたIDを持つフォルダー
getFilesByType([MIMEタイプ])	指定されたMIMEタイプを持つファイル
getFilesByName(name)	指定された名前を持つファイル
getFoldersByName(name)	指定された名前を持つすべてのフォルダー

取得したファイルから情報を得るメソッド

メソッド	説明
getDateCreated()	Folder作成された日付
getDescription()	ファイルの説明
getEditors()	編集者のリスト
getFolders()	現在のフォルダー内にあるフォルダー
getSize()	ファイルのサイズ
getLastUpdated()	ファイルが最後に更新された日付
getParents()	親フォルダのコレクション
getName()	ファイル名
getId()	ファイルのid
getUrl()	ファイルのURL

Googleドライブ上のフォルダやファイルを取得するメソッド（サンプルコード）

Googleドライブ上のフォルダやファイルを取得するサンプルコード

コード	取得するもの
getFolderById(id)	フォルダIDで指定したフォルダ
getFolders()	対象フォルダ内のフォルダすべて
getFoldersByName(name)	対象フォルダ内の指定したフォルダ名に一致するフォルダすべて
getRootFolder()	マイドライブを取得
getTrashedFolders()	ゴミ箱に捨てられたフォルダ
searchFolders(params)	検索クエリに合致するフォルダすべて
getFileById(id)	ファイルIDで指定したファイル
getFiles()	対象フォルダ内のファイルすべて
getFilesByName(name)	対象フォルダ内の指定したファイル名に一致するファイルすべて
getFilesByType(mimeType)	対象フォルダ内の指定したファイルタイプに一致するファイルすべて
getTrashedFiles()	ゴミ箱に捨てられたファイル
searchFiles(params)	検索クエリに合致するファイルすべて

getLastColumn()

.create

.concat

Drive.Files.insert

getLastRow

getRange()

セル範囲を取得する

方法	戻り値の型	簡単な説明
getRange(row, column)	Range	左上のセルが指定された座標にある範囲を返します
getRange(row, column, numRows)	Range	左上のセルが指定された座標で、指定された行数で範囲を返します。
getRange(row, column, numRows, numColumns)	Range	与えられた行数と列数を持つ、指定された座標の左上のセルを持つ範囲を返します。
getRange(a1Notation)	Range	A1表記またはR1C1表記で指定された範囲を返します。

getValue

insertSheet

.length

open(file)

.push()

配列の最後に要素を追加する場合は、Arrayオブジェクトに対するpushメソッドを使う　。

return文

関数(メソッド)が実行されたときにどの値を返すか指定すると同時にその関数の処理も終了させることができる。
この終了処理を応用して、 『要素が見つからなかった場合は処理を終了(エスケープ)させる』 といった処理を構築することができる。
注意点：『return文』は 関数(メソッド)の中でしか 書くことができない。

setValue

sort()

StartRow プロパティ

対応するセルの最初の行。既定値は0。

関数の構文

方法1

SORT(範囲,並び替える列,昇順,並び替える列2,昇順2･･･)

方法２

昇順にsortするには、並び替える範囲を指定した後に

範囲.sort(1);

Googleドライブの指定フォルダにスプレッドシートを新規作成する

特定列の最終行・特定行の最終列を取得する方法

var exports = exports typescript

hoge.gs

var exports = exports || {};
var module = module || { exports: exports };
exports.Hoge（ファイル名） = void 0;

void 0

複数のスプレッドシートの値とノートを1つのシートにまとめたい（シート1）

appsscript.json マニフェスト