新しい Google Workspace アドオンを作成する一般的な手順は次のとおりです。
- アドオンのプロジェクトを設定し、オーナーと共同編集者を選択します。
- アドオンの外観と動作を設計します。
- アドオンのプロジェクト マニフェストまたはデプロイ リソースを構成します。
- アドオンの外観と動作を定義するコードを記述します。
- アドオンの OAuth スコープを確認します。
- 拡張するホストアプリケーション内でアドオンをテストする。
- アドオンを公開します。
アドオンのプロジェクトを設定し、オーナーと共同編集者を選択します
Apps Script でアドオンを作成する場合は、Apps Script プロジェクトと Google Cloud プロジェクトの両方を作成します。Apps Script 以外の言語でアドオンを構築する場合は、Google Cloud プロジェクトを作成するだけで済みます。
アドオンの開発を開始する前に、プロジェクトを所有するユーザー アカウントを 1 つ選択し、他のどのアカウントが共同編集者になるかを決定します。プロジェクトのオーナーはプロジェクト ファイルとそれに関連する設定を作成して管理しますが、共同編集者はコーディングとテストを手助けします。
Apps Script プロジェクト
アドオンの Apps Script プロジェクト ファイルを共有ドライブに作成すると、アカウントの所有権が 1 つだけになることがなくなります。アドオン スクリプト ファイルを共有ドライブに配置すると、複数の共同編集者がスクリプト プロジェクトにアクセスできるようになります。
アドオンを公開すると、1 つのユーザー アカウントがパブリッシャーとして機能します。公開用アカウントはスクリプト プロジェクトに対する編集権限を持っている必要がありますが、オーナーである必要はありません。
Apps Script プロジェクトを作成するには、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 オブジェクトを作成する必要があります。
他の組み込み Apps Script サービス（CalendarApp など）を使用して、構築するアドオンカードに表示する情報を取得できます。Google 以外のサービスから取得したデータを使用できます。
OAuth を必要とする Google 以外の API に Google Workspace アドオンからアクセスする必要がある場合は、そのサービスを構成して接続する必要があります。詳しくは、Google 以外のサービスへの接続ガイドをご覧ください。
建設の指示
カードを作成する際は、チャージから構築する必要があります。つまり、次の構成順序を使用する必要があります。
- ウィジェットを作成します。
- カード セクションにウィジェットを追加します。
- カード セクションにウィジェットがすべて表示されるまで、この操作を繰り返します。
- カードにカード セクションを追加します。
これは、ウィジェットをカード セクションまたはカード セクションに追加すると、実際にはそのウィジェットのコピーを追加することになるため、注意が必要です。追加後にウィジェット オブジェクトに変更を加えても、最終的なカードには反映されません。
ユニバーサル アクション
ユニバーサル アクションを使用すると、コンテキストに依存しない機能を提供できます。ユニバーサル アクションは、表示されているカードに関係なく、アドオン UI で使用できるメニュー項目です。定義済みのユニバーサル アクションはすべて、常にアドオンのカードメニューに表示されます。
詳しくは、ユニバーサル アクションをご覧ください。
アドオンの OAuth スコープを確認する
スコープは、アドオンがユーザーに代わって実行できるアクションを定義します。アドオンが機能するうえで必要なアクションのスコープのみを設定し、それ以外のものは指定しないことをおすすめします。
アドオン プロジェクトでアドオン スコープを明示的に設定して、アドオンが可能な限り最も制限の少ないスコープセットを使用するようにします。アドオンで使用するスコープは、アドオンのマニフェストで定義します。
詳細については、スコープをご覧ください。
アドオンをテストする
非公開のアドオンをテストするには、まず非公開のアドオンをインストールします。インストールして承認されると、アカウントでアドオンを使用し、拡張されたホストアプリケーションでの外観と動作をテストできます。コンテキストとユーザー アクションに対してアドオンが期待どおりに動作することを確認する必要があります。
詳しくは、Google Workspace アドオンのテストをご覧ください。
アドオンを公開する
アドオンを公開すると、他のユーザー（一般公開またはドメイン内のユーザーのみ）にアドオンが公開されます。公開プロセスを開始する前に、パブリケーションの概要を必ずご確認ください。公開は、準備と完了にかかる時間が必要な複雑なプロセスです。
Google Workspace アドオンは Google Workspace Marketplace で公開されています。一般公開されているアドオンは、公開前にアプリの審査を完了する必要があります。
詳しくは、Google Workspace アドオンの公開をご覧ください。