用語解説

このドキュメント全体で使用される用語は次のとおりです。

カレンダー会議アドオン

会議プロバイダが Google カレンダーの予定に会議オプションを表示できるようにする、特別なアドオン。これらのアドオンを接続するには、十分に開発された会議ソリューションが必要です。この要件により、ほとんどのデベロッパーはカレンダーの会議アドオンを作成する必要がありません。

詳しくは、カレンダーの会議アドオンをご覧ください。カレンダーの会議アドオンを Google Workspace アドオンに変換する方法については、公開済みのアドオンをアップグレードするをご覧ください。

カード

アドオン UI の単一の「ページ」。カードは、さまざまなウィジェット オブジェクト(ボタン、テキスト フィールド、ヘッダーなど)で構成されます。

詳しくは、カードをご覧ください。

カードベース

ユーザー インターフェースがサイドバーのペイン(モバイルの場合はメニューからアクセスした別のアクティビティ ウィンドウ)として表示されるアドオン。アドオンの上部には、アドオンを識別するツールバーがあり、カード(基本的にはアドオンの UI の「ページ」)が表示されます。

Google Workspace アドオンはカード形式です。

会議データ

Google Workspace アドオンまたはカレンダーの会議アドオンで有効になっているサードパーティの会議を作成して参加できるように、Google カレンダーで必要となる一連の情報。

詳しくは、会議データをご覧ください。

会議ソリューション

Google Workspace アドオンまたは Google カレンダーの会議アドオンを使用して Google カレンダーから作成できるサードパーティの会議。

詳しくは、会議ソリューションをご覧ください。

コンテキスト

ホストアプリケーションの現在の状態。たとえば、現在 Gmail で開かれているメッセージ、編集しているカレンダーの予定、選択したドライブのファイルは、ホストアプリケーションの現在のコンテキストに含まれます。コンテキストは他の情報とともにイベント オブジェクトに収集され、パラメータとしてトリガー関数に渡されます。

コンテキスト トリガー

Gmail でメールスレッドを開いたときなど、ユーザーが特定のコンテキストを入力したときに起動されるトリガーを定義する方法。コンテキスト トリガーにより、アドオンはそのコンテキストに関連する UI を提供できます。コンテキスト トリガーは、アドオン スクリプト プロジェクトのマニフェストで構成されているため、マニフェスト トリガーの一種です。

エディタのアドオン

Google ドキュメント、スプレッドシート、フォーム、スライドの拡張機能のみを許可する元の種類のアドオン。エディタのアドオンはカードベースではありません。デベロッパーが未加工の HTML と CSS から UI を作成する必要がありました。各エディタ アドオンは、1 つのホストアプリケーションのみを拡張できます。

詳しくは、エディタのアドオンをご覧ください。

イベント オブジェクト

ホームページがリクエストされたとき、応答が必要なコンテキストにアドオンが入ったとき、またはアドオン インターフェースのウィジェットに対するユーザー操作の結果として自動的に作成される JSON オブジェクト。作成されると、イベント オブジェクトは指定されたトリガー関数またはコールバック関数に渡されます。イベント オブジェクトの目的は、ユーザーのクライアントサイド環境からの情報(ユーザーがアドオン インターフェース ウィジェットに入力した情報など)をアドオンのサーバーサイド コードに渡すことです。サーバーサイド コードでは、その情報を基に適切なレスポンスを返すことができます。

詳しくは、イベント オブジェクトをご覧ください。

Gmail のアドオン

Gmail のみを拡張するアドオン。Gmail アドオンはカードベースです。Gmail アドオンの作成に使用される機能、動作、開発の詳細の多くは、Google Workspace アドオンの作成に使用されるものと同じです。

詳しくは、Gmail のアドオンをご覧ください。Gmail アドオンを Google Workspace アドオンに変換する方法については、公開済みのアドオンをアップグレードするをご覧ください。

ホームページ

アドオンのルート UI カード。ユーザーがアドオンを開くと、ホームページが表示されます。このアドオンによって、特定のコンテキスト以外のコンテンツ(たとえば、ユーザーが Gmail でメールスレッドを表示しているが、開いていない場合)のコンテンツを表示できます。他のカードと同様に、アドオンのホームページの外観と動作を定義できます。

詳しくは、ホームページをご覧ください。

ホストまたはホストアプリケーション

