Google Apps Scriptの公式ドキュメントの見方とリンク一覧

Google Apps Script

Google Apps Script(GAS)でスクリプトを作成するとき、公式ドキュメントを見る機会がちょいちょいありますよね。検索エンジンから「GAS ドキュメント」などで探すけど、そこから自分が探しているメソッドを探すのがちょっと面倒。検索窓からメソッド名を入れてもヒットせず、毎回クラス名から辿ることになります。

そこで、GASの公式ドキュメントのリンク集と、ドキュメントの見方(必要な情報までのたどり方)を作成しようと思いました。自分自身、GASを使うときに見返せるものにしたいと思い作成しています。

GASの公式ドキュメントのリンク

Google Apps Script(GAS)の公式ドキュメントのリンクは以下になります。

上記URLを開くと、以下のようにApps Scriptのトップページが表示されます。

各Googleサービスのリファレンスの開き方

画面上部にある「リファレンス」タブを押します。

左側にGmail、Google Calendarなど、Googleサービスごとのメニューが表示されているので、参照したいサービス名を押します。今回はGoogleスプレッドシートを開きます。

すると、下位のメニューが表示されますので、そのなかから最上位のクラスとなる「SpreadsheetApp」を押します。

サービスによっては「Gmailアプリ」「フォームアプリ」など、日本語表記の場合もありますが、基本的には「~App」または「~アプリ」という名前になります。

このようにして、各サービスの上位クラスからメソッドを辿ります。

GASはJavaScriptをベースとしている言語であり、Math、String、ArrayなどのオブジェクトはJavaScriptを使用します(コアJavaScriptと呼ばれます)。

そのため、これらの基本的な文法について調べる場合には、JavaScriptのリファレンスを参照します。詳しくは以下記事をご参照ください。

【初心者向け】GASとJavaScriptの違いを徹底解説!

各サービスのリファレンス一覧

ここまで、GASの公式ドキュメントの見方について解説しましたが、毎回トップページから目的のサービスまで辿るのは正直面倒です。そこで、以下に各サービスのリンクをまとめます。

「クラス一覧」には、各サービスのクラス一覧が載っています。「~Appクラス」は、クラス一覧のうちのひとつであり、かつ、最上位のオブジェクトにあたります。

サービス名クラス概要
Googleスプレッドシートクラス一覧
SpreadsheetAppクラスシートの作成・取得など
Googleカレンダークラス一覧
CalendarAppクラスカレンダーに登録されたイベントの取得、追加、削除など
Googleドキュメントクラス一覧
DocumentAppクラスドキュメントの作成・取得など
Google Driveクラス一覧
DriveAppクラスファイルやフォルダの作成・取得など
Googleフォームクラス一覧
FormAppクラスFormに対する操作
Gmailクラス一覧
GmailAppクラスGmailの送信・スレッドの取得など
Googleスライドクラス一覧
SlidesAppクラスGoogleスライドに対する操作

ドキュメントの見方:スプレッドシートの例

たとえば、Googleスプレッドシートのセルの値を取得するメソッドを調べる方法について考えます。

  1. 対象のスプレッドシートを開く
  2. 対象のシートを指定する
  3. セルを指定して値を取得する

となります。これを順番にスクリプトに落とし込んでいきます。

最初に、トップレベルのオブジェクトであるSpreadsheetAppを用いてスプレッドシートにアクセスします。次に、その下の階層のSpreadsheetクラスを用いてシートを指定します。RangeクラスのgetRangeメソッドを用いて、指定したセルを取得します。最後に、同じくRangeクラスのgetValueメソッドでセルのテキストを取り出します。

これをスクリプトにすると以下のようになります。

let ss = SpreadsheetApp.openbyId('xxx'); // IDでスプレッドシートを取得
let sheet = ss.getSheetByName('sheet1'); // sheet1を取得
let val = sheet.getRange('B2'); // B2セルを取得
let txt = val.getValue(); // B2セルのテキストを取得

console.log(txt); // ログに出力(出力結果は「300」)

スプレッドシートを例に説明しましたが、他のサービスの場合でも、必ず最初にトップレベルのオブジェクト(~Appクラス)を使用します。そのため、「~App」のリファレンス→クラス一覧のリファレンスの順に参照すると良いです。

Googleスプレッドシート関連

GASでは、Googleスプレッドシートを操作する機会が多いと思うので、スプレッドシート関連のリファレンスについてはこちらでまとめます。

スプレッドシートの操作方法概要

Googleスプレッドシートの開き方、セルの値取得・書き込み、書式設定などの基本的な使い方がサンプルコードとともに記載されています。

SpreadsheetAppクラス(スプレッドシートの作成・取得など)

Googleスプレッドシートを扱うためのクラスです。SpreadsheetAppが最上位のクラスとなります。Googleスプレッドシートの作成、シートの取得、スプレッドシートを開くなどのメソッドが用意されています。

SpreadsheetAppクラスの主なメソッド

Spreadsheetクラス(スプレッドシートの操作)

スプレッドシートを操作するためのクラスです。先ほど紹介したSpreadsheetAppクラスの下位クラスにあたります。

Spreadsheetクラスの主なメソッド

Sheetクラス(シートの操作)

スプレッドシートへのアクセス、操作を行うためのクラスです。Spreadsheetサービスの下位クラスにあたります。

Sheetクラスの主なメソッド

Rangeクラス(セルの操作)

セル範囲の操作を行うためのクラスです。

Rangeクラスの主なメソッド

スプレッドシートを操作する際によく使うメソッド一覧については、以下記事にまとめていますのでこちらもご参照ください。

まとめ

今回は、Google Apps Script(GAS)の公式ドキュメント(リファレンス)の見方、リンク一覧について紹介しました。公式ドキュメントは、正直あんまり使い勝手が良くないなと思うのですが(導線的に)、ネットで有益な情報が出てこないときや、正確な内容を確認したい場合には使うことになります。そのような場合に、本記事がスムーズに目的の情報に辿り着くための手助けになれば幸いです。

今後、GASを使うなかで必要だなと思った情報に関しては随時追加します。

¥2,860 (2024/04/14 23:09時点 | Amazon調べ)
chaso

文系出身、数字が苦手な平凡主婦。塾講師、大手企業SE、不動産事務、Webライター、QAエンジニアを経て現在RPAエンジニアとして働いています。機械音痴だけど効率化や自動化をこよなく愛しています!お仕事の依頼・ご相談は問い合わせよりお願いいたします♪

chasoをフォローする

コメント

タイトルとURLをコピーしました