Google ドキュメントの拡張

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

基本情報

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

どちらの場合も、次の例に示すように、Apps Script の Document Service を介して 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 を使用して、そのスクリプトをアドオンとしてpublishし、他のユーザーがアドオンストアからインストールできるようにします。

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

トリガー

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

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