Google Workspace アドオンで拡張される Google Workspace アプリケーション(Gmail や Google カレンダーなど)。

HTML ベース

ユーザー インターフェースが Apps Script に組み込まれているカードサービスではなく、HTML と CSS を使用して定義されているアドオン。以前のエディタ アドオンのみが HTML ベースです。

リンク プレビュー トリガーは、ユーザーが Google ホストアプリケーション(Google ドキュメントなど)内でサードパーティの URL または Google 以外の URL を操作したときに呼び出されます。リンク プレビューのトリガーを使用すると、サービスまたは API からプレビューする URL パターンを定義し、スマートチップやプレビュー カードなどのプレビュー コンテンツを構成できます。リンク プレビュー トリガーは、アドオン スクリプト プロジェクトのマニフェストで構成されているため、マニフェスト トリガーの一種です。

詳しくは、Google ドキュメントのプレビュー リンクをご覧ください。

マニフェスト

Apps Script プロジェクトに添付された JSON ファイル。マニフェストは、スクリプトを正しく実行するために必要なプロジェクト情報を定義するために使用します。Google Workspace アドオンの場合、マニフェストを使用して、アドオンが拡張できるホストを指定し、特定の UI コントロール設定を提供します。

マニフェスト トリガー

プロジェクトのマニフェストで定義されているトリガー(ホームページ トリガーやコンテキスト トリガーなど)。マニフェスト トリガーは、アドオンのホームページがリクエストされたとき、またはアドオンが表示の更新を必要とするコンテキストに入るときに、新しいカードを作成して表示するためにのみ使用されます。

マニフェスト トリガーは、Apps Script の他のトリガーとは異なり(単純なトリガーなど)、Apps Script スクリプト サービスを使用してプログラムで作成することはできません(インストール可能なトリガーなど)。

コンテキスト以外のカード

ユーザーが特定のコンテキスト外からのコンテンツを表示するカード。たとえば、Gmail でメールスレッドを表示しているが、まだ開いていない場合などです。ホームページは、コンテキストに依存しないカードの一種です。

ホスト UI の右側にあるセクション。Google Workspace アドオンの UI が表示されます。Gmail とエディタのアドオンでサイドバーを定義することもできます。

スマートチップ

スマートチップとは、Google Workspace アプリケーション内のユーザー、ファイル、カレンダーの予定、その他のエンティティに関する記述です。ユーザーがチップにカーソルを合わせると、そのファイルやリンクに関するその他のコンテンツをプレビューすることもできます。たとえば、ユーザーが Google スライドのプレゼンテーションのチップにカーソルを合わせると、スライドのスクリーンショット、プレゼンテーションのオーナー、そのプレゼンテーションを以前に表示したかどうかが表示されます。

スマートチップを使用して、サードパーティまたは Google 以外のサービスのリンクをプレビューするようにアドオンを構成できます。Google ドキュメントのプレビュー リンクをご覧ください。

トリガー

Apps Script プロジェクトまたはアドオンによって定義された条件と自動イベント レスポンス。トリガーは、関連するイベントが発生したとき(アドオンが開いたときなど)に起動し、指定された Apps Script 関数(トリガー関数)を自動的に実行します。Google Workspace アドオンの場合、アドオン UI のどの部分を表示するかを制御するために、トリガー関数によって新しいカードが作成されることがよくあります。トリガーを設定できるのは、特定のイベントタイプのみです。

詳細については、アドオン トリガーをご覧ください。

関数のトリガー

トリガーの呼び出しに応答して実行されるプロジェクト内の Apps Script 関数。

ウィジェット

ボタン、テキスト フィールド、チェックボックスなどの UI 要素。カードは、Apps Script に組み込まれたカードサービスで定義されている一連のウィジェット オブジェクトから構成されます。

詳細については、ウィジェットをご覧ください。

ウィジェット ハンドラ関数

特定のウィジェットを特定のアクション オブジェクトにリンクする関数。各ウィジェット タイプには、アクションへの接続に使用できる定義済みウィジェット ハンドラ関数のセットがあります。ウィジェット ハンドラ関数は、どのようなユーザー操作によって行われるアクションをトリガーするかを定義するもので、ウィジェットのインタラクティビティに不可欠なコンポーネントです。

詳しくは、ウィジェット ハンドラ関数をご覧ください。