組み込みの Google サービス

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

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

最新の JavaScript 機能

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

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

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

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

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

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

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

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

メソッドを呼び出す

ほぼすべての組み込みサービスまたは高度なサービスのグローバル オブジェクトには、データを返すメソッドまたは 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 キーワードを使用してこれらのクラスを作成することはできません。子クラスにアクセスするには、そのクラスを返すメソッドを呼び出す必要があります。特定のクラスにアクセスする方法がわからない場合は、サービスのルート ドキュメントにアクセスして、目的のクラスを返すメソッドを探してください。

インターフェースの処理

リファレンス サービスでは、「interfaces」というラベルの付いた特別なクラスが含まれています。これらは、事前に正確な型を判別できないメソッドの戻り値の型として使用される汎用クラスです。たとえば、ドキュメント サービス メソッドの 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);