組み込みの Google サービス

Google Apps Script には、ユーザーデータ、他の Google システム、外部システムとやり取りするための組み込みサービスが 30 種類以上用意されています。これらのサービスは、JavaScript の標準 Math オブジェクトと同様のグローバル オブジェクトとして提供されます。たとえば、Mathrandom() などのメソッドや PI などの定数を提供するのと同様に、Apps Script のスプレッドシート サービスには、openById(id) などのメソッド、Range などのクラス(子オブジェクト)、DataValidationCriteria などの列挙型が用意されています。

Google Workspace プロダクトを制御するサービスのリファレンス ドキュメントは、このサイトのサイドバーにある [リファレンス] ヘッダーの下にある [Google Workspace サービス] セクションに収集されています。ユーティリティ サービス(ユーザー インターフェースの作成、XML の解析、ログデータの書き込みなど)は、[スクリプト サービス] セクションに収集されます。

最新の JavaScript 機能

Apps Script は 2 つの JavaScript ランタイムをサポートしています。最新の V8 ランタイムと、Mozilla の Rhino JavaScript インタープリタを活用した古いランタイムです。

V8 ランタイムは、最新の ECMAScript の構文と機能をサポートしています。Rhino ランタイムは、以前の JavaScript 1.6 標準に加えて、1.71.8 のいくつかの機能に基づいています。スクリプトで使用するランタイムは自由に選択できますが、V8 ランタイムを使用することを強くおすすめします。

各ランタイムは、組み込みの高度な Google サービスに加えて、スクリプトで使用できる JavaScript クラスとオブジェクトをサポートしています。スクリプトでは、MathObject のグローバル オブジェクトだけでなく、ArrayDateRegExpなどの一般的なオブジェクトも使用できます。

オートコンプリートの使用

スクリプト エディタには、一般的に「オートコンプリート」と呼ばれる「コンテンツ アシスト」機能が用意されています。この機能は、グローバル オブジェクトのほか、スクリプトの現在のコンテキストで有効なメソッドと列挙型を表示します。Apps Script クラスを返すグローバル オブジェクト、列挙型、メソッド呼び出しの後にピリオドを入力すると、オートコンプリートの候補が自動的に表示されます。例:

  • グローバル オブジェクトの完全な名前を入力するか、オートコンプリートからオブジェクトを選択して、.(ピリオド)と入力すると、そのクラスのすべてのメソッドと列挙型が表示されます。
  • 数文字を入力すると、その文字で始まる有効な候補がすべて表示されます。

グローバル オブジェクトについて

各サービスには、少なくとも 1 つのグローバル(トップレベル)オブジェクトがあります。たとえば、Gmail サービスには GmailApp オブジェクトからのみアクセスします。一部のサービスでは複数のグローバル オブジェクトが提供されます。たとえば、基本サービスには 4 つのグローバル オブジェクト(BrowserLoggerMimeTypeSession)が含まれています。

メソッドの呼び出し

ほぼすべての組み込みサービスまたは高度なサービスのグローバル オブジェクトには、データまたは Apps Script クラスを返すメソッドが含まれています。スクリプトは、次の形式でメソッド呼び出しを行います。

GlobalObjectName.methodName(argument1, argument2, ..., argumentN);

たとえば、次のように、スクリプトで Gmail サービスの sendEmail(recipient, subject, body) メソッドを呼び出してメールを送信できます。

GmailApp.sendEmail('claire@example.com', 'Subject line', 'This is the body.');

メソッドが別の Apps Script クラスを返す場合は、メソッド呼び出しを 1 行で連結できます。(戻り値の型は、オートコンプリートとメソッドのリファレンス ドキュメントの両方に表示されます)。たとえば、メソッド DocumentApp.create()Document を返します。したがって、次の 2 つのコード セクションは同等です。

var doc = DocumentApp.create('New document');
var body = doc.getBody();
body.appendParagraph('New paragraph.');

// Same result as above.
DocumentApp.create('New document').getBody().appendParagraph('New paragraph.');

子クラスへのアクセス

どのサービスにも、グローバル オブジェクトのように最上位レベルからアクセスできない子クラスが 1 つ以上含まれています。Date などの標準の JavaScript クラスの場合と同様、new キーワードを使用してこれらのクラスを作成することはできません。子クラスにアクセスするには、そのクラスを返すメソッドを呼び出す必要があります。特定のクラスへのアクセス方法がわからない場合は、サービスのリファレンス ドキュメントのルートページにアクセスし、目的のクラスを返すメソッドを探してください。

インターフェースの操作

少数のサービスには、リファレンス ドキュメントでは「インターフェース」というラベルが付いている特別なクラスが含まれています。正確な型を事前に特定できないメソッドの戻り値の型として使用される汎用クラスです。たとえば、ドキュメント サービスのメソッド Body.getChild(childIndex) は、汎用の Element オブジェクトを返します。Element は、他のクラス(ParagraphTable など)を表すインターフェースです。インターフェース オブジェクトが単独で役立つことはほとんどありません。代わりに、通常は Element.asParagraph() などのメソッドを呼び出して、オブジェクトを正確なクラスにキャストします。

列挙型の操作

ほとんどのサービスには、名前付き値の列挙型(列挙型)がいくつか含まれています。たとえば、ドライブ サービスは列挙型 AccessPermission を使用して、ファイルやフォルダにアクセスできるユーザーを判断します。ほとんどの場合、これらの列挙型にはグローバル オブジェクトからアクセスします。たとえば、Folder.setSharing(accessType, permissionType) メソッドの呼び出しは次のようになります。

// Creates a folder that anyone on the Internet can read from and write to. (Domain administrators can
// prohibit this setting for Google Workspace users.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);