Google Workspace アドオンを作成する

Google Workspace アドオンの設計、構築、公開方法について学習します。

  1. アドオンをユーザーが利用できるようにする Google Workspace アプリケーションを決定します。
  2. アドオンのプロジェクトを設定し、オーナーと共同編集者を選択します。
  3. アドオンの外観と動作を設計して構成します。
  4. アドオンをビルドします。
  5. アドオンの OAuth スコープを確認します。
  6. 1 つ以上の Google Workspace アプリケーション内でアドオンをテストします。
  7. アドオンを公開します。

Apps Script または HTTP を使用してアドオンを構築します。この 2 つを比較するには、「Apps Script と HTTP エンドポイント: どちらを選ぶべきか？」という動画をご覧ください。🤔」と入力します。

Google Workspace ホスト アプリケーションを選択する

次の Google Workspace ホスト アプリケーションに表示されるように Google Workspace アドオンを構成できます。

  • Gmail
  • Google カレンダー
  • Google Chat
  • Google ドキュメント
  • Google ドライブ
  • Google Meet
  • Google スプレッドシート
  • Google スライド

Google Workspace アプリケーション向けにビルドするには、Google Workspace UI を拡張するをご覧ください。

アドオンのプロジェクトを設定し、オーナーと共同編集者を選択する

Apps Script でアドオンを構築する場合は、Apps Script プロジェクトと Google Cloud プロジェクトの両方を作成します。Apps Script 以外の言語でアドオンをビルドする場合は、Google Cloud プロジェクトを作成するだけで済みます。

アドオンをビルドするには、スクリプト プロジェクトとクラウド プロジェクトの両方を構成する必要があります。

アドオンの開発を開始する前に、プロジェクトを所有するユーザー アカウントを 1 つ選択し、他のアカウントを共同編集者にするかどうかを決定します。プロジェクトのオーナーは、プロジェクト ファイルと関連する設定を作成して管理します。共同編集者は、コーディングとテストを支援できます。

Apps Script プロジェクト

アドオンを構築する前に、Apps Script の割り当てと制限事項を確認して、プロジェクト設計をこれらのガイドラインに沿って調整してください。Apps Script は、ユーザー数が少ない個人用または内部用のアドオンの軽量な開発に最適です。アドオンで多くのユーザーのサポート、低レイテンシ、インフラストラクチャの完全な制御が必要な場合は、別のランタイムを検討してください。

単一のアカウントが所有権を独占しないように、アドオンの Apps Script プロジェクト ファイルを共有ドライブに作成します。アドオン スクリプト ファイルを共有ドライブに配置すると、すべての共同編集者がスクリプト プロジェクトにアクセスできるようになります。

アドオンを公開すると、単一のユーザー アカウントがパブリッシャーになります。公開アカウントはスクリプト プロジェクトに対する編集権限を持っている必要がありますが、所有者である必要はありません。

Apps Script プロジェクトを作成するには、スクリプト プロジェクトをご覧ください。

Google Cloud プロジェクト

アドオンの Cloud プロジェクトに共同編集者を追加します。これにより、チームはアドオンのクラウド設定に常にアクセスできるようになります。

Google Cloud プロジェクトを作成するには、Google Cloud プロジェクトを作成するをご覧ください。

アドオンの外観と動作を設計して構成する

アドオンをビルドする前に、アドオンの外観と動作を決定します。アドオンが解決するユースケースを検討します。まず基本的な設計から始めて、その後で改良を加えます。

アドオンのユーザー エクスペリエンスを設計する際のガイドラインについては、Google Workspace アドオン スタイルガイドをご覧ください。

アドオン マニフェストを構成する

アドオン マニフェストでデザインを実装します。アドオンが拡張する Google Workspace ホスト アプリケーションなど、マニフェストでアドオンの外観と動作を構成します。

詳しくは、Google Workspace アドオンのマニフェストをご覧ください。

コードと機能を追加する際は、必要に応じてマニフェストを更新し、必要なアドオンの外観と動作を定義します。

