【チートシート】GAS（Google Apps Script）のクラス・関数・メソッド一覧

GAS（Google App Script）は、日々の業務効率化や、仕事の自動化など多岐にわたる使い方ができる、Googleが提供しているプラットフォームです。GASを使えば、GmailやGoogleドキュメント、スプレッドシートなどと組み合わせて様々なタスク・業務を自動化する事ができます。

あわせて読みたい

【初学者向け】GASとは？何ができるの？自動化に使える？GASについて簡単に解説します！ GAS（Google App Script）とは、Googleが開発したアプリケーションのプラットフォームのことです。よく「プログラミング言語」と紹介されることがありますが、厳密には...

今回は、そのGASのスクリプトを書く際によく使うクラス・関数・メソッドをご紹介します。

チートシート的に使っても良いですし、この辺りの知識が曖昧な人も学習・復習できるように紹介していますので、是非ご活用ください。

GASでよく使うクラス・関数・メソッドを覚えておけば、プログラムを記述する際にスラスラ書く事ができる様になります。また、他の人が書いたGASのコードを読む時にも、理解が深まることが期待されます。

※全クラス・メソッドが本記事で記載されている訳ではありません。
正確な情報は公式リファレンスをご覧ください

前提知識を整理する

まずは、GASにおけるクラス・関数・メソッドを見ていく前に、「そもそもクラス・関数・メソッドとは？」といったところを改めて整理しておきましょう。

あわせて読みたい

【入門講座】GASで覚えるJavaScript入門①！プログラミング未経験でもこれさえやればOK！「変数・定数」... GASは、日々の業務効率化や、仕事の自動化など多岐にわたる使い方ができる、Googleが提供しているプラットフォームです。 GASを使えば、環境構築の作業をすることなく、...

あわせて読みたい

【入門講座】GASで覚えるJavaScript入門②｜プログラミング未経験でもこれさえやればOK！「オブジェクト... GASは、日々の業務効率化や、仕事の自動化など多岐にわたる使い方ができる、Googleが提供しているプラットフォームです。 GASを使えば、環境構築の作業をすることなく、...

そもそも「クラス」って何？

GASにおけるクラスとは、他のプログラミング言語とも同様ですが、便利で事前に用意された関数のまとまりと理解すると良いでしょう。

関数に関しては、次の項をご覧ください。

そもそも「関数」って何？

GASにおける関数とは、他のプログラミング言語とも同様ですが、任意の入力「引数」を使い、処理を行った上で最終的な処理・出力を行うひとまとまりのプログラムのかたまりと理解すると良いでしょう。

関数は、ある程度まとまった機能の単位で作ることもあれば、さらにそれを使ってより大きな関数を作ることもあります。また、同じ様な処理を共通化したりすることでコーディング効率を図る事ができます。

function で始まるものが、関数にあたります。（functionをつける事で、関数の宣言をしている）

function myKansu(引数1, 引数2,...) {
  // ここに任意の処理を書く
}

そもそも「メソッド」って何？

GASにおけるメソッドとは、他のプログラミング言語とも同様ですが、特定のオブジェクトに対して使用できる特定の処理のこと、と理解すると良いでしょう。オブジェクトとは、キーとプロパティで構成されたデータの事であり、JavaScriptではかなり頻用します。

let object_sample = {
  キー: プロパティ,
  キー2: プロパティ2,
}

オブジェクトに対してメソッドが使えるということは、そのオブジェクト内に関数が定義されているということになります。これを関数リテラルと言います。

let object_sample = {
  hello: function() {
    console.log("Hello!");
  },
  age: 20
}

たとえば、上記の様なオブジェクトがあった場合、ドット記法でメソッドを利用する事ができます。

実際にGASでサンプルコードを動かして確認してみて下さい。

function mySampleMethod() {
  let object_sample = {
  hello: function() {
    console.log("Hello!");
  },
  age: 20
  };

  object_sample.hello();
}

このとき、hello()に当たる部分がメソッドになります。

GASのクラス・関数・メソッド一覧

それでは、ここからGASでよく使うクラス・関数・メソッドを確認していきましょう。

