HTML サービス: HTML の作成と配信

HTML サービスを使用すると、サーバー側の Apps Script 機能とやり取りできるウェブページを提供できます。特に、Google ドキュメント、スプレッドシート、フォームでウェブアプリを作成したり、カスタム ユーザー インターフェースを追加したりする場合に便利です。メールの本文の生成にも使用できます。

HTML ファイルを作成する

Apps Script プロジェクトに HTML ファイルを追加する手順は次のとおりです。

  1. Apps Script エディタを開きます。
  2. 左側で、[ファイルを追加] > [HTML] をクリックします。

HTML ファイルには、標準的な HTML、CSS、クライアントサイド JavaScript のほとんどを記述できます。ページは HTML5 として配信されますが、制限で説明されているように、HTML5 の高度な機能の一部は利用できません。

ファイルには、PHP と同様に、ページがユーザーに送信される前にサーバーで処理されるテンプレート スクリプトレットを含めることもできます。詳しくは、テンプレート化された HTML のセクションをご覧ください。

HTML をウェブアプリとして配信する

HTML サービスを使用してウェブアプリを作成するには、ページの提供方法をスクリプトに伝える doGet() 関数をコードに含める必要があります。次の例に示すように、関数は HtmlOutput オブジェクトを返す必要があります。

コード.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    Hello, World!
  </body>
</html>

基本的なフレームワークを設定したら、スクリプトのバージョンを保存して、ウェブアプリとしてスクリプトをデプロイするだけで済みます。

スクリプトをウェブアプリとしてデプロイしたら、Google サイトに埋め込むこともできます。

Google ドキュメント、スプレッドシート、スライド、フォームのユーザー インターフェースとして HTML を配信する

スクリプトがファイルにコンテナバインドされている場合、HTML サービスでは、Google ドキュメント、スプレッドシート、スライド、フォームでダイアログやサイドバーを表示できます。(Google フォームでは、カスタム ユーザー インターフェースを表示できるのは、編集者がフォームを開いて変更を行ったユーザーのみであり、フォームを開いて回答したユーザーには表示されません)。

ウェブアプリとは異なり、ドキュメント、スプレッドシート、フォームのユーザー インターフェースを作成するスクリプトには、特に doGet() 関数は必要ありません。また、スクリプトのバージョンの保存やデプロイも必要ありません。代わりに、ユーザー インターフェースを開く関数は HTML ファイルを HtmlOutput オブジェクトとして、アクティブなドキュメント、フォーム、またはスプレッドシートの Ui オブジェクトの showModalDialog()) メソッドまたは showSidebar() メソッドに渡す必要があります。

これらの例には、便宜上、いくつかの追加機能が含まれています。onOpen() 関数はインターフェースを簡単に開けるカスタム メニューを作成し、HTML ファイル内のボタンは google.script.host API の特別な close() メソッドを呼び出してインターフェースを閉じます。

コード.gs

// Use this code for Google Docs, Slides, Forms, or Sheets.
function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Dialog')
      .addItem('Open', 'openDialog')
      .addToUi();
}

function openDialog() {
  var html = HtmlService.createHtmlOutputFromFile('Index');
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .showModalDialog(html, 'Dialog title');
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    Hello, World!
    <input type="button" value="Close"
        onclick="google.script.host.close()" />
  </body>
</html>

このユーザー インターフェースを初めて表示する場合は、スクリプト エディタで手動で onOpen() 関数を実行するか、ドキュメント、スプレッドシート、フォーム エディタのウィンドウを再読み込みする必要があります(これによりスクリプト エディタが終了します)。その後、ファイルを開くたびに数秒以内にカスタム メニューが表示されます。[ダイアログ] > [開く] を選択してインターフェースを表示します。