Google Workspace アドオンのトリガー

Apps Script トリガーは、指定されたイベントが発生するたびに、指定されたスクリプト関数（トリガー関数）を実行します。トリガーを起動できるイベントは限られており、各 Google Workspace アプリケーションでサポートされているイベントのセットは異なります。

トリガーが起動すると、イベントオブジェクトが作成されます。この JSON 構造には、発生したイベントの詳細が含まれています。イベントオブジェクト構造の情報は、トリガーの種類によって整理方法が異なります。

イベントオブジェクトが作成されると、Apps Script はトリガー関数にパラメータとして渡します。トリガー関数は、イベントに応答して適切なアクションを実行するために、ユーザーが実装する必要があるコールバック関数です。たとえば、Gmail を拡張する Google Workspace アドオンでは、ユーザーがメッセージスレッドを開いたときに新しいカードインターフェースを作成するトリガーを定義できます。この場合、コンテキストコールバック関数を実装して、イベントオブジェクトで渡されたデータを使用して新しい UI を構成するカードを作成します。

このページでは、Google Workspace アドオンプロジェクトでトリガーを使用する際のガイドラインについて説明します。

マニフェストトリガー

エディタアドオンとは異なり、Google Workspace アドオンでは Google Apps Script のシンプルなトリガーを使用できません。代わりに、Google Workspace アドオン専用に設計されたトリガー（マニフェストトリガー）を使用します。

マニフェストトリガーは、Google Workspace アドオンマニフェストで定義されます。次に例を示します。

アドオンのホームページを作成して表示するホームページトリガー 。
イベントが開かれたときに新しいカードを表示したり、他のアクションを実行したりするGoogle カレンダー eventOpen トリガー 。
ユーザーがイベントを編集して保存したときに新しいカードを表示したり、他のアクションを実行したりするカレンダー eventUpdate トリガー 。
ユーザーがファイルまたはフォルダを選択したときに新しいカードを表示したり、他のアクションを実行したりするGoogle ドライブ onItemsSelected トリガー 。
ユーザーが作成ウィンドウでアドオンを開いたときにアドオンカードを表示するGmail 作成トリガー 。
ユーザーがメッセージを開いたときに新しいカードを表示したり、他のアクションを実行したりするGmail コンテキストトリガー 。
ユーザーがドキュメントで drive.file OAuth スコープの承認を付与したときに新しいカードを表示するエディタ onFileScopeGranted トリガー 。

このリストでは、ホームページトリガーのみがコンテキスト以外で、残りはコンテキストです。マニフェストトリガーの定義について詳しくは、マニフェストをご覧ください。

マニフェストトリガーに加えて、Google Workspace アドオンでは Apps Script インストール可能なトリガーを使用できます。

マニフェストトリガーの使用には、いくつかの制限があります。

これらのトリガーは、Google Workspace アドオンプロジェクトでのみ使用されます。
アドオンマニフェストで定義されており、コードで定義されていないため、Apps Script Script サービスを使用して作成または変更することはできません。
Gmail コンテキストトリガーは、コンテンツに関係なく、すべてのメールメッセージに対して起動します。
各アドオンには、ユーザーごと、ドキュメントごとに、各タイプのトリガーを 1 つだけ含めることができます。