Google Chat アプリの外観と動作を構成する

Google Chat を拡張するアドオンを設計する場合は、Google Chat API を使用して Chat 用アプリの外観と動作を構成します。手順については、Google Chat API を使用するをご覧ください。

アドオンをビルドする

アドオンのカードベースのインターフェースを実装します。カード サービスを使用するか、別のコード言語を使用する場合は、インターフェースがカードとしてレンダリングするためのフォーマットされた JSON を返します。

アドオン マニフェストで指定されたトリガー関数を実装します。アドオンが OAuth を使用してサードパーティ サービスに接続する場合は、そのサービスの OAuth を構成します。

構築カード

Card オブジェクトを作成してウィジェットを追加することで、アドオンのユーザー インターフェースを定義します。マニフェストで指定されたトリガー関数は、単一の Card オブジェクトか、アドオン インターフェースのさまざまな「ページ」を表す Card オブジェクトの配列を返す必要があります。アドオンは、ユーザーのアクションに応じて新しいカードを作成して表示することもできます。

Apps Script で、CardBuilder クラスを使用してカードを作成します。各カードには、CardHeader と 1 つ以上の CardSections が必要です。各カード セクションに、インターフェースを構成する個々のウィジェットを入力します。インタラクション ウィジェットは、通常、アクションにリンクして、インタラクションの動作を定義します。

CardBuilder を介してカードにすべてのセクションとウィジェットを追加したら、CardBuilder.build を呼び出して、対応する Card オブジェクトを作成します。

CalendarApp などの組み込み Apps Script サービス（/apps-script/guides/services/）を使用して、アドオンカードに表示する情報を取得します。Google 以外のサービスのデータを使用する。

アドオンが OAuth を必要とする Google 以外の API にアクセスする必要がある場合は、そのサービスを構成して接続します。Google 以外のサービスへの接続ガイドをご覧ください。

構築順序

カードを作成するときは、上から順に作成します。次の構築順序を使用します。

  1. ウィジェットをビルドします。
  2. ウィジェットをカード セクションに追加します。
  3. カード セクションにすべてのウィジェットが表示されるまで繰り返します。
  4. カードにカード セクションを追加します。

これは、ウィジェットをカードまたはカード セクションに追加するときに、実際にはそのウィジェットのコピーを追加するためです。ウィジェット オブジェクトを追加した後で変更を加えても、最終的なカードには反映されません。

ユニバーサル アクション

ユニバーサル アクションを使用して、コンテキストに依存しない機能を提供します。ユニバーサル アクションは、カードに関係なくアドオン UI で使用できるメニュー項目です。定義されたすべてのユニバーサル アクションがアドオンのカードメニューに表示されます。

詳しくは、ユニバーサル アクションをご覧ください。

アドオンの OAuth スコープを確認する

スコープは、アドオンがユーザーに代わって実行できるアクションを定義します。アドオンは、機能するために必要なスコープのみを持つ必要があります。

アドオン プロジェクトでは、アドオンのスコープを設定して、アドオンが可能な限り最も制限の少ないスコープのセットを使用するようにします。アドオンのマニフェストでスコープを定義します。

詳しくは、スコープをご覧ください。

アドオンをテストする

非公開のアドオンをテストするには、まず非公開のアドオンをインストールします。インストールして承認したら、アカウントでアドオンを使用して、拡張するホスト アプリケーションでの外観と動作をテストします。アドオンがコンテキストとユーザー アクションに対して想定どおりに動作することを確認します。

アドオンのテストを開始するには、次のガイドをご覧ください。

アドオンを公開する

公開すると、他のユーザーがアドオンを利用できるようになります。公開する前に、公開の概要を確認してください。公開は、準備が必要な複雑なプロセスです。

Google Workspace アドオンは Google Workspace Marketplace に公開されます。一般公開されているアドオンは、公開前にアプリの審査を受ける必要があります。

詳しくは、Google Workspace アドオンの公開をご覧ください。