組み込みの 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 キーワードを使用してこれらのクラスを作成することはできません。子クラスにアクセスするには、そのクラスを返すメソッドを呼び出す必要があります。特定のクラスにアクセスする方法がわからない場合は、サービスのリファレンス ドキュメントのルートページにアクセスして、必要なクラスを返すメソッドを探してください。

インターフェースの取り扱い

いくつかのサービスには、リファレンス ドキュメントで「インターフェース」とラベル付けされた特別なクラスが含まれています。これらは、事前に正確な型を特定できないメソッドの戻り値の型として使用される汎用クラスです。たとえば、ドキュメント サービス メソッド Body.getChild(childIndex) は汎用 Element オブジェクトを返します。Element は、他のクラス(Paragraph または Table)を表すインターフェースです。インターフェース オブジェクトがそれ自体では有用になることはほとんどありません。通常は、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);