Googleサービスごとにまとめていきたいと思いますので、よく使うサービスのものを見ていただければと思います。

Googleスプレッドシートで使うクラス

SpreadsheetAppクラス

Googleスプレッドシートにアクセスする際に最も使うのがこのSpreadsheetAppになります。Googleスプレッドシート ファイルにアクセスして作成したりする事が可能です。

Banding

スプレッドシートの範囲の行または列に適用される縞模様（カラーパターン）にアクセスして変更できるクラスです。各縞模様（Banding）は、範囲と、行、列、ヘッダー、フッターの色のセットで構成されています。

これらは代表的なクラスにおけるメソッドであり、この他に無数のクラス・メソッドが存在しています。

よく使うクラス・関数・メソッドに関しては、こちらの記事にまとめています。

あわせて読みたい

【GAS】スプレッドシートで「よく使う」GASのクラス・メソッド一覧【Google Apps Script】 GAS（Google App Script）でプログラムを記述する際、GAS独自のクラスや関数・メソッドを利用する事がよくあるかと思います。 特に、他のGoogleサービスと連携させる時...

Googleドキュメントで使うクラス

DocumentApp

Googleドキュメントにアクセスする際に最も使うのがこのSpreadsheetAppになります。

Body

ドキュメントの本文を表す要素を操作するときに最も使用されるクラスです。

Bookmark

ブックマークを表すオブジェクトを扱うクラスです。

ContainerElement

ContainerElementは他の要素を含む可能性のある汎用要素です。Paragraph などの子要素を含む可能性のあるすべての要素は ContainerElement を継承します。

Date

書式設定された日付を表す要素を扱うクラスになります。

Document

リッチテキストや、表やリストなどの要素を含むドキュメントを扱うクラスです。ドキュメントは DocumentApp を使用して開いたり作成したりできます。

// IDでドキュメントを開く
var doc = DocumentApp.openById("<my-id>");

// ドキュメントを作成し、開く
doc = DocumentApp.create("Document Title");

Equation

数式を表す要素を扱うクラスです。Equation には、EquationFunction 要素、EquationSymbol 要素、Text 要素を含めることができます。

これらは代表的なクラスにおけるメソッドであり、この他に無数のクラス・メソッドが存在しています。

Googleカレンダーで使うクラス

CalendarApp

Googleカレンダーにアクセスする際に最も使うのがこのCalenderAppになります。ユーザーの Googleカレンダーの読み取りと更新をスクリプトに許可します。

このクラスを使用すると、ユーザーのデフォルト カレンダーに直接アクセスできるだけでなく、ユーザーが所有または登録している追加のカレンダーも取得できるようです。

これらは代表的なクラスにおけるメソッドであり、この他に無数のクラス・メソッドが存在しています。

Gmailで使うクラス

GmailApp

Gmailにアクセスする際に最も使うのがこのGmailAppになります。Gmail のスレッド、メール、ラベルへのアクセスを許可します。

GmailAttachment

Gmail の添付ファイル操作等に利用するクラスになります。

// 最初の 100 件の受信トレイスレッド内の添付ファイルに関する情報をログに記録。
var threads = GmailApp.getInboxThreads(0, 100);
var msgs = GmailApp.getMessagesForThreads(threads);
for (var i = 0 ; i < msgs.length; i++) {
  for (var j = 0; j < msgs[i].length; j++) {
    var attachments = msgs[i][j].getAttachments();
    for (var k = 0; k < attachments.length; k++) {
      Logger.log('Message "%s" contains the attachment "%s" (%s bytes)',
                 msgs[i][j].getSubject(), attachments[k].getName(), attachments[k].getSize());
    }
  }
}

GmailDraft

ユーザーの Gmail アカウントでユーザーが作成したメールの下書きを操作するクラスになります。

GmailLabel

ユーザーの Gmail アカウントでユーザーが作成したラベルを操作するクラスになります。

GmailMessage

ユーザーの Gmail アカウントのメッセージを操作するクラスです。

GmailThread

ユーザーの Gmail アカウントのスレッドを操作するクラスになります。

