Google ドキュメントを拡張する

Google Apps Script を使用すると、プログラムで Google ドキュメントを作成、変更したり、新しいメニュー、ダイアログ ボックス、サイドバーを使ってユーザー インターフェースをカスタマイズしたりできます。

基本情報

Apps Script は主に 2 つの方法で Google ドキュメントとやり取りできます。スクリプトのユーザーにドキュメントに対する適切な権限があれば、あらゆるスクリプトでドキュメントを作成または変更できます。また、スクリプトをドキュメントにバインドすることもでき、これによってスクリプトがユーザー インターフェースを変更したときやドキュメントを開いたときに応答できるようになります。Google ドキュメント内からコンテナにバインドされたスクリプトを作成するには、[拡張機能] > [Apps Script] をクリックします。

いずれの場合も、次の例に示すように、Apps Script のドキュメント サービスを使用して Google ドキュメントを簡単に操作できます。

function createDoc() {
  var doc = DocumentApp.create('Sample Document');
  var body = doc.getBody();
  var rowsData = [['Plants', 'Animals'], ['Ficus', 'Goat'], ['Basil', 'Cat'], ['Moss', 'Frog']];
  body.insertParagraph(0, doc.getName())
      .setHeading(DocumentApp.ParagraphHeading.HEADING1);
  table = body.appendTable(rowsData);
  table.getRow(0).editAsText().setBold(true);
}

上のスクリプトは、ユーザーの Google ドライブに新しいドキュメントを作成し、ドキュメントの名前と同じテキストを含む段落を挿入して、その段落を見出しとしてスタイル設定し、2 次元配列の値に基づいてテーブルを追加します。このスクリプトでは、DocumentApp.create() の呼び出しを DocumentApp.openById() または openByUrl() に置き換えることで、既存のドキュメントに対する変更を簡単に行うことができます。ドキュメント（コンテナにバインド）内に作成されたスクリプトの場合は、DocumentApp.getActiveDocument() を使用します。

ドキュメントの構造

Apps Script の観点では、Google ドキュメントは HTML ドキュメントとよく似ています。つまり、Google ドキュメントは、他の要素を含むことが多い要素（Paragraph や Table など）で構成されています。Google ドキュメントを変更するほとんどのスクリプトは、getBody() の呼び出しから始まります。これは、Body が、HeaderSection、FooterSection、Footnotes 以外の他のすべての要素を含むマスター要素であるためです。

ただし、他の要素を含めることができる要素の種類については規則があります。また、Apps Script のドキュメント サービスは、特定の要素しか挿入できません。以下のツリーは、特定の要素に含めることができる要素を示しています。

太字で示されている要素は挿入できます。太字以外の要素は所定の位置で操作する必要があります。

テキストを置き換える

Apps Script は、Google ドキュメントのテキストを置き換えるためによく使用されます。スプレッドシートに顧客情報全体が格納されていて、顧客ごとにカスタマイズした Google ドキュメントを生成するとします。（このようなオペレーションは、多くの場合、メールの統合と呼ばれます）。

テキストを置き換える方法は数多くありますが、最も簡単な方法は、以下の例に示す replaceText() メソッドです。replaceText は、JavaScript の正規表現機能のほとんどをサポートしています。下記の最初の関数は、Google ドキュメントに数行のプレースホルダ テキストを追加します。実際の環境では、ドキュメントにプレースホルダを入力する可能性が高くなります。2 番目の関数は、プレースホルダを client オブジェクトで定義されたプロパティに置き換えます。

どちらの関数も getActiveDocument() メソッドを使用します。このメソッドは、Google ドキュメント内で作成されたスクリプトにのみ適用されます。スタンドアロン スクリプトでは、代わりに DocumentApp.create()、openById()、または openByUrl() を使用します。

プレースホルダを追加する

function createPlaceholders() {
  var body = DocumentApp.getActiveDocument().getBody();
  body.appendParagraph('{name}');
  body.appendParagraph('{address}');
  body.appendParagraph('{city} {state} {zip}');
}

プレースホルダを置き換えます。

function searchAndReplace() {
  var body = DocumentApp.getActiveDocument()
      .getBody();
  var client = {
    name: 'Joe Script-Guru',
    address: '100 Script Rd',
    city: 'Scriptville',
    state: 'GA',
    zip: 94043
  };

  body.replaceText('{name}', client.name);
  body.replaceText('{address}', client.address);
  body.replaceText('{city}', client.city);
  body.replaceText('{state}', client.state);
  body.replaceText('{zip}', client.zip);
}

カスタム メニューとユーザー インターフェース

メニュー、ダイアログ ボックス、サイドバーを追加して、Google ドキュメントをカスタマイズできます。ただし、スクリプトは開いているドキュメントの現在のインスタンスの UI のみを操作でき、スクリプトがドキュメントにバインドされている場合にのみ注意してください。

Google ドキュメントにカスタム メニューやダイアログを追加する方法をご覧ください。ダイアログまたはサイドバーのカスタム インターフェースの作成の詳細については、HTML サービスのガイドをご覧ください。アドオンの一部としてカスタム インターフェースを公開する場合は、Google ドキュメント エディタのスタイルとレイアウトに一貫性を持たせるために、スタイルガイドをご覧ください。

Google ドキュメントのアドオン

アドオンは Google ドキュメント内で実行され、Google ドキュメントのアドオンストアからインストールできます。Google ドキュメント用のスクリプトを開発し、そのスクリプトを世界中の人々と共有するには、Apps Script のスクリプトをアドオンとして公開します。これにより、他のユーザーがアドオンストアからそのスクリプトをインストールできるようになります。

Google ドキュメントのアドオンを作成する方法については、ドキュメント アドオンの構築に関するクイックスタートをご覧ください。

Triggers

Google ドキュメントにバインドされたスクリプトは、単純なトリガーを使用して、ドキュメントの onOpen イベントに応答できます。このイベントは、ドキュメントの編集権限を持つユーザーが Google ドキュメントで開くたびに発生します。

トリガーを設定するには、onOpen() という関数を作成します。このトリガーの例については、Google Workspace のカスタム メニューをご覧ください。シンプルなトリガーはメニューの追加には便利ですが、承認が必要な Apps Script サービスは使用できません。