新しい Google Workspace アドオンを構築する場合は、次の一般的な手順を行います。
- アドオンのプロジェクトを設定し、オーナーと共同編集者を選択します。
- アドオンの外観と動作を設計する。
- アドオンのプロジェクト マニフェストまたはデプロイ リソースを構成します。
- アドオンの外観と動作を定義するコードを記述します。
- アドオンの OAuth スコープを確認します。
- 拡張するホストアプリケーション内でアドオンをテストします。
- アドオンを公開します。
アドオンのプロジェクトを設定し、オーナーと共同編集者を選択する
Apps Script でアドオンを作成する場合は、Apps Script プロジェクトと Google Cloud プロジェクトの両方を作成します。Apps Script 以外の言語でアドオンを構築する場合は、Google Cloud プロジェクトを作成するだけで済みます。
アドオンの開発を始める前に、プロジェクトを所有するユーザー アカウントを 1 つ選択し、他のアカウントを共同編集者として指定します。プロジェクトのオーナーはプロジェクト ファイルと関連する設定を作成、管理し、共同編集者はコーディングとテストを手伝うことができます。
Apps Script プロジェクト
アドオンの Apps Script プロジェクト ファイルは共有ドライブ内に作成できるため、1 つのアカウントが単独で所有権を持つことはなくなります。アドオン スクリプト ファイルを共有ドライブに配置すると、複数の共同編集者がスクリプト プロジェクトにアクセスできるようになります。
アドオンを公開すると、1 つのユーザー アカウントがパブリッシャーとして機能します。公開アカウントにはスクリプト プロジェクトの編集権限が必要ですが、オーナーである必要はありません。
Apps Script プロジェクトを作成するには、スクリプト プロジェクトをご覧ください。
Google 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 アドオンの公開をご覧ください。