GmailにはGmail APIという高度な拡張サービスがあり、この API を使用すると、 Gmail メールボックス内のスレッド、メッセージ、ラベルを検索して変更することができます。より詳細なデータを取得することも可能です。

リファレンスドキュメントはこちらになります。

Googleドライブで使うクラス

DriveApp

Googleドライブにアクセスする際に最も使うのがこのDriveAppになります。スクリプトを使用して Google ドライブのファイルとフォルダを作成、検索、変更できます。

これらは代表的なクラスにおけるメソッドであり、この他に無数のクラス・メソッドが存在しています。

Googleフォームで使うクラス

FormApp

Googleフォームにアクセスする際に最も使うのがこのFormAppになります。

CheckboxGridItem

列と行のグリッドとして表示される質問アイテムを操作するクラスです。回答者は、一連のチェックボックスから行ごとに複数の選択肢を選択できます。アイテムは Form からアクセスまたは作成できます。

// IDを指定してフォームを開き、新しいチェックボックスグリッドを作成する
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addCheckboxGridItem();
item.setTitle('Where did you celebrate New Years?')
  .setRows(['New York', 'San Francisco', 'London'])
  .setColumns(['2014', '2015', '2016', '2017']);

CheckboxItem

回答者が 1 つ以上のチェックボックスを選択できる質問アイテムと、オプションの「その他」フィールドを操作するクラスになります。アイテムは Form からアクセスまたは作成できます。テストで使用すると、これらの項目は自動採点されます。

// IDを指定してフォームを開き、新しいチェックボックスを作成する
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?')
    .setChoices([
          item.createChoice('Ketchup'),
          item.createChoice('Mustard'),
          item.createChoice('Relish')
    ])
    .showOtherOption(true);

Choice

選択肢をサポートするItemタイプに関連付けられた単一の選択肢について操作できるクラスです。

DateItem

回答者が日付を選択できる質問アイテムを操作できるクラスです。アイテムはFormからアクセスまたは作成できます。

// IDを用いてフォームを開き、新しい日付アイテムを追加する
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addDateItem();
item.setTitle('When were you born?');

DateTimeItem

回答者が日時を提示できる質問アイテムを操作できるクラスです。アイテムはFormからアクセスまたは作成できます。

// IDを指定してフォームを開き、新しいDateTimeアイテムを追加する
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var item = form.addDateTimeItem();
item.setTitle('When do you want to meet?');

これらは代表的なクラスにおけるメソッドであり、この他に無数のクラス・メソッドが存在しています。

Googleスライドで使うクラス

SlidesApp

Googleスライドにアクセスする際に最も使うのがこのSlidesAppになります。編集可能な Presentations を作成して開きます。

これらは代表的なクラスにおけるメソッドであり、この他に無数のクラス・メソッドが存在しています。

まとめ

GAS（Google Apps Script）のクラス・関数・メソッド一覧としていくつかの代表的なクラス・関数・メソッドを紹介していきましたが、いかがだったでしょうか。

全てまとめると、その数は非常に膨大な数になります。そのため、よく使うクラス・メソッドはある程度覚えた上で、実装に必要なクラスやメソッドを逆引きしていくというやり方が良いかと思います。

まだまだこれら以外にもたくさんのクラス・メソッドが存在するので、気になる方は公式のリファレンスも是非ご覧ください。

是非、用意されているデフォルトのクラス・メソッドを利用して、より業務の効率化を目指してみてください！

＼GASを使ってこんなことができます！／

あわせて読みたい

スプレッドシートのメールアドレスにGASでメールを一斉送信する方法【Google Apps Script】 スプレッドシートで一括管理したメールアドレスに、一斉送信したい！さらに、件名や本文で「○○様」等にカスタムしたい！そんな時はありませんか？ GAS（Google Apps Scr...

あわせて読みたい

GASを使ってGoogleドライブ内のファイルを自動バックアップする！【Google Apps Script】 GASは、日々の業務効率化や、仕事の自動化など多岐にわたる使い方ができる、Googleが提供しているプラットフォームです。GASを使えば、GmailやGoogleドキュメント、スプ...