新しい Google Workspace アドオンをビルドする場合は、次の一般的な手順を行います。
- アドオンのプロジェクトを設定し、オーナーと共同編集者を選択します。
- アドオンの外観と動作を設計します。
- アドオンのプロジェクト マニフェストまたはデプロイ リソースを構成します。
- アドオンの外観と動作を定義するコードを記述します。
- アドオンの OAuth スコープを確認します。
- 拡張するホスト アプリケーション内でアドオンをテストします。
- アドオンを公開します。
アドオンのプロジェクトを設定し、オーナーと共同編集者を選択する
Apps Script でアドオンをビルドする場合は、Apps Script プロジェクトと Google Cloud プロジェクトの両方を作成します。Apps Script 以外の言語でアドオンを構築する場合は、Google Cloud プロジェクトを作成するだけで済みます。
アドオンの開発を開始する前に、単一のユーザー アカウントを選択してプロジェクトを所有し、どのアカウントを共同編集者とするかを決定します。プロジェクトのオーナーは、プロジェクト ファイルと関連設定を作成し、管理します。共同編集者はコーディングとテストを行うことができます。
Apps Script プロジェクト
アドオンの Apps Script プロジェクト ファイルを共有ドライブに作成し、1 つのアカウントに唯一の所有権を割り当てないようにします。アドオン スクリプト ファイルを共有ドライブに配置すると、複数の共同編集者がスクリプト プロジェクトにアクセスできるようになります。
アドオンを公開すると、1 つのユーザー アカウントがパブリッシャーとして機能します。公開アカウントには、スクリプト プロジェクトに対する編集権限が必要ですが、オーナーである必要はありません。
Apps Script プロジェクトを作成するには、スクリプト プロジェクトをご覧ください。
Google Cloud プロジェクト
共同編集者をアドオンの Cloud プロジェクトに追加することをおすすめします。これにより、チームの誰かがいつでもアドオンの Cloud 設定にアクセスできます。
Google Cloud プロジェクトを作成するには、Google Cloud プロジェクトの作成をご覧ください。
アドオンの外観と動作を設計する
アドオンの外観と動作を決めてからビルドします。アドオンでどのようなユースケースを実現すべきかを検討します。まずは簡単なデザインから始め、その後改善を加えます。
アドオンのユーザー エクスペリエンスを設計する際のガイドラインについては、Google Workspace アドオンのスタイルガイドをご覧ください。
アドオン プロジェクト マニフェストを構成する
Apps Script プロジェクトでは、プロジェクト マニフェストは特別な JSON ファイルです。ライブラリの依存関係など、プロジェクトに関するさまざまな詳細を指定します。Google Workspace アドオンの場合、マニフェストは、ホストアプリがアドオンを正しく表示するために必要な基本情報も提供します。
Apps Script でアドオンのマニフェストを設定する方法については、マニフェストをご覧ください。
アドオンにコードと機能を追加する際は、必要に応じてマニフェストを編集して、必要なアドオンの外観と動作を生成します。
アドオンをコーディングする
アドオンにはカードベースのインターフェースを実装する必要があります。Apps Script のカードサービスを使用するか、別のコード言語で記述する場合は、インターフェースがカードとしてレンダリングされるように、適切な形式の JSON を返します。
また、アドオン マニフェストで指定されたトリガー関数も実装する必要があります。アドオンが OAuth を使用して Google 以外のサードパーティのサービスに接続する場合は、そのサービスについても OAuth を構成する必要があります。
カードの作成
アドオンのユーザー インターフェースを定義するには、Card オブジェクトを作成して、ウィジェットを入力します。マニフェストで指定されたトリガー関数は、アドオン インターフェースの異なる「ページ」を表す単一の Card オブジェクトまたは Card オブジェクトの配列を返す必要があります。このアドオンによって、ユーザーの操作に応じて新しいカードが作成されて表示されることもあります。
Apps Script では、CardBuilder クラスを使用してカードを作成します。各カードには CardHeader と 1 つ以上の CardSections が必要です。各カード セクションに、アドオン インターフェースを構成する個々のウィジェットを入力する必要があります。操作ウィジェットは通常、操作の動作を定義するために操作にリンクされます。
CardBuilder を介してすべてのセクションとウィジェットをカードに追加したら、CardBuilder.build() を呼び出して、対応する Card オブジェクトを作成する必要があります。
CalendarApp など、他の組み込みの Apps Script サービスを使用して、構築したアドオンカードに表示する情報を取得できます。Google 以外のサービスから取得したデータを使用できます。
Google Workspace アドオンが OAuth を必要とする Google 以外の API にアクセスする必要がある場合は、そのサービスを構成して接続する必要があります。詳細については、Google 以外のサービスへの接続ガイドをご覧ください。
建設順序
カードを作成する際は、一から作成する必要があります。つまり、次のような構成順序を使用する必要があります。
- ウィジェットを作成します。
- カード セクションにウィジェットを追加します。
- カード セクションにすべてのウィジェットが表示されるまで繰り返します。
- カードにカード セクションを追加します。
カードまたはカード セクションにウィジェットを追加すると、実際にはそのウィジェットのコピーが追加されるため、この追加が必要です。追加したウィジェット オブジェクトに加えた変更は、最終カードには反映されません。
ユニバーサル アクション
ユニバーサル アクションを使用すると、コンテキストに依存しない機能を提供できます。ユニバーサル アクションは、表示されるカードに関係なく、アドオン UI で使用できるメニュー項目です。定義したすべてのユニバーサル アクションは常にアドオンのカードメニューに表示されます。
詳しくは、ユニバーサル アクションをご覧ください。
アドオンの OAuth スコープを確認する
スコープにより、ユーザーの代理でアドオンの実行を許可するアクションが定義されます。アドオンのスコープは、機能において必要不可欠なもののみとすることをおすすめします。
アドオン プロジェクトで、可能な限り最小限のスコープのセットをアドオンで使用するには、アドオンのスコープを明示的に設定します。アドオンが使用するスコープは、アドオンのマニフェストで定義します。
詳細については、スコープをご覧ください。
アドオンをテストする
まず、非公開アドオンをインストールすることで、非公開アドオンをテストできます。インストールと承認が完了すると、アカウントでアドオンを使用して、拡張機能がホストされているアプリケーションでの外観と動作をテストできます。アドオンがコンテキストやユーザーの操作に対して想定どおりに動作することを確認する必要があります。
詳しくは、Google Workspace アドオンのテストをご覧ください。
アドオンを公開する
アドオンを公開すると、一般公開またはドメイン内のユーザーのみが使用できるようになります。公開プロセスを開始する前に、パブリケーションの概要をご確認ください。公開は複雑なプロセスであり、準備と完了に時間がかかります。
Google Workspace アドオンは Google Workspace Marketplace で公開されています。一般公開されているアドオンは、公開前にアプリの審査を完了する必要があります。
詳しくは、Google Workspace アドオンの公開をご覧ください。
Google Workspace アドオンの例
Google Workspace のアドオンのクイックスタートでは、ホームページ、カード ナビゲーション、サードパーティ サービスとの接続など、Google Workspace アドオンを簡単に作成する方法を説明しています。クイックスタートが完了したら、アドオンをインストールしてコードをテストできます。